/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-30 19:05:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830190515-l7e6vu81yyw5kcku
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags.  Unify
                         short and long 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-30">
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>
65
67
  <refnamediv>
66
68
    <refname><command>&COMMANDNAME;</command></refname>
67
69
    <refpurpose>
68
 
      Sends encrypted passwords to authenticated Mandos clients
 
70
      Gives encrypted passwords to authenticated Mandos clients
69
71
    </refpurpose>
70
72
  </refnamediv>
71
73
 
72
74
  <refsynopsisdiv>
73
75
    <cmdsynopsis>
74
76
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">IF</arg></arg>
76
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
80
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
81
 
      <arg>--debug</arg>
82
 
    </cmdsynopsis>
83
 
    <cmdsynopsis>
84
 
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">IF</arg></arg>
86
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
90
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
91
 
      <arg>--debug</arg>
 
77
      <group>
 
78
        <arg choice="plain"><option>--interface
 
79
        <replaceable>NAME</replaceable></option></arg>
 
80
        <arg choice="plain"><option>-i
 
81
        <replaceable>NAME</replaceable></option></arg>
 
82
      </group>
 
83
      <sbr/>
 
84
      <group>
 
85
        <arg choice="plain"><option>--address
 
86
        <replaceable>ADDRESS</replaceable></option></arg>
 
87
        <arg choice="plain"><option>-a
 
88
        <replaceable>ADDRESS</replaceable></option></arg>
 
89
      </group>
 
90
      <sbr/>
 
91
      <group>
 
92
        <arg choice="plain"><option>--port
 
93
        <replaceable>PORT</replaceable></option></arg>
 
94
        <arg choice="plain"><option>-p
 
95
        <replaceable>PORT</replaceable></option></arg>
 
96
      </group>
 
97
      <sbr/>
 
98
      <arg><option>--priority
 
99
      <replaceable>PRIORITY</replaceable></option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--servicename
 
102
      <replaceable>NAME</replaceable></option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--configdir
 
105
      <replaceable>DIRECTORY</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--debug</option></arg>
92
108
    </cmdsynopsis>
93
109
    <cmdsynopsis>
94
110
      <command>&COMMANDNAME;</command>
95
111
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
 
112
        <arg choice="plain"><option>-h</option></arg>
 
113
        <arg choice="plain"><option>--help</option></arg>
98
114
      </group>
99
115
    </cmdsynopsis>
100
116
    <cmdsynopsis>
101
117
      <command>&COMMANDNAME;</command>
102
 
      <arg choice="plain">--version</arg>
 
118
      <arg choice="plain"><option>--version</option></arg>
103
119
    </cmdsynopsis>
104
120
    <cmdsynopsis>
105
121
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain">--check</arg>
 
122
      <arg choice="plain"><option>--check</option></arg>
107
123
    </cmdsynopsis>
108
124
  </refsynopsisdiv>
109
125
 
141
157
 
142
158
    <variablelist>
143
159
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
160
        <term><option>-h</option></term>
 
161
        <term><option>--help</option></term>
145
162
        <listitem>
146
163
          <para>
147
164
            Show a help message and exit
150
167
      </varlistentry>
151
168
 
152
169
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
 
        IF</replaceable></literal></term>
 
170
        <term><option>-i</option>
 
171
        <replaceable>NAME</replaceable></term>
 
172
        <term><option>--interface</option>
 
173
        <replaceable>NAME</replaceable></term>
155
174
        <listitem>
156
175
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
176
        </listitem>
274
293
        <entry>-><!-- &rarr; --></entry>
275
294
      </row>
276
295
      <row>
277
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
296
        <entry><quote><literal>1\r\n</literal></quote></entry>
278
297
        <entry>-><!-- &rarr; --></entry>
279
298
      </row>
280
299
      <row>
310
329
      longer eligible to receive the encrypted password.  The timeout,
311
330
      checker program, and interval between checks can be configured
312
331
      both globally and per client; see <citerefentry>
313
 
      <refentrytitle>mandos.conf</refentrytitle>
314
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
315
332
      <refentrytitle>mandos-clients.conf</refentrytitle>
316
333
      <manvolnum>5</manvolnum></citerefentry>.
317
334
    </para>
320
337
  <refsect1 id="logging">
321
338
    <title>LOGGING</title>
322
339
    <para>
323
 
      The server will send log messaged with various severity levels
324
 
      to <filename>/dev/log</filename>.  With the
 
340
      The server will send log message with various severity levels to
 
