/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-19 13:25:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819132514-wawrvgmfjovg9poj
* Makefile (DOCBOOKTOMAN): Added "--xinclude".

* mandos-options.xml: New file; moved mandos(8) option descriptions
                      here.

* mandos.conf.xml: Add XInclude namespace.
  (OPTIONS): New separate section with options from old "DESCRIPTION"
             section.  Changed all options to include a synopsis and
             include its paragraph from "mandos-options.xml".
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Unindented
              example text.

* mandos.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OPTIONS): Moved all descriptive paragraphs to "mandos-options.xml"
             and just <xi:include/> them from here.
  (OVERVIEW): Changed to do <xi:include/>.

* overview.xml: Added DOCTYPE; reportedly needed for XInclude to work.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
72
72
  <refsynopsisdiv>
73
73
    <cmdsynopsis>
74
74
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
 
75
      <arg>--interface<arg choice="plain">IF</arg></arg>
76
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
82
82
    </cmdsynopsis>
83
83
    <cmdsynopsis>
84
84
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
 
85
      <arg>-i<arg choice="plain">IF</arg></arg>
86
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
150
150
      </varlistentry>
151
151
 
152
152
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
154
 
        >NAME</replaceable></literal></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
155
155
        <listitem>
156
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
157
        </listitem>
274
274
        <entry>-><!-- &rarr; --></entry>
275
275
      </row>
276
276
      <row>
277
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
277
        <entry><quote><literal>1\r\en</literal></quote></entry>
278
278
        <entry>-><!-- &rarr; --></entry>
279
279
      </row>
280
280
      <row>
310
310
      longer eligible to receive the encrypted password.  The timeout,
311
311
      checker program, and interval between checks can be configured
312
312
      both globally and per client; see <citerefentry>
 
313
      <refentrytitle>mandos.conf</refentrytitle>
 
314
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
313
315
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
316
      <manvolnum>5</manvolnum></citerefentry>.
315
317
    </para>
318
320
  <refsect1 id="logging">
319
321
    <title>LOGGING</title>
320
322
    <para>
321
 
      The server will send log message with various severity levels to
322
 
      <filename>/dev/log</filename>.  With the
 
323
      The server will send log messaged with various severity levels
 
324
      to <filename>/dev/log</filename>.  With the
323
325
      <option>--debug</option> option, it will log even more messages,
324
326
      and also show them on the console.
325
327
    </para>
346
348
            <varname>PATH</varname> to search for matching commands if
347
349
            an absolute path is not given.  See <citerefentry>
348
350
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
349
 
            </citerefentry>.
 
351
          </citerefentry>
350
352
          </para>
351
353
        </listitem>
352
354
      </varlistentry>
536
538
 
537
539
  <refsect1 id="see_also">
538
540
    <title>SEE ALSO</title>
539
 
    <para>
540
 
      <citerefentry>
541
 
        <refentrytitle>mandos.conf</refentrytitle>
542
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>password-request</refentrytitle>
546
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
548
 
      </citerefentry>
549
 
    </para>
550
541
    <variablelist>
551
542
      <varlistentry>
552
543
        <term>
 
544
          <citerefentry>
 
545
            <refentrytitle>password-request</refentrytitle>
 
546
            <manvolnum>8mandos</manvolnum>
 
547
          </citerefentry>
 
548
        </term>
 
549
        <listitem>
 
550
          <para>
 
551
            This is the actual program which talks to this server.
 
552
            Note that it is normally not invoked directly, and is only
 
553
            run in the initial RAM disk environment, and not on a
 
554
            fully started system.
 
555
          </para>
 
556
        </listitem>
 
557
      </varlistentry>
 
558
      <varlistentry>
 
559
        <term>
553
560
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
554
561
        </term>
555
562
        <listitem>
572
579
      </varlistentry>
573
580
      <varlistentry>
574
581
        <term>
575
 
          <ulink url="http://www.gnu.org/software/gnutls/"
576
 
          >GnuTLS</ulink>
 
582
          <ulink
 
583
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
577
584
        </term>
578
585
      <listitem>
579
586
        <para>
585
592
      </varlistentry>
586
593
      <varlistentry>
587
594
        <term>
588
 
          RFC 4291: <citetitle>IP Version 6 Addressing
589
 
          Architecture</citetitle>
 
595
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
596
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
597
          Unicast Addresses</citation>
590
598
        </term>
591
599
        <listitem>
592
 
          <variablelist>
593
 
            <varlistentry>
594
 
              <term>Section 2.2: <citetitle>Text Representation of
595
 
              Addresses</citetitle></term>
596
 
              <listitem><para/></listitem>
597
 
            </varlistentry>
598
 
            <varlistentry>
599
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
600
 
              Address</citetitle></term>
601
 
              <listitem><para/></listitem>
602
 
            </varlistentry>
603
 
            <varlistentry>
604
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
605
 
            Addresses</citetitle></term>
606
 
            <listitem>
607
 
              <para>
608
 
                The clients use IPv6 link-local addresses, which are
609
 
                immediately usable since a link-local addresses is
610
 
                automatically assigned to a network interfaces when it
611
 
                is brought up.
612
 
              </para>
613
 
            </listitem>
614
 
            </varlistentry>
615
 
          </variablelist>
 
600
          <para>
 
601
            The clients use IPv6 link-local addresses, which are
 
602
            immediately usable since a link-local addresses is
 
603
            automatically assigned to a network interfaces when it is
 
604
            brought up.
 
605
          </para>
616
606
        </listitem>
617
607
      </varlistentry>
618
608
      <varlistentry>
619
609
        <term>
620
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
621
 
          Protocol Version 1.1</citetitle>
 
610
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
611
          (TLS) Protocol Version 1.1</citetitle></citation>
622
612
        </term>
623
613
      <listitem>
624
614
        <para>
628
618
      </varlistentry>
629
619
      <varlistentry>
630
620
        <term>
631
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
621
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
622
          Format</citetitle></citation>
632
623
        </term>
633
624
      <listitem>
634
625
        <para>
638
629
      </varlistentry>
639
630
      <varlistentry>
640
631
        <term>
641
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
642
 
          Security</citetitle>
 
632
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
633
          Transport Layer Security</citetitle></citation>
643
634
        </term>
644
635
      <listitem>
645
636
        <para>