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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

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