/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:
mandos-ctl.xml
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 "2018-02-08">
 
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
 
      <year>2016</year>
41
 
      <year>2017</year>
42
 
      <year>2018</year>
43
35
      <holder>Teddy Hogeborn</holder>
44
36
      <holder>Björn Påhlsson</holder>
45
37
    </copyright>
54
46
  <refnamediv>
55
47
    <refname><command>&COMMANDNAME;</command></refname>
56
48
    <refpurpose>
57
 
      Control or query the operation of the Mandos server
 
49
      Control the operation of the Mandos server
58
50
    </refpurpose>
59
51
  </refnamediv>
60
52
  
61
53
  <refsynopsisdiv>
62
54
    <cmdsynopsis>
63
55
      <command>&COMMANDNAME;</command>
64
 
      <group choice="req">
65
 
        <group>
66
 
          <arg choice="plain"><option>--enable</option></arg>
67
 
          <arg choice="plain"><option>-e</option></arg>
68
 
          <sbr/>
69
 
          <arg choice="plain"><option>--disable</option></arg>
70
 
          <arg choice="plain"><option>-d</option></arg>
71
 
        </group>
72
 
        <sbr/>
73
 
        <group>
74
 
          <arg choice="plain"><option>--bump-timeout</option></arg>
75
 
          <arg choice="plain"><option>-b</option></arg>
76
 
        </group>
77
 
        <sbr/>
78
 
        <group>
79
 
          <arg choice="plain"><option>--start-checker</option></arg>
80
 
        </group>
81
 
        <sbr/>
82
 
        <group>
83
 
          <arg choice="plain"><option>--stop-checker</option></arg>
84
 
        </group>
85
 
        <sbr/>
86
 
        <group>
87
 
          <arg choice="plain"><option>--remove</option></arg>
88
 
          <arg choice="plain"><option>-r</option></arg>
89
 
        </group>
90
 
        <sbr/>
91
 
        <group>
92
 
          <arg choice="plain"><option>--checker
93
 
          <replaceable>COMMAND</replaceable></option></arg>
94
 
          <arg choice="plain"><option>-c
95
 
          <replaceable>COMMAND</replaceable></option></arg>
96
 
        </group>
97
 
        <sbr/>
98
 
        <group>
99
 
          <arg choice="plain"><option>--timeout
100
 
          <replaceable>TIME</replaceable></option></arg>
101
 
          <arg choice="plain"><option>-t
102
 
          <replaceable>TIME</replaceable></option></arg>
103
 
        </group>
104
 
        <sbr/>
105
 
        <group>
106
 
          <arg choice="plain"><option>--extended-timeout
107
 
          <replaceable>TIME</replaceable></option></arg>
108
 
        </group>
109
 
        <sbr/>
110
 
        <group>
111
 
          <arg choice="plain"><option>--interval
112
 
          <replaceable>TIME</replaceable></option></arg>
113
 
          <arg choice="plain"><option>-i
114
 
          <replaceable>TIME</replaceable></option></arg>
115
 
        </group>
116
 
        <sbr/>
117
 
        <group>
118
 
          <arg choice="plain"><option>--approve-by-default</option
119
 
          ></arg>
120
 
          <sbr/>
121
 
          <arg choice="plain"><option>--deny-by-default</option></arg>
122
 
        </group>
123
 
        <sbr/>
124
 
        <group>
125
 
          <arg choice="plain"><option>--approval-delay
126
 
          <replaceable>TIME</replaceable></option></arg>
127
 
        </group>
128
 
        <sbr/>
129
 
        <group>
130
 
          <arg choice="plain"><option>--approval-duration
131
 
          <replaceable>TIME</replaceable></option></arg>
132
 
        </group>
133
 
        <sbr/>
134
 
        <group>
135
 
          <arg choice="plain"><option>--interval
136
 
          <replaceable>TIME</replaceable></option></arg>
137
 
          <arg choice="plain"><option>-i
138
 
          <replaceable>TIME</replaceable></option></arg>
139
 
        </group>
140
 
        <sbr/>
141
 
        <group>
