/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-09-03 05:04:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903050440-7cwzxestx6pvdy1i
* Makefile (mandos.8): Add dependency on "overview.xml" and
                       "legalnotice.xml".
  (mandos-keygen.8): New target.
  (mandos-conf.5): Added dependency on "legalnotice.xml".
  (plugin-runner.8mandos): New target
  (plugins.d/password-request.8mandos): - '' -

* mandos-options.xml (priority): Make wording server/client neutral.

* plugins.d/password-request.c (main): Changed .arg fields of the argp
                                       options struct to be more
                                       consistent with the manual.

* plugins.d/password-request.xml (OVERVIEW): Moved to after "OPTIONS".
  (OPTIONS): Improved wording and names of replaceables.

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-29">
 
7
<!ENTITY TIMESTAMP "2008-08-31">
8
8
]>
9
9
 
10
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
11
  <refentryinfo>
12
12
    <title>Mandos Manual</title>
13
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
35
35
      <holder>Teddy Hogeborn</holder>
36
36
      <holder>Björn Påhlsson</holder>
37
37
    </copyright>
38
 
    <legalnotice>
39
 
      <para>
40
 
        This manual page is free software: you can redistribute it
41
 
        and/or modify it under the terms of the GNU General Public
42
 
        License as published by the Free Software Foundation,
43
 
        either version 3 of the License, or (at your option) any
44
 
        later version.
45
 
      </para>
46
 
 
47
 
      <para>
48
 
        This manual page is distributed in the hope that it will
49
 
        be useful, but WITHOUT ANY WARRANTY; without even the
50
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
51
 
        PARTICULAR PURPOSE.  See the GNU General Public License
52
 
        for more details.
53
 
      </para>
54
 
 
55
 
      <para>
56
 
        You should have received a copy of the GNU General Public
57
 
        License along with this program; If not, see
58
 
        <ulink url="http://www.gnu.org/licenses/"/>.
59
 
      </para>
60
 
    </legalnotice>
 
38
    <xi:include href="legalnotice.xml"/>
61
39
  </refentryinfo>
62
40
 
63
41
  <refmeta>
73
51
  </refnamediv>
74
52
 
75
53
  <refsynopsisdiv>
76
 
    <synopsis>
77
 
      &CONFPATH;
78
 
    </synopsis>
 
54
    <synopsis>&CONFPATH;</synopsis>
79
55
  </refsynopsisdiv>
80
56
 
81
57
  <refsect1 id="description">
123
99
    <variablelist>
124
100
 
125
101
      <varlistentry>
126
 
        <term><literal><varname>timeout</varname></literal></term>
 
102
        <term><option>timeout<literal> = </literal><replaceable
 
103
        >TIME</replaceable></option></term>
127
104
        <listitem>
128
 
          <synopsis><literal>timeout = </literal><replaceable
129
 
          >TIME</replaceable>
130
 
          </synopsis>
131
105
          <para>
132
106
            The timeout is how long the server will wait for a
133
107
            successful checker run until a client is considered
151
125
      </varlistentry>
152
126
 
153
127
      <varlistentry>
154
 
        <term><literal><varname>interval</varname></literal></term>
 
128
        <term><option>interval<literal> = </literal><replaceable
 
129
        >TIME</replaceable></option></term>
155
130
        <listitem>
156
 
          <synopsis><literal>interval = </literal><replaceable
157
 
          >TIME</replaceable>
158
 
          </synopsis>
159
131
          <para>
160
132
            How often to run the checker to confirm that a client is
161
133
            still up.  <emphasis>Note:</emphasis> a new checker will
170
142
            as for <varname>timeout</varname> above.
171
143
          </para>
172
144
        </listitem>
173
 
      </varlistentry>      
 
145
      </varlistentry>
174
146
 
175
147
      <varlistentry>
176
 
        <term><literal>checker</literal></term>
 
148
        <term><option>checker<literal> = </literal><replaceable
 
149
        >COMMAND</replaceable></option></term>
177
150
        <listitem>
178
 
          <synopsis><literal>checker = </literal><replaceable
179
 
          >COMMAND</replaceable>
180
 
          </synopsis>
181
151
          <para>
182
152
            This option allows you to override the default shell
183
153
            command that the server will use to check if the client is
200
170
      </varlistentry>
201
171
      
202
172
      <varlistentry>
203
 
        <term><literal>fingerprint</literal></term>
 
173
        <term><option>fingerprint<literal> = </literal
 
174
        ><replaceable>HEXSTRING</replaceable></option></term>
204
175
        <listitem>
205
 
          <synopsis><literal>fingerprint = </literal><replaceable
206
 
          >HEXSTRING</replaceable>
207
 
          </synopsis>
208
176
          <para>
209
177
            This option sets the OpenPGP fingerprint that identifies
210
178
            the public key that clients authenticate themselves with
215
183
      </varlistentry>
216
184
      
217
185
      <varlistentry>
218
 
        <term><literal>secret</literal></term>
 
186
        <term><option>secret<literal> = </literal><replaceable
 
187
        >BASE64_ENCODED_DATA</replaceable></option></term>
219
188
        <listitem>
220
 
          <synopsis><literal>secret = </literal><replaceable
221
 
          >BASE64_ENCODED_DATA</replaceable>
222
 
          </synopsis>
223
189
          <para>
224
190
            If present, this option must be set to a string of
225
191
            base64-encoded binary data.  It will be decoded and sent
247
213
      </varlistentry>
248
214
 
249
215
      <varlistentry>
250
 
        <term><literal>secfile</literal></term>
 
216
        <term><option>secfile<literal> = </literal><replaceable
 
217
        >FILENAME</replaceable></option></term>
251
218
        <listitem>
252
 
          <synopsis><literal>secfile = </literal><replaceable
253
 
          >FILENAME</replaceable>
254
 
          </synopsis>
255
219
          <para>
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.
 
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.
260
224
          </para>
261
225
          <para>
262
226
            This option is only used, and <emphasis>must</emphasis> be
266
230
      </varlistentry>
267
231
 
268
232
      <varlistentry>
269
 
        <term><literal>host</literal></term>
 
233
        <term><option><literal>host = </literal><replaceable
 
234
        >STRING</replaceable></option></term>
270
235
        <listitem>
271
 
          <synopsis><literal>host = </literal><replaceable
272
 
          >STRING</replaceable>
273
 
          </synopsis>
274
236
          <para>
275
237
            Host name for this client.  This is not used by the server
276
238
            directly, but can be, and is by default, used by the
280
242
      </varlistentry>
281
243
      
282
244
    </variablelist>
283
 
  </refsect1>  
 
245
  </refsect1>
284
246
  
285
247
  <refsect1 id="expansion">
286
248
    <title>EXPANSION</title>
329
291
        percent characters in a row (<quote>%%%%</quote>) must be
330
292
        entered.  Also, a bad format here will lead to an immediate
331
293
        but <emphasis>silent</emphasis> run-time fatal exit; debug
332
 
        mode is needed to track down an error of this kind.
 
294
        mode is needed to expose an error of this kind.
333
295
      </para>
334
296
    </refsect2>
335
297
 
336
 
  </refsect1>  
 
298
  </refsect1>
337
299
  
338
300
  <refsect1 id="files">
339
301
    <title>FILES</title>
395
357
 
396
358
      </programlisting>
397
359
    </informalexample>
398
 
  </refsect1>  
 
360
  </refsect1>
399
361
  
400
362
  <refsect1 id="see_also">
401
363
    <title>SEE ALSO</title>