/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-30 19:05:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830190515-l7e6vu81yyw5kcku
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags.  Unify
                         short and long options.

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