/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-ctl.xml

* mandos (Client.runtime_expansions): New attribute containing the
                                      allowed runtime expansions.

* mandos-clients.conf.xml (OPTIONS): Reordered alphabetically.

* mandos-ctl: Bug fix: print timeout and interval values pretty again.

* mandos-ctl.xml (EXAMPLE): Added more examples.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 COMMANDNAME "mandos-ctl">
5
 
<!ENTITY TIMESTAMP "2015-07-20">
 
5
<!ENTITY TIMESTAMP "2010-09-25">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2010</year>
35
 
      <year>2011</year>
36
 
      <year>2012</year>
37
 
      <year>2013</year>
38
 
      <year>2014</year>
39
 
      <year>2015</year>
40
35
      <holder>Teddy Hogeborn</holder>
41
36
      <holder>Björn Påhlsson</holder>
42
37
    </copyright>
99
94
      </group>
100
95
      <sbr/>
101
96
      <group>
102
 
        <arg choice="plain"><option>--extended-timeout
103
 
        <replaceable>TIME</replaceable></option></arg>
104
 
      </group>
105
 
      <sbr/>
106
 
      <group>
107
 
        <arg choice="plain"><option>--interval
108
 
        <replaceable>TIME</replaceable></option></arg>
109
 
        <arg choice="plain"><option>-i
110
 
        <replaceable>TIME</replaceable></option></arg>
111
 
      </group>
112
 
      <sbr/>
113
 
      <group>
114
 
        <arg choice="plain"><option>--approve-by-default</option
115
 
        ></arg>
116
 
        <sbr/>
117
 
        <arg choice="plain"><option>--deny-by-default</option></arg>
118
 
      </group>
119
 
      <sbr/>
120
 
      <group>
121
 
        <arg choice="plain"><option>--approval-delay
122
 
        <replaceable>TIME</replaceable></option></arg>
123
 
      </group>
124
 
      <sbr/>
125
 
      <group>
126
 
        <arg choice="plain"><option>--approval-duration
127
 
        <replaceable>TIME</replaceable></option></arg>
128
 
      </group>
129
 
      <sbr/>
130
 
      <group>
131
97
        <arg choice="plain"><option>--interval
132
98
        <replaceable>TIME</replaceable></option></arg>
133
99
        <arg choice="plain"><option>-i
198
164
        <arg choice="plain"><option>-v</option></arg>
199
165
      </group>
200
166
    </cmdsynopsis>
201
 
    <cmdsynopsis>
202
 
      <command>&COMMANDNAME;</command>
203
 
      <arg choice="plain"><option>--check</option></arg>
204
 
    </cmdsynopsis>
205
167
  </refsynopsisdiv>
206
168
  
207
169
  <refsect1 id="description">
311
273
          <para>
312
274
            Set the <varname>checker</varname> option of the specified
313
275
            client(s); see <citerefentry><refentrytitle
314
 
            >mandos-clients.conf</refentrytitle><manvolnum
315
 
            >5</manvolnum></citerefentry>.
 
276
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
277
            ></citerefentry>.
316
278
          </para>
317
279
        </listitem>
318
280
      </varlistentry>
326
288
          <para>
327
289
            Set the <varname>timeout</varname> option of the specified
328
290
            client(s); see <citerefentry><refentrytitle
329
 
            >mandos-clients.conf</refentrytitle><manvolnum
330
 
            >5</manvolnum></citerefentry>.
331
 
          </para>
332
 
        </listitem>
333
 
      </varlistentry>
334
 
 
335
 
      <varlistentry>
336
 
        <term><option>--extended-timeout
337
 
        <replaceable>TIME</replaceable></option></term>
338
 
        <listitem>
339
 
          <para>
340
 
            Set the <varname>extended_timeout</varname> option of the
341
 
            specified client(s); see <citerefentry><refentrytitle
342
 
            >mandos-clients.conf</refentrytitle><manvolnum
343
 
            >5</manvolnum></citerefentry>.
 
291
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
292
            ></citerefentry>.
344
293
          </para>
345
294
        </listitem>
346
295
      </varlistentry>
352
301
        <replaceable>TIME</replaceable></option></term>
353
302
        <listitem>
354
303
          <para>
