/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-31 10:44:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831104432-9hzi47foc7tlmade
* plugins.d/password-prompt.xml (OPTIONS): Move <replaceable> tags to
                                           inside <option> tags.
                                           Moved long options before
                                           short.

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-31">
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>--help</option></arg>
 
113
        <arg choice="plain"><option>-h</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
 
133
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
134
150
      linkend="overview"/> for details.
135
151
    </para>
136
 
 
 
152
    
137
153
  </refsect1>
138
154
  
139
155
  <refsect1 id="options">
140
156
    <title>OPTIONS</title>
141
 
 
 
157
    
142
158
    <variablelist>
143
159
      <varlistentry>
144
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
160
        <term><option>--help</option></term>
 
161
        <term><option>-h</option></term>
145
162
        <listitem>
146
163
          <para>
147
164
            Show a help message and exit
148
165
          </para>
149
166
        </listitem>
150
167
      </varlistentry>
151
 
 
 
168
      
152
169
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
 
        IF</replaceable></literal></term>
 
170
        <term><option>--interface</option>
 
171
        <replaceable>NAME</replaceable></term>
 
172
        <term><option>-i</option>
 
173
        <replaceable>NAME</replaceable></term>
155
174
        <listitem>
156
175
          <xi:include href="mandos-options.xml" xpointer="interface"/>
157
176
        </listitem>
158
177
      </varlistentry>
159
 
 
 
178
      
160
179
      <varlistentry>
161
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
 
        ADDRESS</replaceable></literal></term>
 
180
        <term><option>--address
 
181
        <replaceable>ADDRESS</replaceable></option></term>
 
182
        <term><option>-a
 
183
        <replaceable>ADDRESS</replaceable></option></term>
163
184
        <listitem>
164
185
          <xi:include href="mandos-options.xml" xpointer="address"/>
165
186
        </listitem>
166
187
      </varlistentry>
167
 
 
 
188
      
168
189
      <varlistentry>
169
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
 
        PORT</replaceable></literal></term>
 
190
        <term><option>--port
 
191
        <replaceable>PORT</replaceable></option></term>
 
192
        <term><option>-p
 
193
        <replaceable>PORT</replaceable></option></term>
171
194
        <listitem>
172
195
          <xi:include href="mandos-options.xml" xpointer="port"/>
173
196
        </listitem>
174
197
      </varlistentry>
175
 
 
 
198
      
176
199
      <varlistentry>
177
 
        <term><literal>--check</literal></term>
 
200
        <term><option>--check</option></term>
178
201
        <listitem>
179
202
          <para>
180
203
            Run the server’s self-tests.  This includes any unit
182
205
          </para>
183
206
        </listitem>
184
207
      </varlistentry>
185
 
 
 
208
      
186
209
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
210
        <term><option>--debug</option></term>
188
211
        <listitem>
189
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
190
213
        </listitem>
191
214
      </varlistentry>
192
215
 
193
216
      <varlistentry>
194
 
        <term><literal>--priority <replaceable>
195
 
        PRIORITY</replaceable></literal></term>
 
217
        <term><option>--priority <replaceable>
 
218
        PRIORITY</replaceable></option></term>
196
219
        <listitem>
197
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
198
221
        </listitem>
199
222
      </varlistentry>
200
223
 
201
224
      <varlistentry>
202
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
 
        </literal></term>
 
225
        <term><option>--servicename
 
226
        <replaceable>NAME</replaceable></option></term>
204
227
        <listitem>
205
228
          <xi:include href="mandos-options.xml"
206
229
                      xpointer="servicename"/>
208
231
      </varlistentry>
209
232
 
210
233
      <varlistentry>
211
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
212
 
        </literal></term>
 
234
        <term><option>--configdir
 
235
        <replaceable>DIRECTORY</replaceable></option></term>
213
236
        <listitem>
214
237
          <para>
215
238
            Directory to search for configuration files.  Default is
223
246
      </varlistentry>
224
247
 
225
248
      <varlistentry>
226
 
        <term><literal>--version</literal></term>
 
