/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
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-30">
8
7
]>
9
8
 
10
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>
73
71
  </refnamediv>
74
72
 
75
73
  <refsynopsisdiv>
76
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
77
77
  </refsynopsisdiv>
78
78
 
79
79
  <refsect1 id="description">
121
121
    <variablelist>
122
122
 
123
123
      <varlistentry>
124
 
        <term><option>timeout<literal> = </literal><replaceable
125
 
        >TIME</replaceable></option></term>
 
124
        <term><literal><varname>timeout</varname></literal></term>
126
125
        <listitem>
 
126
          <synopsis><literal>timeout = </literal><replaceable
 
127
          >TIME</replaceable>
 
128
          </synopsis>
127
129
          <para>
128
130
            The timeout is how long the server will wait for a
129
131
            successful checker run until a client is considered
147
149
      </varlistentry>
148
150
 
149
151
      <varlistentry>
150
 
        <term><option>interval<literal> = </literal><replaceable
151
 
        >TIME</replaceable></option></term>
 
152
        <term><literal><varname>interval</varname></literal></term>
152
153
        <listitem>
 
154
          <synopsis><literal>interval = </literal><replaceable
 
155
          >TIME</replaceable>
 
156
          </synopsis>
153
157
          <para>
154
158
            How often to run the checker to confirm that a client is
155
159
            still up.  <emphasis>Note:</emphasis> a new checker will
164
168
            as for <varname>timeout</varname> above.
165
169
          </para>
166
170
        </listitem>
167
 
      </varlistentry>
 
171
      </varlistentry>      
168
172
 
169
173
      <varlistentry>
170
 
        <term><option>checker<literal> = </literal><replaceable
171
 
        >COMMAND</replaceable></option></term>
 
174
        <term><literal>checker</literal></term>
172
175
        <listitem>
 
176
          <synopsis><literal>checker = </literal><replaceable
 
177
          >COMMAND</replaceable>
 
178
          </synopsis>
173
179
          <para>
174
180
            This option allows you to override the default shell
175
181
            command that the server will use to check if the client is
192
198
      </varlistentry>
193
199
      
194
200
      <varlistentry>
195
 
        <term><option>fingerprint<literal> = </literal
196
 
        ><replaceable>HEXSTRING</replaceable></option></term>
 
201
        <term><literal>fingerprint</literal></term>
197
202
        <listitem>
 
203
          <synopsis><literal>fingerprint = </literal><replaceable
 
204
          >HEXSTRING</replaceable>
 
205
          </synopsis>
198
206
          <para>
199
207
            This option sets the OpenPGP fingerprint that identifies
200
208
            the public key that clients authenticate themselves with
205
213
      </varlistentry>
206
214
      
207
215
      <varlistentry>
208
 
        <term><option>secret<literal> = </literal><replaceable
209
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
216
        <term><literal>secret</literal></term>
210
217
        <listitem>
 
218
          <synopsis><literal>secret = </literal><replaceable
 
219
          >BASE64_ENCODED_DATA</replaceable>
 
220
          </synopsis>
211
221
          <para>
212
222
            If present, this option must be set to a string of
213
223
            base64-encoded binary data.  It will be decoded and sent
235
245
      </varlistentry>
236
246
 
237
247
      <varlistentry>
238
 
        <term><option>secfile<literal> = </literal><replaceable
239
 
        >FILENAME</replaceable></option></term>
 
248
        <term><literal>secfile</literal></term>
240
249
        <listitem>
 
250
          <synopsis><literal>secfile = </literal><replaceable
 
251
          >FILENAME</replaceable>
 
252
          </synopsis>
241
253
          <para>
242
 
            Similar to the <option>secret</option>, except the secret
243
 
            data is in an external file.  The contents of the file
244
 
            should <emphasis>not</emphasis> be base64-encoded, but
245
 
            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.
246
258
          </para>
247
259
          <para>
248
260
            This option is only used, and <emphasis>must</emphasis> be
252
264
      </varlistentry>
253
265
 
254
266
      <varlistentry>
255
 
        <term><option><literal>host = </literal><replaceable
256
 
        >STRING</replaceable></option></term>
 
267
        <term><literal>host</literal></term>
257
268
        <listitem>
 
269
          <synopsis><literal>host = </literal><replaceable
 
270
          >STRING</replaceable>
 
271
          </synopsis>
258
272
          <para>
259
273
            Host name for this client.  This is not used by the server
260
274
            directly, but can be, and is by default, used by the
264
278
      </varlistentry>
265
279
      
266
280
    </variablelist>
267
 
  </refsect1>
 
281
  </refsect1>  
268
282
  
269
283
  <refsect1 id="expansion">
270
284
    <title>EXPANSION</title>
313
327
        percent characters in a row (<quote>%%%%</quote>) must be
314
328
        entered.  Also, a bad format here will lead to an immediate
315
329
        but <emphasis>silent</emphasis> run-time fatal exit; debug
316
 
        mode is needed to expose an error of this kind.
 
330
        mode is needed to track down an error of this kind.
317
331
      </para>
318
332
    </refsect2>
319
333
 
320
 
  </refsect1>
 
334
  </refsect1>  
321
335
  
322
336
  <refsect1 id="files">
323
337
    <title>FILES</title>
379
393
 
380
394
      </programlisting>
381
395
    </informalexample>
382
 
  </refsect1>
 
396
  </refsect1>  
383
397
  
384
398
  <refsect1 id="see_also">
385
399
    <title>SEE ALSO</title>
386
400
    <para>
387
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
388
 
      <manvolnum>8</manvolnum></citerefentry>,
389
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
390
 
      <manvolnum>5</manvolnum></citerefentry>,
391
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
392
 
      <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>
393
408
    </para>
394
409
  </refsect1>
395
410
</refentry>
396
 
<!-- Local Variables: -->
397
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
398
 
<!-- time-stamp-end: "[\"']>" -->
399
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
400
 
<!-- End: -->