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

  • Committer: teddy at bsnet
  • Date: 2010-09-21 19:16:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100921191641-yetps84gvjo7hrrc
* mandos-ctl.xml: New.
* Makefile (DOCS): Added "mandos-ctl.8".
  (mandos-ctl.8): New.

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