/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 17:16:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830171633-rjyuhsemikw6lg2w
* mandos-keygen.xml (SYNOPSIS): Fixed tags.  Unify short and long
                                options.
* plugins.d/password-request.xml (SYNOPSIS): - '' -

* mandos-clients.conf.xml: Removed extra white space.
* plugin-runner.xml: - '' -
* plugins.d/password-prompt.xml: - '' -
* mandos-keygen.xml: - '' -
* plugins.d/password-request.xml: - '' -

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">
 
7
<!ENTITY TIMESTAMP "2008-08-30">
8
8
]>
9
9
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
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
 
    <xi:include href="legalnotice.xml"/>
 
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>
39
61
  </refentryinfo>
40
62
 
41
63
  <refmeta>
51
73
  </refnamediv>
52
74
 
53
75
  <refsynopsisdiv>
54
 
    <synopsis>&CONFPATH;</synopsis>
 
76
    <synopsis>
 
77
      &CONFPATH;
 
78
    </synopsis>
55
79
  </refsynopsisdiv>
56
80
 
57
81
  <refsect1 id="description">
99
123
    <variablelist>
100
124
 
101
125
      <varlistentry>
102
 
        <term><option>timeout<literal> = </literal><replaceable
103
 
        >TIME</replaceable></option></term>
 
126
        <term><literal><varname>timeout</varname></literal></term>
104
127
        <listitem>
 
128
          <synopsis><literal>timeout = </literal><replaceable
 
129
          >TIME</replaceable>
 
130
          </synopsis>
105
131
          <para>
106
132
            The timeout is how long the server will wait for a
107
133
            successful checker run until a client is considered
125
151
      </varlistentry>
126
152
 
127
153
      <varlistentry>
128
 
        <term><option>interval<literal> = </literal><replaceable
129
 
        >TIME</replaceable></option></term>
 
154
        <term><literal><varname>interval</varname></literal></term>
130
155
        <listitem>
 
156
          <synopsis><literal>interval = </literal><replaceable
 
157
          >TIME</replaceable>
 
158
          </synopsis>
131
159
          <para>
132
160
            How often to run the checker to confirm that a client is
133
161
            still up.  <emphasis>Note:</emphasis> a new checker will
145
173
      </varlistentry>
146
174
 
147
175
      <varlistentry>
148
 
        <term><option>checker<literal> = </literal><replaceable
149
 
        >COMMAND</replaceable></option></term>
 
176
        <term><literal>checker</literal></term>
150
177
        <listitem>
 
178
          <synopsis><literal>checker = </literal><replaceable
 
179
          >COMMAND</replaceable>
 
180
          </synopsis>
151
181
          <para>
152
182
            This option allows you to override the default shell
153
183
            command that the server will use to check if the client is
170
200
      </varlistentry>
171
201
      
172
202
      <varlistentry>
173
 
        <term><option>fingerprint<literal> = </literal
174
 
        ><replaceable>HEXSTRING</replaceable></option></term>
 
203
        <term><literal>fingerprint</literal></term>
175
204
        <listitem>
 
205
          <synopsis><literal>fingerprint = </literal><replaceable
 
206
          >HEXSTRING</replaceable>
 
207
          </synopsis>
176
208
          <para>
177
209
            This option sets the OpenPGP fingerprint that identifies
178
210
            the public key that clients authenticate themselves with
183
215
      </varlistentry>
184
216
      
185
217
      <varlistentry>
186
 
        <term><option>secret<literal> = </literal><replaceable
187
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
218
        <term><literal>secret</literal></term>
188
219
        <listitem>
 
220
          <synopsis><literal>secret = </literal><replaceable
 
221
          >BASE64_ENCODED_DATA</replaceable>
 
222
          </synopsis>
189
223
          <para>
190
224
            If present, this option must be set to a string of
191
225
            base64-encoded binary data.  It will be decoded and sent
213
247
      </varlistentry>
214
248
 
215
249
      <varlistentry>
216
 
        <term><option>secfile<literal> = </literal><replaceable
217
 
        >FILENAME</replaceable></option></term>
 
250
        <term><literal>secfile</literal></term>
218
251
        <listitem>
 
252
          <synopsis><literal>secfile = </literal><replaceable
 
253
          >FILENAME</replaceable>
 
254
          </synopsis>
219
255
          <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.
 
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.
224
260
          </para>
225
261
          <para>
226
262
            This option is only used, and <emphasis>must</emphasis> be
230
266
      </varlistentry>
231
267
 
232
268
      <varlistentry>
233
 
        <term><option><literal>host = </literal><replaceable
234
 
        >STRING</replaceable></option></term>
 
269
        <term><literal>host</literal></term>
235
270
        <listitem>
 
271
          <synopsis><literal>host = </literal><replaceable
 
272
          >STRING</replaceable>
 
273
          </synopsis>
236
274
          <para>
237
275
            Host name for this client.  This is not used by the server
238
276
            directly, but can be, and is by default, used by the
291
329
        percent characters in a row (<quote>%%%%</quote>) must be
292
330
        entered.  Also, a bad format here will lead to an immediate
293
331
        but <emphasis>silent</emphasis> run-time fatal exit; debug
294
 
        mode is needed to expose an error of this kind.
 
332
        mode is needed to track down an error of this kind.
295
333
      </para>
296
334
    </refsect2>
297
335