/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-29 16:53:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829165341-xzrp0xxxfrua5kzq
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
                         "--interface" options.

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">
6
7
]>
7
8
 
8
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
10
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
    <title>Mandos Manual</title>
11
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
 
13
    <productname>Mandos</productname>
13
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
14
16
    <authorgroup>
15
17
      <author>
16
18
        <firstname>Björn</firstname>
72
74
  <refsynopsisdiv>
73
75
    <cmdsynopsis>
74
76
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">IF</arg></arg>
 
77
      <arg>--interface<arg choice="plain">NAME</arg></arg>
76
78
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
79
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
80
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
82
84
    </cmdsynopsis>
83
85
    <cmdsynopsis>
84
86
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">IF</arg></arg>
 
87
      <arg>-i<arg choice="plain">NAME</arg></arg>
86
88
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
89
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
90
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
141
143
 
142
144
    <variablelist>
143
145
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
146
        <term><option>-h</option></term>
 
147
        <term><option>--help</option></term>
145
148
        <listitem>
146
149
          <para>
147
150
            Show a help message and exit
150
153
      </varlistentry>
151
154
 
152
155
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
 
        IF</replaceable></literal></term>
 
156
        <term><option>-i</option>
 
157
        <replaceable>NAME</replaceable></term>
 
158
        <term><option>--interface</option>
 
159
        <replaceable>NAME</replaceable></term>
155
160
        <listitem>
156
161
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
162
        </listitem>
274
279
        <entry>-><!-- &rarr; --></entry>
275
280
      </row>
276
281
      <row>
277
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
282
        <entry><quote><literal>1\r\n</literal></quote></entry>
278
283
        <entry>-><!-- &rarr; --></entry>
279
284
      </row>
280
285
      <row>
310
315
      longer eligible to receive the encrypted password.  The timeout,
311
316
      checker program, and interval between checks can be configured
312
317
      both globally and per client; see <citerefentry>
313
 
      <refentrytitle>mandos.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
315
318
      <refentrytitle>mandos-clients.conf</refentrytitle>
316
319
      <manvolnum>5</manvolnum></citerefentry>.
317
320
    </para>
320
323
  <refsect1 id="logging">
321
324
    <title>LOGGING</title>
322
325
    <para>
323
 
      The server will send log messaged with various severity levels
324
 
      to <filename>/dev/log</filename>.  With the
 
326
      The server will send log message with various severity levels to
 
327
      <filename>/dev/log</filename>.  With the
325
328
      <option>--debug</option> option, it will log even more messages,
326
329
      and also show them on the console.
327
330
    </para>
348
351
            <varname>PATH</varname> to search for matching commands if
349
352
            an absolute path is not given.  See <citerefentry>
350
353
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
351
 
          </citerefentry>
 
354
            </citerefentry>.
352
355
          </para>
353
356
        </listitem>
354
357
      </varlistentry>
450
453
        Normal invocation needs no options:
451
454
      </para>
452
455
      <para>
453
 
        <userinput>mandos</userinput>
 
456
        <userinput>&COMMANDNAME;</userinput>
454
457
      </para>
455
458
    </informalexample>
456
459
    <informalexample>
463
466
      <para>
464
467
 
465
468
<!-- do not wrap this line -->
466
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
469
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
467
470
 
468
471
      </para>
469
472
    </informalexample>
475
478
      <para>
476
479
 
477
480
<!-- do not wrap this line -->
478
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
481
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
479
482
 
480
483
      </para>
481
484
    </informalexample>
538
541
 
539
542
  <refsect1 id="see_also">
540
543
    <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>
541
555
    <variablelist>
542
556
      <varlistentry>
543
557
        <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>
560
558
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
561
559
        </term>
562
560
        <listitem>
579
577
      </varlistentry>
580
578
      <varlistentry>
581
579
        <term>
582
 
          <ulink
583
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
580
          <ulink url="http://www.gnu.org/software/gnutls/"
 
581
          >GnuTLS</ulink>
584
582
        </term>
585
583
      <listitem>
586
584
        <para>
592
590
      </varlistentry>
593
591
      <varlistentry>
594
592
        <term>
595
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
596
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
597
 
          Unicast Addresses</citation>
 
593
          RFC 4291: <citetitle>IP Version 6 Addressing
 
594
          Architecture</citetitle>
598
595
        </term>
599
596
        <listitem>
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>
 
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>
606
621
        </listitem>
607
622
      </varlistentry>
608
623
      <varlistentry>
609
624
        <term>
610
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
611
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
625
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
626
          Protocol Version 1.1</citetitle>
612
627
        </term>
613
628
      <listitem>
614
629
        <para>
618
633
      </varlistentry>
619
634
      <varlistentry>
620
635
        <term>
621
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
622
 
          Format</citetitle></citation>
 
636
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
623
637
        </term>
624
638
      <listitem>
625
639
        <para>
629
643
      </varlistentry>
630
644
      <varlistentry>
631
645
        <term>
632
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
633
 
          Transport Layer Security</citetitle></citation>
 
646
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
647
          Security</citetitle>
634
648
        </term>
635
649
      <listitem>
636
650
        <para>
642
656
    </variablelist>
643
657
  </refsect1>
644
658
</refentry>
 
659
<!-- Local Variables: -->
 
660
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
661
<!-- time-stamp-end: "[\"']>" -->
 
662
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
663
<!-- End: -->