/mandos/release

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

« 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
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-08-29">
7
6
]>
8
7
 
9
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
9
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
 
10
    <title>&COMMANDNAME;</title>
12
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
 
12
    <productname>&COMMANDNAME;</productname>
14
13
    <productnumber>&VERSION;</productnumber>
15
 
    <date>&TIMESTAMP;</date>
16
14
    <authorgroup>
17
15
      <author>
18
16
        <firstname>Björn</firstname>
74
72
  <refsynopsisdiv>
75
73
    <cmdsynopsis>
76
74
      <command>&COMMANDNAME;</command>
77
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
 
75
      <arg>--interface<arg choice="plain">IF</arg></arg>
78
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
79
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
80
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
84
82
    </cmdsynopsis>
85
83
    <cmdsynopsis>
86
84
      <command>&COMMANDNAME;</command>
87
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
 
85
      <arg>-i<arg choice="plain">IF</arg></arg>
88
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
89
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
90
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
152
150
      </varlistentry>
153
151
 
154
152
      <varlistentry>
155
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
156
 
        >NAME</replaceable></literal></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
157
155
        <listitem>
158
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
159
157
        </listitem>
276
274
        <entry>-><!-- &rarr; --></entry>
277
275
      </row>
278
276
      <row>
279
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
277
        <entry><quote><literal>1\r\en</literal></quote></entry>
280
278
        <entry>-><!-- &rarr; --></entry>
281
279
      </row>
282
280
      <row>
312
310
      longer eligible to receive the encrypted password.  The timeout,
313
311
      checker program, and interval between checks can be configured
314
312
      both globally and per client; see <citerefentry>
 
313
      <refentrytitle>mandos.conf</refentrytitle>
 
314
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
315
315
      <refentrytitle>mandos-clients.conf</refentrytitle>
316
316
      <manvolnum>5</manvolnum></citerefentry>.
317
317
    </para>
320
320
  <refsect1 id="logging">
321
321
    <title>LOGGING</title>
322
322
    <para>
323
 
      The server will send log message with various severity levels to
324
 
      <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
325
325
      <option>--debug</option> option, it will log even more messages,
326
326
      and also show them on the console.
327
327
    </para>
348
348
            <varname>PATH</varname> to search for matching commands if
349
349
            an absolute path is not given.  See <citerefentry>
350
350
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
351
 
            </citerefentry>.
 
351
          </citerefentry>
352
352
          </para>
353
353
        </listitem>
354
354
      </varlistentry>
450
450
        Normal invocation needs no options:
451
451
      </para>
452
452
      <para>
453
 
        <userinput>&COMMANDNAME;</userinput>
 
453
        <userinput>mandos</userinput>
454
454
      </para>
455
455
    </informalexample>
456
456
    <informalexample>
463
463
      <para>
464
464
 
465
465
<!-- do not wrap this line -->
466
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
466
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
467
467
 
468
468
      </para>
469
469
    </informalexample>
475
475
      <para>
476
476
 
477
477
<!-- do not wrap this line -->
478
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
478
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
479
479
 
480
480
      </para>
481
481
    </informalexample>
538
538
 
539
539
  <refsect1 id="see_also">
540
540
    <title>SEE ALSO</title>
541
 
    <para>
542
 
      <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>mandos.conf</refentrytitle>
546
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>password-request</refentrytitle>
548
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
550
 
      </citerefentry>
551
 
    </para>
552
541
    <variablelist>
553
542
      <varlistentry>
554
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>
555
560
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
556
561
        </term>
557
562
        <listitem>
574
579
      </varlistentry>
575
580
      <varlistentry>
576
581
        <term>
577
 
          <ulink url="http://www.gnu.org/software/gnutls/"
578
 
          >GnuTLS</ulink>
 
582
          <ulink
 
583
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
579
584
        </term>
580
585
      <listitem>
581
586
        <para>
587
592
      </varlistentry>
588
593
      <varlistentry>
589
594
        <term>
590
 
          RFC 4291: <citetitle>IP Version 6 Addressing
591
 
          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>
592
598
        </term>
593
599
        <listitem>
594
 
          <variablelist>
595
 
            <varlistentry>
596
 
              <term>Section 2.2: <citetitle>Text Representation of
597
 
              Addresses</citetitle></term>
598
 
              <listitem><para/></listitem>
599
 
            </varlistentry>
600
 
            <varlistentry>
601
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
602
 
              Address</citetitle></term>
603
 
              <listitem><para/></listitem>
604
 
            </varlistentry>
605
 
            <varlistentry>
606
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
607
 
            Addresses</citetitle></term>
608
 
            <listitem>
609
 
              <para>
610
 
                The clients use IPv6 link-local addresses, which are
611
 
                immediately usable since a link-local addresses is
612
 
                automatically assigned to a network interfaces when it
613
 
                is brought up.
614
 
              </para>
615
 
            </listitem>
616
 
            </varlistentry>
617
 
          </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>
618
606
        </listitem>
619
607
      </varlistentry>
620
608
      <varlistentry>
621
609
        <term>
622
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
623
 
          Protocol Version 1.1</citetitle>
 
610
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
611
          (TLS) Protocol Version 1.1</citetitle></citation>
624
612
        </term>
625
613
      <listitem>
626
614
        <para>
630
618
      </varlistentry>
631
619
      <varlistentry>
632
620
        <term>
633
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
621
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
622
          Format</citetitle></citation>
634
623
        </term>
635
624
      <listitem>
636
625
        <para>
640
629
      </varlistentry>
641
630
      <varlistentry>
642
631
        <term>
643
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
644
 
          Security</citetitle>
 
632
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
633
          Transport Layer Security</citetitle></citation>
645
634
        </term>
646
635
      <listitem>
647
636
        <para>
653
642
    </variablelist>
654
643
  </refsect1>
655
644
</refentry>
656
 
<!-- Local Variables: -->
657
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
658
 
<!-- time-stamp-end: "[\"']>" -->
659
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
660
 
<!-- End: -->