/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
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>
143
141
 
144
142
    <variablelist>
145
143
      <varlistentry>
146
 
        <term><option>-h</option></term>
147
 
        <term><option>--help</option></term>
 
144
        <term><literal>-h</literal>, <literal>--help</literal></term>
148
145
        <listitem>
149
146
          <para>
150
147
            Show a help message and exit
153
150
      </varlistentry>
154
151
 
155
152
      <varlistentry>
156
 
        <term><option>-i</option>
157
 
        <replaceable>NAME</replaceable></term>
158
 
        <term><option>--interface</option>
159
 
        <replaceable>NAME</replaceable></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
154
        IF</replaceable></literal></term>
160
155
        <listitem>
161
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
162
157
        </listitem>
279
274
        <entry>-><!-- &rarr; --></entry>
280
275
      </row>
281
276
      <row>
282
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
277
        <entry><quote><literal>1\r\en</literal></quote></entry>
283
278
        <entry>-><!-- &rarr; --></entry>
284
279
      </row>
285
280
      <row>
315
310
      longer eligible to receive the encrypted password.  The timeout,
316
311
      checker program, and interval between checks can be configured
317
312
      both globally and per client; see <citerefentry>
 
313
      <refentrytitle>mandos.conf</refentrytitle>
 
314
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
318
315
      <refentrytitle>mandos-clients.conf</refentrytitle>
319
316
      <manvolnum>5</manvolnum></citerefentry>.
320
317
    </para>
323
320
  <refsect1 id="logging">
324
321
    <title>LOGGING</title>
325
322
    <para>
326
 
      The server will send log message with various severity levels to
327
 
      <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
328
325
      <option>--debug</option> option, it will log even more messages,
329
326
      and also show them on the console.
330
327
    </para>
351
348
            <varname>PATH</varname> to search for matching commands if
352
349
            an absolute path is not given.  See <citerefentry>
353
350
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
354
 
            </citerefentry>.
 
351
          </citerefentry>
355
352
          </para>
356
353
        </listitem>
357
354
      </varlistentry>
453
450
        Normal invocation needs no options:
454
451
      </para>
455
452
      <para>
456
 
        <userinput>&COMMANDNAME;</userinput>
 
453
        <userinput>mandos</userinput>
457
454
      </para>
458
455
    </informalexample>
459
456
    <informalexample>
466
463
      <para>
467
464
 
468
465
<!-- do not wrap this line -->
469
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
466
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
470
467
 
471
468
      </para>
472
469
    </informalexample>
478
475
      <para>
479
476
 
480
477
<!-- do not wrap this line -->
481
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
478
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
482
479
 
483
480
      </para>
484
481
    </informalexample>
541
538
 
542
539
  <refsect1 id="see_also">
543
540
    <title>SEE ALSO</title>
544
 
    <para>
545
 
      <citerefentry>
546
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
547
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
 
        <refentrytitle>mandos.conf</refentrytitle>
549
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
550
 
        <refentrytitle>password-request</refentrytitle>
551
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
552
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
553
 
      </citerefentry>
554
 
    </para>
555
541
    <variablelist>
556
542
      <varlistentry>
557
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>
558
560
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
559
561
        </term>
560
562
        <listitem>
577
579
      </varlistentry>
578
580
      <varlistentry>
579
581
        <term>
580
 
          <ulink url="http://www.gnu.org/software/gnutls/"
581
 
          >GnuTLS</ulink>
 
582
          <ulink
 
583
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
582
584
        </term>
583
585
      <listitem>
584
586
        <para>
590
592
      </varlistentry>
591
593
      <varlistentry>
592
594
        <term>
593
 
          RFC 4291: <citetitle>IP Version 6 Addressing
594
 
          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>
595
598
        </term>
596
599
        <listitem>
597
 
          <variablelist>
598
 
            <varlistentry>
599
 
              <term>Section 2.2: <citetitle>Text Representation of
600
 
              Addresses</citetitle></term>
601
 
              <listitem><para/></listitem>
602
 
            </varlistentry>
603
 
            <varlistentry>
604
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
605
 
              Address</citetitle></term>
606
 
              <listitem><para/></listitem>
607
 
            </varlistentry>
608
 
            <varlistentry>
609
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
610
 
            Addresses</citetitle></term>
611
 
            <listitem>
612
 
              <para>
613
 
                The clients use IPv6 link-local addresses, which are
614
 
                immediately usable since a link-local addresses is
615
 
                automatically assigned to a network interfaces when it
616
 
                is brought up.
617
 
              </para>
618
 
            </listitem>
619
 
            </varlistentry>
620
 
          </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>
621
606
        </listitem>
622
607
      </varlistentry>
623
608
      <varlistentry>
624
609
        <term>
625
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
626
 
          Protocol Version 1.1</citetitle>
 
610
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
611
          (TLS) Protocol Version 1.1</citetitle></citation>
627
612
        </term>
628
613
      <listitem>
629
614
        <para>
633
618
      </varlistentry>
634
619
      <varlistentry>
635
620
        <term>
636
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
621
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
622
          Format</citetitle></citation>
637
623
        </term>
638
624
      <listitem>
639
625
        <para>
643
629
      </varlistentry>
644
630
      <varlistentry>
645
631
        <term>
646
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
647
 
          Security</citetitle>
 
632
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
633
          Transport Layer Security</citetitle></citation>
648
634
        </term>
649
635
      <listitem>
650
636
        <para>
656
642
    </variablelist>
657
643
  </refsect1>
658
644
</refentry>
659
 
<!-- Local Variables: -->
660
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
661
 
<!-- time-stamp-end: "[\"']>" -->
662
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
663
 
<!-- End: -->