341
      <filename>/dev/log</filename>.  With the
325
342
      <option>--debug</option> option, it will log even more messages,
326
343
      and also show them on the console.
327
344
    </para>
339
356
    <title>ENVIRONMENT</title>
340
357
    <variablelist>
341
358
      <varlistentry>
342
 
        <term><varname>PATH</varname></term>
 
359
        <term><envar>PATH</envar></term>
343
360
        <listitem>
344
361
          <para>
345
362
            To start the configured checker (see <xref
348
365
            <varname>PATH</varname> to search for matching commands if
349
366
            an absolute path is not given.  See <citerefentry>
350
367
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
351
 
          </citerefentry>
 
368
            </citerefentry>.
352
369
          </para>
353
370
        </listitem>
354
371
      </varlistentry>
450
467
        Normal invocation needs no options:
451
468
      </para>
452
469
      <para>
453
 
        <userinput>mandos</userinput>
 
470
        <userinput>&COMMANDNAME;</userinput>
454
471
      </para>
455
472
    </informalexample>
456
473
    <informalexample>
463
480
      <para>
464
481
 
465
482
<!-- do not wrap this line -->
466
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
483
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
467
484
 
468
485
      </para>
469
486
    </informalexample>
475
492
      <para>
476
493
 
477
494
<!-- do not wrap this line -->
478
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
495
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
479
496
 
480
497
      </para>
481
498
    </informalexample>
538
555
 
539
556
  <refsect1 id="see_also">
540
557
    <title>SEE ALSO</title>
 
558
    <para>
 
559
      <citerefentry>
 
560
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
561
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
562
        <refentrytitle>mandos.conf</refentrytitle>
 
563
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
564
        <refentrytitle>password-request</refentrytitle>
 
565
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
566
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
567
      </citerefentry>
 
568
    </para>
541
569
    <variablelist>
542
570
      <varlistentry>
543
571
        <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
572
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
561
573
        </term>
562
574
        <listitem>
579
591
      </varlistentry>
580
592
      <varlistentry>
581
593
        <term>
582
 
          <ulink
583
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
594
          <ulink url="http://www.gnu.org/software/gnutls/"
 
595
          >GnuTLS</ulink>
584
596
        </term>
585
597
      <listitem>
586
598
        <para>
592
604
      </varlistentry>
593
605
      <varlistentry>
594
606
        <term>
595
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
596
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
597
 
          Unicast Addresses</citation>
 
607
          RFC 4291: <citetitle>IP Version 6 Addressing
 
608
          Architecture</citetitle>
598
609
        </term>
599
610
        <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>
 
611
          <variablelist>
 
612
            <varlistentry>
 
613
              <term>Section 2.2: <citetitle>Text Representation of
 
614
              Addresses</citetitle></term>
 
615
              <listitem><para/></listitem>
 
616
            </varlistentry>
 
617
            <varlistentry>
 
618
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
619
              Address</citetitle></term>
 
620
              <listitem><para/></listitem>
 
621
            </varlistentry>
 
622
            <varlistentry>
 
623
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
624
            Addresses</citetitle></term>
 
625
            <listitem>
 
626
              <para>
 
627
                The clients use IPv6 link-local addresses, which are
 
628
                immediately usable since a link-local addresses is
 
629
                automatically assigned to a network interfaces when it
 
630
                is brought up.
 
631
              </para>
 
632
            </listitem>
 
633
            </varlistentry>
 
634
          </variablelist>
606
635
        </listitem>
607
636
      </varlistentry>
608
637
      <varlistentry>
609
638
        <term>
610
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
611
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
639
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
640
          Protocol Version 1.1</citetitle>
612
641
        </term>
613
642
      <listitem>
614
643
        <para>
618
647
      </varlistentry>
619
648
      <varlistentry>
620
649
        <term>
621
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
622
 
          Format</citetitle></citation>
 
650
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
623
651
        </term>
624
652
      <listitem>
625
653
        <para>
629
657
      </varlistentry>
630
658
      <varlistentry>
631
659
        <term>
632
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
633
 
          Transport Layer Security</citetitle></citation>
 
660
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
661
          Security</citetitle>
634
662
        </term>
635
663
      <listitem>
636
664
        <para>
642
670
    </variablelist>
643
671
  </refsect1>
644
672
</refentry>
 
673
<!-- Local Variables: -->
 
674
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
675
<!-- time-stamp-end: "[\"']>" -->
 
676
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
677
<!-- End: -->