/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-clients.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-25 07:52:35 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825075235-gq338t4ywhqhire8
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
                                         only configuration file of
                                         mandos(8).
  (OPTIONS): Note that unknown options are ignored.  When describing
             "checker", be more specific about exit codes, and refer
             to PATH.  When describing "secret", refer to
             mandos-keygen(8), and note the relationship with
             "secfile".  Added synopsis to "secfile", and note
             relationship with "secret".  Added synopsis and more text
             to "host".
  (EXAMPLE): Remove Radix-64 checksum from "secret" option value.
  (SEE ALSO): New section, refer to mandos(8), mandos-keygen(8), and
              mandos.conf(5).

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY CONFNAME "mandos-clients.conf">
6
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-08-31">
8
7
]>
9
8
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
11
10
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
 
11
    <title>&CONFNAME;</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
 
13
    <productname>&CONFNAME;</productname>
15
14
    <productnumber>&VERSION;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
17
15
    <authorgroup>
18
16
      <author>
19
17
        <firstname>Björn</firstname>
35
33
      <holder>Teddy Hogeborn</holder>
36
34
      <holder>Björn Påhlsson</holder>
37
35
    </copyright>
38
 
    <xi:include href="legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
39
59
  </refentryinfo>
40
60
 
41
61
  <refmeta>
51
71
  </refnamediv>
52
72
 
53
73
  <refsynopsisdiv>
54
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
55
77
  </refsynopsisdiv>
56
78
 
57
79
  <refsect1 id="description">
99
121
    <variablelist>
100
122
 
101
123
      <varlistentry>
102
 
        <term><option>timeout<literal> = </literal><replaceable
103
 
        >TIME</replaceable></option></term>
 
124
        <term><literal><varname>timeout</varname></literal></term>
104
125
        <listitem>
 
126
          <synopsis><literal>timeout = </literal><replaceable
 
127
          >TIME</replaceable>
 
128
          </synopsis>
105
129
          <para>
106
130
            The timeout is how long the server will wait for a
107
131
            successful checker run until a client is considered
125
149
      </varlistentry>
126
150
 
127
151
      <varlistentry>
128
 
        <term><option>interval<literal> = </literal><replaceable
129
 
        >TIME</replaceable></option></term>
 
152
        <term><literal><varname>interval</varname></literal></term>
130
153
        <listitem>
 
154
          <synopsis><literal>interval = </literal><replaceable
 
155
          >TIME</replaceable>
 
156
          </synopsis>
131
157
          <para>
132
158
            How often to run the checker to confirm that a client is
133
159
            still up.  <emphasis>Note:</emphasis> a new checker will
142
168
            as for <varname>timeout</varname> above.
143
169
          </para>
144
170
        </listitem>
145
 
      </varlistentry>
 
171
      </varlistentry>      
146
172
 
147
173
      <varlistentry>
148
 
        <term><option>checker<literal> = </literal><replaceable
149
 
        >COMMAND</replaceable></option></term>
 
174
        <term><literal>checker</literal></term>
150
175
        <listitem>
 
176
          <synopsis><literal>checker = </literal><replaceable
 
177
          >COMMAND</replaceable>
 
178
          </synopsis>
151
179
          <para>
152
180
            This option allows you to override the default shell
153
181
            command that the server will use to check if the client is
170
198
      </varlistentry>
171
199
      
172
200
      <varlistentry>
173
 
        <term><option>fingerprint<literal> = </literal
174
 
        ><replaceable>HEXSTRING</replaceable></option></term>
 
201
        <term><literal>fingerprint</literal></term>
175
202
        <listitem>
 
203
          <synopsis><literal>fingerprint = </literal><replaceable
 
204
          >HEXSTRING</replaceable>
 
205
          </synopsis>
176
206
          <para>
177
207
            This option sets the OpenPGP fingerprint that identifies
178
208
            the public key that clients authenticate themselves with
183
213
      </varlistentry>