142
 
          <arg choice="plain"><option>--host
143
 
          <replaceable>STRING</replaceable></option></arg>
144
 
          <arg choice="plain"><option>-H
145
 
          <replaceable>STRING</replaceable></option></arg>
146
 
        </group>
147
 
        <sbr/>
148
 
        <group>
149
 
          <arg choice="plain"><option>--secret
150
 
          <replaceable>FILENAME</replaceable></option></arg>
151
 
          <arg choice="plain"><option>-s
152
 
          <replaceable>FILENAME</replaceable></option></arg>
153
 
        </group>
154
 
        <sbr/>
155
 
        <group>
156
 
          <arg choice="plain"><option>--approve</option></arg>
157
 
          <arg choice="plain"><option>-A</option></arg>
158
 
          <sbr/>
159
 
          <arg choice="plain"><option>--deny</option></arg>
160
 
          <arg choice="plain"><option>-D</option></arg>
161
 
        </group>
 
56
      <group>
 
57
        <arg choice="plain"><option>--enable</option></arg>
 
58
        <arg choice="plain"><option>-e</option></arg>
 
59
        <sbr/>
 
60
        <arg choice="plain"><option>--disable</option></arg>
 
61
        <arg choice="plain"><option>-d</option></arg>
 
62
      </group>
 
63
      <sbr/>
 
64
      <group>
 
65
        <arg choice="plain"><option>--bump-timeout</option></arg>
 
66
        <arg choice="plain"><option>-b</option></arg>
 
67
      </group>
 
68
      <sbr/>
 
69
      <group>
 
70
        <arg choice="plain"><option>--start-checker</option></arg>
 
71
      </group>
 
72
      <sbr/>
 
73
      <group>
 
74
        <arg choice="plain"><option>--stop-checker</option></arg>
 
75
      </group>
 
76
      <sbr/>
 
77
      <group>
 
78
        <arg choice="plain"><option>--remove</option></arg>
 
79
        <arg choice="plain"><option>-r</option></arg>
 
80
      </group>
 
81
      <sbr/>
 
82
      <group>
 
83
        <arg choice="plain"><option>--checker
 
84
        <replaceable>COMMAND</replaceable></option></arg>
 
85
        <arg choice="plain"><option>-c
 
86
        <replaceable>COMMAND</replaceable></option></arg>
 
87
      </group>
 
88
      <sbr/>
 
89
      <group>
 
90
        <arg choice="plain"><option>--timeout
 
91
        <replaceable>TIME</replaceable></option></arg>
 
92
        <arg choice="plain"><option>-t
 
93
        <replaceable>TIME</replaceable></option></arg>
 
94
      </group>
 
95
      <sbr/>
 
96
      <group>
 
97
        <arg choice="plain"><option>--interval
 
98
        <replaceable>TIME</replaceable></option></arg>
 
99
        <arg choice="plain"><option>-i
 
100
        <replaceable>TIME</replaceable></option></arg>
 
101
      </group>
 
102
      <sbr/>
 
103
      <group>
 
104
        <arg choice="plain"><option>--host
 
105
        <replaceable>STRING</replaceable></option></arg>
 
106
        <arg choice="plain"><option>-H
 
107
        <replaceable>STRING</replaceable></option></arg>
 
108
      </group>
 
109
      <sbr/>
 
110
      <group>
 
111
        <arg choice="plain"><option>--secret
 
112
        <replaceable>FILENAME</replaceable></option></arg>
 
113
        <arg choice="plain"><option>-s
 
114
        <replaceable>FILENAME</replaceable></option></arg>
 
115
      </group>
 
116
      <sbr/>
 
117
      <group>
 
118
        <arg choice="plain"><option>--approve</option></arg>
 
119
        <arg choice="plain"><option>-A</option></arg>
 
120
        <sbr/>
 
121
        <arg choice="plain"><option>--deny</option></arg>
 
122
        <arg choice="plain"><option>-D</option></arg>
162
123
      </group>
163
124
      <sbr/>
164
125
      <group choice="req">
172
133
    <cmdsynopsis>
173
134
      <command>&COMMANDNAME;</command>