355
 
            Set the <varname>interval</varname> option of the
356
 
            specified client(s); see <citerefentry><refentrytitle
357
 
            >mandos-clients.conf</refentrytitle><manvolnum
358
 
            >5</manvolnum></citerefentry>.
359
 
          </para>
360
 
        </listitem>
361
 
      </varlistentry>
362
 
      
363
 
      <varlistentry>
364
 
        <term><option>--approve-by-default</option></term>
365
 
        <term><option>--deny-by-default</option></term>
366
 
        <listitem>
367
 
          <para>
368
 
            Set the <varname>approved_by_default</varname> option of
369
 
            the specified client(s) to <literal>True</literal> or
370
 
            <literal>False</literal>, respectively; see
371
 
            <citerefentry><refentrytitle
372
 
            >mandos-clients.conf</refentrytitle><manvolnum
373
 
            >5</manvolnum></citerefentry>.
374
 
          </para>
375
 
        </listitem>
376
 
      </varlistentry>
377
 
      
378
 
      <varlistentry>
379
 
        <term><option>--approval-delay
380
 
        <replaceable>TIME</replaceable></option></term>
381
 
        <listitem>
382
 
          <para>
383
 
            Set the <varname>approval_delay</varname> option of the
384
 
            specified client(s); see <citerefentry><refentrytitle
385
 
            >mandos-clients.conf</refentrytitle><manvolnum
386
 
            >5</manvolnum></citerefentry>.
387
 
          </para>
388
 
        </listitem>
389
 
      </varlistentry>
390
 
      
391
 
      <varlistentry>
392
 
        <term><option>--approval-duration
393
 
        <replaceable>TIME</replaceable></option></term>
394
 
        <listitem>
395
 
          <para>
396
 
            Set the <varname>approval_duration</varname> option of the
397
 
            specified client(s); see <citerefentry><refentrytitle
398
 
            >mandos-clients.conf</refentrytitle><manvolnum
399
 
            >5</manvolnum></citerefentry>.
 
304
            Set the <varname>interval</varname> option of the specified
 
305
            client(s); see <citerefentry><refentrytitle
 
306
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
307
            ></citerefentry>.
400
308
          </para>
401
309
        </listitem>
402
310
      </varlistentry>
410
318
          <para>
411
319
            Set the <varname>host</varname> option of the specified
412
320
            client(s); see <citerefentry><refentrytitle
413
 
            >mandos-clients.conf</refentrytitle><manvolnum
414
 
            >5</manvolnum></citerefentry>.
 
321
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
322
            ></citerefentry>.
415
323
          </para>
416
324
        </listitem>
417
325
      </varlistentry>
425
333
          <para>
426
334
            Set the <varname>secfile</varname> option of the specified
427
335
            client(s); see <citerefentry><refentrytitle
428
 
            >mandos-clients.conf</refentrytitle><manvolnum
429
 
            >5</manvolnum></citerefentry>.
 
336
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
337
            ></citerefentry>.
430
338
          </para>
431
339
        </listitem>
432
340
      </varlistentry>
483
391
        </listitem>
484
392
      </varlistentry>
485
393
      
486
 
      <varlistentry>
487
 
        <term><option>--check</option></term>
488
 
        <listitem>
489
 
          <para>
490
 
            Run self-tests.  This includes any unit tests, etc.
491
 
          </para>
492
 
        </listitem>
493
 
      </varlistentry>
494
 
      
495
394
    </variablelist>
496
395
  </refsect1>
497
396
  
572
471
        To approve all clients currently waiting for it:
573
472
      </para>
574
473
      <para>
575
 
        <userinput>&COMMANDNAME; --approve --all</userinput>
 
474
 
 
475
<!-- do not wrap this line -->
 
476
<userinput>&COMMANDNAME; --approve --all</userinput>
 
477
 
576
478
      </para>
577
479
    </informalexample>
578
480
  </refsect1>
589
491
  <refsect1 id="see_also">
590
492
    <title>SEE ALSO</title>
591
493
    <para>
592
 
      <citerefentry><refentrytitle>intro</refentrytitle>
593
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
594
494
      <citerefentry><refentrytitle>mandos</refentrytitle>
595
495
      <manvolnum>8</manvolnum></citerefentry>,
596
496
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>