/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

merge

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 OVERVIEW SYSTEM "overview.xml">
7
6
]>
8
7
 
9
 
<refentry>
 
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
9
  <refentryinfo>
11
10
    <title>&COMMANDNAME;</title>
12
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
73
72
  <refsynopsisdiv>
74
73
    <cmdsynopsis>
75
74
      <command>&COMMANDNAME;</command>
76
 
      <arg>--interface<arg choice="plain">IF</arg></arg>
 
75
      <arg>--interface<arg choice="plain">NAME</arg></arg>
77
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
78
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
79
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
83
82
    </cmdsynopsis>
84
83
    <cmdsynopsis>
85
84
      <command>&COMMANDNAME;</command>
86
 
      <arg>-i<arg choice="plain">IF</arg></arg>
 
85
      <arg>-i<arg choice="plain">NAME</arg></arg>
87
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
88
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
89
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
151
150
      </varlistentry>
152
151
 
153
152
      <varlistentry>
154
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
155
 
        IF</replaceable></literal></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
154
        >NAME</replaceable></literal></term>
156
155
        <listitem>
157
 
          <para>
158
 
            Only announce the server and listen to requests on network
159
 
            interface <replaceable>IF</replaceable>.  Default is to
160
 
            use all available interfaces.  <emphasis>Note:</emphasis>
161
 
            a failure to bind to the specified interface is not
162
 
            considered critical, and the server does not exit.
163
 
          </para>
 
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
164
157
        </listitem>
165
158
      </varlistentry>
166
159
 
168
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
169
162
        ADDRESS</replaceable></literal></term>
170
163
        <listitem>
171
 
          <para>
172
 
            If this option is used, the server will only listen to a
173
 
            specific address.  This must currently be an IPv6 address;
174
 
            an IPv4 address can be specified using the
175
 
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
176
 
            Also, if a link-local address is specified, an interface
177
 
            should be set, since a link-local address is only valid on
178
 
            a single interface.  By default, the server will listen to
179
 
            all available addresses.
180
 
          </para>
 
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
181
165
        </listitem>
182
166
      </varlistentry>
183
167
 
185
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
186
170
        PORT</replaceable></literal></term>
187
171
        <listitem>
188
 
          <para>
189
 
            If this option is used, the server to bind to that
190
 
            port. By default, the server will listen to an arbitrary
191
 
            port given by the operating system.
192
 
          </para>
 
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
193
173
        </listitem>
194
174
      </varlistentry>
195
175
 
206
186
      <varlistentry>
207
187
        <term><literal>--debug</literal></term>
208
188
        <listitem>
209
 
          <para>
210
 
            If the server is run in debug mode, it will run in the
211
 
            foreground and print a lot of debugging information.  The
212
 
            default is <emphasis>not</emphasis> to run in debug mode.
213
 
          </para>
 
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
214
190
        </listitem>
215
191
      </varlistentry>
216
192
 
218
194
        <term><literal>--priority <replaceable>
219
195
        PRIORITY</replaceable></literal></term>
220
196
        <listitem>
221
 
          <para>
222
 
            GnuTLS priority string for the TLS handshake with the
223
 
            clients.  The default is
224
 
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
225
 
            See <citerefentry><refentrytitle>gnutls_priority_init
226
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
227
 
            for the syntax.  <emphasis>Warning</emphasis>: changing
228
 
            this may make the TLS handshake fail, making communication
229
 
            with clients impossible.
230
 
          </para>
 
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
231
198
        </listitem>
232
199
      </varlistentry>
233
200
 
235
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
236
203
        </literal></term>
237
204
        <listitem>
238
 
          <para>
239
 
            Zeroconf service name.  The default is
240
 
            <quote><literal>Mandos</literal></quote>.  This only needs
241
 
            to be changed this if it, for some reason, is necessary to
242
 
            run more than one server on the same
243
 
            <emphasis>host</emphasis>, which would not normally be
244
 
            useful.  If there are name collisions on the same
245
 
            <emphasis>network</emphasis>, the newer server will
246
 
            automatically rename itself to <quote><literal>Mandos
247
 
            #2</literal></quote>, and so on; therefore, this option is
248
 
            not needed in that case.
249
 
          </para>
 
205
          <xi:include href="mandos-options.xml"
 
206
                      xpointer="servicename"/>
250
207
        </listitem>
251
208
      </varlistentry>
252
209
 
278
235
 
279
236
  <refsect1 id="overview">
280
237
    <title>OVERVIEW</title>
281
 
    &OVERVIEW;
 
238
    <xi:include href="overview.xml"/>
282
239
    <para>
283
240
      This program is the server part.  It is a normal server program
284
241
      and will run in a normal system environment, not in an initial
317
274
        <entry>-><!-- &rarr; --></entry>
318
275
      </row>
319
276
      <row>
320
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
277
        <entry><quote><literal>1\r\n</literal></quote></entry>
321
278
        <entry>-><!-- &rarr; --></entry>
322
279
      </row>
323
280
      <row>
353
310
      longer eligible to receive the encrypted password.  The timeout,
354
311
      checker program, and interval between checks can be configured
355
312
      both globally and per client; see <citerefentry>
356
 
      <refentrytitle>mandos.conf</refentrytitle>
357
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
358
313
      <refentrytitle>mandos-clients.conf</refentrytitle>
359
314
      <manvolnum>5</manvolnum></citerefentry>.
360
315
    </para>
363
318
  <refsect1 id="logging">
364
319
    <title>LOGGING</title>
365
320
    <para>
366
 
      The server will send log messaged with various severity levels
367
 
      to <filename>/dev/log</filename>.  With the
 
321
      The server will send log message with various severity levels to
 
322
      <filename>/dev/log</filename>.  With the
368
323
      <option>--debug</option> option, it will log even more messages,
369
324
      and also show them on the console.
370
325
    </para>
391
346
            <varname>PATH</varname> to search for matching commands if
392
347
            an absolute path is not given.  See <citerefentry>
393
348
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
394
 
          </citerefentry>
 
349
            </citerefentry>.
395
350
          </para>
396
351
        </listitem>
397
352
      </varlistentry>
581
536
 
582
537
  <refsect1 id="see_also">
583
538
    <title>SEE ALSO</title>
 
539
    <para>
 
540
      <citerefentry>
 
541
        <refentrytitle>mandos.conf</refentrytitle>
 
542
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
545
        <refentrytitle>password-request</refentrytitle>
 
546
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
547
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
548
      </citerefentry>
 
549
    </para>
584
550
    <variablelist>
585
551
      <varlistentry>
586
552
        <term>
587
 
          <citerefentry>
588
 
            <refentrytitle>password-request</refentrytitle>
589
 
            <manvolnum>8mandos</manvolnum>
590
 
          </citerefentry>
591
 
        </term>
592
 
        <listitem>
593
 
          <para>
594
 
            This is the actual program which talks to this server.
595
 
            Note that it is normally not invoked directly, and is only
596
 
            run in the initial RAM disk environment, and not on a
597
 
            fully started system.
598
 
          </para>
599
 
        </listitem>
600
 
      </varlistentry>
601
 
      <varlistentry>
602
 
        <term>
603
553
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
604
554
        </term>
605
555
        <listitem>