174
135
      <group>
175
 
          <arg choice="plain"><option>--verbose</option></arg>
176
 
          <arg choice="plain"><option>-v</option></arg>
177
 
          <sbr/>
178
 
          <arg choice="plain"><option>--dump-json</option></arg>
179
 
          <arg choice="plain"><option>-j</option></arg>
 
136
        <arg choice="plain"><option>--verbose</option></arg>
 
137
        <arg choice="plain"><option>-v</option></arg>
180
138
      </group>
181
139
      <group>
182
140
        <arg rep='repeat' choice='plain'>
206
164
        <arg choice="plain"><option>-v</option></arg>
207
165
      </group>
208
166
    </cmdsynopsis>
209
 
    <cmdsynopsis>
210
 
      <command>&COMMANDNAME;</command>
211
 
      <arg choice="plain"><option>--check</option></arg>
212
 
    </cmdsynopsis>
213
167
  </refsynopsisdiv>
214
168
  
215
169
  <refsect1 id="description">
216
170
    <title>DESCRIPTION</title>
217
171
    <para>
218
 
      <command>&COMMANDNAME;</command> is a program to control or
219
 
      query the operation of the Mandos server
220
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
221
 
      >8</manvolnum></citerefentry>.
 
172
      <command>&COMMANDNAME;</command> is a program to control the
 
173
      operation of the Mandos server <citerefentry><refentrytitle
 
174
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
222
175
    </para>
223
176
    <para>
224
177
      This program can be used to change client settings, approve or
320
273
          <para>
321
274
            Set the <varname>checker</varname> option of the specified
322
275
            client(s); see <citerefentry><refentrytitle
323
 
            >mandos-clients.conf</refentrytitle><manvolnum
324
 
            >5</manvolnum></citerefentry>.
 
276
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
277
            ></citerefentry>.
325
278
          </para>
326
279
        </listitem>
327
280
      </varlistentry>
335
288
          <para>
336
289
            Set the <varname>timeout</varname> option of the specified
337
290
            client(s); see <citerefentry><refentrytitle
338
 
            >mandos-clients.conf</refentrytitle><manvolnum
339
 
            >5</manvolnum></citerefentry>.
340
 
          </para>
341
 
        </listitem>
342
 
      </varlistentry>
343
 
 
344
 
      <varlistentry>
345
 
        <term><option>--extended-timeout
346
 
        <replaceable>TIME</replaceable></option></term>
347
 
        <listitem>
348
 
          <para>
349
 
            Set the <varname>extended_timeout</varname> option of the
350
 
            specified client(s); see <citerefentry><refentrytitle
351
 
            >mandos-clients.conf</refentrytitle><manvolnum
352
 
            >5</manvolnum></citerefentry>.
 
291
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
292
            ></citerefentry>.
353
293
          </para>
354
294
        </listitem>
355
295
      </varlistentry>
361
301
        <replaceable>TIME</replaceable></option></term>
362
302
        <listitem>
363
303
          <para>
364
 
            Set the <varname>interval</varname> option of the
365
 
            specified client(s); see <citerefentry><refentrytitle
366
 
            >mandos-clients.conf</refentrytitle><manvolnum
367
 
            >5</manvolnum></citerefentry>.
368
 
          </para>
369
 
        </listitem>
370
 
      </varlistentry>
371
 
      
372
 
      <varlistentry>
373
 
        <term><option>--approve-by-default</option></term>
374
 
        <term><option>--deny-by-default</option></term>
375
 
        <listitem>
376
 
          <para>
377
 
            Set the <varname>approved_by_default</varname> option of
378
 
            the specified client(s) to <literal>True</literal> or
379
 
            <literal>False</literal>, respectively; see
380
 
            <citerefentry><refentrytitle
381
 
            >mandos-clients.conf</refentrytitle><manvolnum
382
 
            >5</manvolnum></citerefentry>.
383
 
          </para>
384
 
        </listitem>
385
 
      </varlistentry>
386
 
      
387
 
      <varlistentry>
388
 
        <term><option>--approval-delay