184
214
      
185
215
      <varlistentry>
186
 
        <term><option>secret<literal> = </literal><replaceable
187
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
216
        <term><literal>secret</literal></term>
188
217
        <listitem>
 
218
          <synopsis><literal>secret = </literal><replaceable
 
219
          >BASE64_ENCODED_DATA</replaceable>
 
220
          </synopsis>
189
221
          <para>
190
222
            If present, this option must be set to a string of
191
223
            base64-encoded binary data.  It will be decoded and sent
213
245
      </varlistentry>
214
246
 
215
247
      <varlistentry>
216
 
        <term><option>secfile<literal> = </literal><replaceable
217
 
        >FILENAME</replaceable></option></term>
 
248
        <term><literal>secfile</literal></term>
218
249
        <listitem>
 
250
          <synopsis><literal>secfile = </literal><replaceable
 
251
          >FILENAME</replaceable>
 
252
          </synopsis>
219
253
          <para>
220
 
            Similar to the <option>secret</option>, except the secret
221
 
            data is in an external file.  The contents of the file
222
 
            should <emphasis>not</emphasis> be base64-encoded, but
223
 
            will be sent to clients verbatim.
 
254
            The same as <option>secret</option>, but the secret data
 
255
            is in an external file.  The contents of the file should
 
256
            <emphasis>not</emphasis> be base64-encoded, but will be
 
257
            sent to clients verbatim.
224
258
          </para>
225
259
          <para>
226
260
            This option is only used, and <emphasis>must</emphasis> be
230
264
      </varlistentry>
231
265
 
232
266
      <varlistentry>
233
 
        <term><option><literal>host = </literal><replaceable
234
 
        >STRING</replaceable></option></term>
 
267
        <term><literal>host</literal></term>
235
268
        <listitem>
 
269
          <synopsis><literal>host = </literal><replaceable
 
270
          >STRING</replaceable>
 
271
          </synopsis>
236
272
          <para>
237
273
            Host name for this client.  This is not used by the server
238
274
            directly, but can be, and is by default, used by the
242
278
      </varlistentry>
243
279
      
244
280
    </variablelist>
245
 
  </refsect1>
 
281
  </refsect1>  
246
282
  
247
283
  <refsect1 id="expansion">
248
284
    <title>EXPANSION</title>
291
327
        percent characters in a row (<quote>%%%%</quote>) must be
292
328
        entered.  Also, a bad format here will lead to an immediate
293
329
        but <emphasis>silent</emphasis> run-time fatal exit; debug
294
 
        mode is needed to expose an error of this kind.
 
330
        mode is needed to track down an error of this kind.
295
331
      </para>
296
332
    </refsect2>
297
333
 
298
 
  </refsect1>
 
334
  </refsect1>  
299
335
  
300
336
  <refsect1 id="files">
301
337
    <title>FILES</title>
357
393
 
358
394
      </programlisting>
359
395
    </informalexample>
360
 
  </refsect1>
 
396
  </refsect1>  
361
397
  
362
398
  <refsect1 id="see_also">
363
399
    <title>SEE ALSO</title>
364
400
    <para>
365
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
366
 
      <manvolnum>8</manvolnum></citerefentry>,
367
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
368
 
      <manvolnum>5</manvolnum></citerefentry>,
369
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
370
 
      <manvolnum>8</manvolnum></citerefentry>
 
401
      <citerefentry>
 
402
        <refentrytitle>mandos</refentrytitle>
 
403
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
404
        <refentrytitle>mandos-keygen</refentrytitle>
 
405
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
406
        <refentrytitle>mandos.conf</refentrytitle>
 
407
        <manvolnum>5</manvolnum></citerefentry>
371
408
    </para>
372
409
  </refsect1>
373
410
</refentry>
374
 
<!-- Local Variables: -->
375
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
376
 
<!-- time-stamp-end: "[\"']>" -->
377
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
378
 
<!-- End: -->