249
        <term><option>--version</option></term>
227
250
        <listitem>
228
251
          <para>
229
252
            Prints the program version and exit.
337
360
    <title>ENVIRONMENT</title>
338
361
    <variablelist>
339
362
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
 
363
        <term><envar>PATH</envar></term>
341
364
        <listitem>
342
365
          <para>
343
366
            To start the configured checker (see <xref
448
471
        Normal invocation needs no options:
449
472
      </para>
450
473
      <para>
451
 
        <userinput>mandos</userinput>
 
474
        <userinput>&COMMANDNAME;</userinput>
452
475
      </para>
453
476
    </informalexample>
454
477
    <informalexample>
461
484
      <para>
462
485
 
463
486
<!-- do not wrap this line -->
464
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
487
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
465
488
 
466
489
      </para>
467
490
    </informalexample>
473
496
      <para>
474
497
 
475
498
<!-- do not wrap this line -->
476
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
499
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
500
 
478
501
      </para>
479
502
    </informalexample>
538
561
    <title>SEE ALSO</title>
539
562
    <para>
540
563
      <citerefentry>
 
564
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
565
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
541
566
        <refentrytitle>mandos.conf</refentrytitle>
542
567
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
568
        <refentrytitle>password-request</refentrytitle>
546
569
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
570
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
572
595
      </varlistentry>
573
596
      <varlistentry>
574
597
        <term>
575
 
          <ulink
576
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
598
          <ulink url="http://www.gnu.org/software/gnutls/"
 
599
          >GnuTLS</ulink>
577
600
        </term>
578
601
      <listitem>
579
602
        <para>
585
608
      </varlistentry>
586
609
      <varlistentry>
587
610
        <term>
588
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
589
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
590
 
          Unicast Addresses</citation>
 
611
          RFC 4291: <citetitle>IP Version 6 Addressing
 
612
          Architecture</citetitle>
591
613
        </term>
592
614
        <listitem>
593
 
          <para>
594
 
            The clients use IPv6 link-local addresses, which are
595
 
            immediately usable since a link-local addresses is
596
 
            automatically assigned to a network interfaces when it is
597
 
            brought up.
598
 
          </para>
 
615
          <variablelist>
 
616
            <varlistentry>
 
617
              <term>Section 2.2: <citetitle>Text Representation of
 
618
              Addresses</citetitle></term>
 
619
              <listitem><para/></listitem>
 
620
            </varlistentry>
 
621
            <varlistentry>
 
622
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
623
              Address</citetitle></term>
 
624
              <listitem><para/></listitem>
 
625
            </varlistentry>
 
626
            <varlistentry>
 
627
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
628
            Addresses</citetitle></term>
 
629
            <listitem>
 
630
              <para>
 
631
                The clients use IPv6 link-local addresses, which are
 
632
                immediately usable since a link-local addresses is
 
633
                automatically assigned to a network interfaces when it
 
634
                is brought up.
 
635
              </para>
 
636
            </listitem>
 
637
            </varlistentry>
 
638
          </variablelist>
599
639
        </listitem>
600
640
      </varlistentry>
601
641
      <varlistentry>
602
642
        <term>
603
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
604
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
643
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
644
          Protocol Version 1.1</citetitle>
605
645
        </term>
606
646
      <listitem>
607
647
        <para>
611
651
      </varlistentry>
612
652
      <varlistentry>
613
653
        <term>
614
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
615
 
          Format</citetitle></citation>
 
654
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
616
655
        </term>
617
656
      <listitem>
618
657
        <para>
622
661
      </varlistentry>
623
662
      <varlistentry>
624
663
        <term>
625
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
626
 
          Transport Layer Security</citetitle></citation>
 
664
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
665
          Security</citetitle>
627
666
        </term>
628
667
      <listitem>
629
668
        <para>
635
674
    </variablelist>
636
675
  </refsect1>
637
676
</refentry>
 
677
<!-- Local Variables: -->
 
678
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
679
<!-- time-stamp-end: "[\"']>" -->
 
680
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
681
<!-- End: -->