389
 
        <replaceable>TIME</replaceable></option></term>
390
 
        <listitem>
391
 
          <para>
392
 
            Set the <varname>approval_delay</varname> option of the
393
 
            specified client(s); see <citerefentry><refentrytitle
394
 
            >mandos-clients.conf</refentrytitle><manvolnum
395
 
            >5</manvolnum></citerefentry>.
396
 
          </para>
397
 
        </listitem>
398
 
      </varlistentry>
399
 
      
400
 
      <varlistentry>
401
 
        <term><option>--approval-duration
402
 
        <replaceable>TIME</replaceable></option></term>
403
 
        <listitem>
404
 
          <para>
405
 
            Set the <varname>approval_duration</varname> option of the
406
 
            specified client(s); see <citerefentry><refentrytitle
407
 
            >mandos-clients.conf</refentrytitle><manvolnum
408
 
            >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>.
409
308
          </para>
410
309
        </listitem>
411
310
      </varlistentry>
419
318
          <para>
420
319
            Set the <varname>host</varname> option of the specified
421
320
            client(s); see <citerefentry><refentrytitle
422
 
            >mandos-clients.conf</refentrytitle><manvolnum
423
 
            >5</manvolnum></citerefentry>.
 
321
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
322
            ></citerefentry>.
424
323
          </para>
425
324
        </listitem>
426
325
      </varlistentry>
434
333
          <para>
435
334
            Set the <varname>secfile</varname> option of the specified
436
335
            client(s); see <citerefentry><refentrytitle
437
 
            >mandos-clients.conf</refentrytitle><manvolnum
438
 
            >5</manvolnum></citerefentry>.
 
336
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
337
            ></citerefentry>.
439
338
          </para>
440
339
        </listitem>
441
340
      </varlistentry>
482
381
      </varlistentry>
483
382
      
484
383
      <varlistentry>
485
 
        <term><option>--dump-json</option></term>
486
 
        <term><option>-j</option></term>
487
 
        <listitem>
488
 
          <para>
489
 
            Dump client settings as JSON to standard output.
490
 
          </para>
491
 
        </listitem>
492
 
      </varlistentry>
493
 
      
494
 
      <varlistentry>
495
384
        <term><option>--is-enabled</option></term>
496
385
        <term><option>-V</option></term>
497
386
        <listitem>
502
391
        </listitem>
503
392
      </varlistentry>
504
393
      
505
 
      <varlistentry>
506
 
        <term><option>--check</option></term>
507
 
        <listitem>
508
 
          <para>
509
 
            Run self-tests.  This includes any unit tests, etc.
510
 
          </para>
511
 
        </listitem>
512
 
      </varlistentry>
513
 
      
514
394
    </variablelist>
515
395
  </refsect1>
516
396
  
532
412
    </para>
533
413
  </refsect1>
534
414
  
535
 
  <refsect1 id="bugs">
536
 
    <title>BUGS</title>
537
 
    <xi:include href="bugs.xml"/>
538
 
  </refsect1>
 
415
<!--   <refsect1 id="bugs"> -->
 
416
<!--     <title>BUGS</title> -->
 
417
<!--     <para> -->
 
418
<!--     </para> -->
 
419
<!--   </refsect1> -->
539
420
  
540
421
  <refsect1 id="example">
541
422
    <title>EXAMPLE</title>
590
471
        To approve all clients currently waiting for it:
591
472
      </para>
592
473
      <para>
593
 
        <userinput>&COMMANDNAME; --approve --all</userinput>
 
474
 
 
475
<!-- do not wrap this line -->
 
476
<userinput>&COMMANDNAME; --approve --all</userinput>
 
477
 
594
478
      </para>
595
479
    </informalexample>
596
480
  </refsect1>
607
491
  <refsect1 id="see_also">
608
492
    <title>SEE ALSO</title>
609
493
    <para>
610
 
      <citerefentry><refentrytitle>intro</refentrytitle>
611
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
612
494
      <citerefentry><refentrytitle>mandos</refentrytitle>
613
495
      <manvolnum>8</manvolnum></citerefentry>,
614
496
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>