/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-clients.conf.xml (EXPANSION/RUNTIME EXPANSION): List possible
                                                         keys.

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 "2016-06-27">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
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
35
      <holder>Teddy Hogeborn</holder>
42
36
      <holder>Björn Påhlsson</holder>
43
37
    </copyright>
52
46
  <refnamediv>
53
47
    <refname><command>&COMMANDNAME;</command></refname>
54
48
    <refpurpose>
55
 
      Control or query the operation of the Mandos server
 
49
      Control the operation of the Mandos server
56
50
    </refpurpose>
57
51
  </refnamediv>
58
52
  
59
53
  <refsynopsisdiv>
60
54
    <cmdsynopsis>
61
55
      <command>&COMMANDNAME;</command>
62
 
      <group choice="req">
63
 
        <group>
64
 
          <arg choice="plain"><option>--enable</option></arg>
65
 
          <arg choice="plain"><option>-e</option></arg>
66
 
          <sbr/>
67
 
          <arg choice="plain"><option>--disable</option></arg>
68
 
          <arg choice="plain"><option>-d</option></arg>
69
 
        </group>
70
 
        <sbr/>
71
 
        <group>
72
 
          <arg choice="plain"><option>--bump-timeout</option></arg>
73
 
          <arg choice="plain"><option>-b</option></arg>
74
 
        </group>
75
 
        <sbr/>
76
 
        <group>
77
 
          <arg choice="plain"><option>--start-checker</option></arg>
78
 
        </group>
79
 
        <sbr/>
80
 
        <group>
81
 
          <arg choice="plain"><option>--stop-checker</option></arg>
82
 
        </group>
83
 
        <sbr/>
84
 
        <group>
85
 
          <arg choice="plain"><option>--remove</option></arg>
86
 
          <arg choice="plain"><option>-r</option></arg>
87
 
        </group>
88
 
        <sbr/>
89
 
        <group>
90
 
          <arg choice="plain"><option>--checker
91
 
          <replaceable>COMMAND</replaceable></option></arg>
92
 
          <arg choice="plain"><option>-c
93
 
          <replaceable>COMMAND</replaceable></option></arg>
94
 
        </group>
95
 
        <sbr/>
96
 
        <group>
97
 
          <arg choice="plain"><option>--timeout
98
 
          <replaceable>TIME</replaceable></option></arg>
99
 
          <arg choice="plain"><option>-t
100
 
          <replaceable>TIME</replaceable></option></arg>
101
 
        </group>
102
 
        <sbr/>
103
 
        <group>
104
 
          <arg choice="plain"><option>--extended-timeout
105
 
          <replaceable>TIME</replaceable></option></arg>
106
 
        </group>
107
 
        <sbr/>
108
 
        <group>
109
 
          <arg choice="plain"><option>--interval
110
 
          <replaceable>TIME</replaceable></option></arg>
111
 
          <arg choice="plain"><option>-i
112
 
          <replaceable>TIME</replaceable></option></arg>
113
 
        </group>
114
 
        <sbr/>
115
 
        <group>
116
 
          <arg choice="plain"><option>--approve-by-default</option
117
 
          ></arg>
118
 
          <sbr/>
119
 
          <arg choice="plain"><option>--deny-by-default</option></arg>
120
 
        </group>
121
 
        <sbr/>
122
 
        <group>
123
 
          <arg choice="plain"><option>--approval-delay
124
 
          <replaceable>TIME</replaceable></option></arg>
125
 
        </group>
126
 
        <sbr/>
127
 
        <group>
128
 
          <arg choice="plain"><option>--approval-duration
129
 
          <replaceable>TIME</replaceable></option></arg>
130
 
        </group>
131
 
        <sbr/>
132
 
        <group>
133
 
          <arg choice="plain"><option>--interval
134
 
          <replaceable>TIME</replaceable></option></arg>
135
 
          <arg choice="plain"><option>-i
136
 
          <replaceable>TIME</replaceable></option></arg>
137
 
        </group>
138
 
        <sbr/>
139
 
        <group>
140
 
          <arg choice="plain"><option>--host
141
 
          <replaceable>STRING</replaceable></option></arg>
142
 
          <arg choice="plain"><option>-H
143
 
          <replaceable>STRING</replaceable></option></arg>
144
 
        </group>
145
 
        <sbr/>
146
 
        <group>
147
 
          <arg choice="plain"><option>--secret
148
 
          <replaceable>FILENAME</replaceable></option></arg>
149
 
          <arg choice="plain"><option>-s
150
 
          <replaceable>FILENAME</replaceable></option></arg>
151
 
        </group>
152
 
        <sbr/>
153
 
        <group>
154
 
          <arg choice="plain"><option>--approve</option></arg>
155
 
          <arg choice="plain"><option>-A</option></arg>
156
 
          <sbr/>
157
 
          <arg choice="plain"><option>--deny</option></arg>
158
 
          <arg choice="plain"><option>-D</option></arg>
159
 
        </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>--approve-by-default</option
 
105
        ></arg>
 
106
        <sbr/>
 
107
        <arg choice="plain"><option>--deny-by-default</option></arg>
 
108
      </group>
 
109
      <sbr/>
 
110
      <group>
 
111
        <arg choice="plain"><option>--approval-delay
 
112
        <replaceable>TIME</replaceable></option></arg>
 
113
      </group>
 
114
      <sbr/>
 
115
      <group>
 
116
        <arg choice="plain"><option>--approval-duration
 
117
        <replaceable>TIME</replaceable></option></arg>
 
118
      </group>
 
119
      <sbr/>
 
120
      <group>
 
121
        <arg choice="plain"><option>--interval
 
122
        <replaceable>TIME</replaceable></option></arg>
 
123
        <arg choice="plain"><option>-i
 
124
        <replaceable>TIME</replaceable></option></arg>
 
125
      </group>
 
126
      <sbr/>
 
127
      <group>
 
128
        <arg choice="plain"><option>--host
 
129
        <replaceable>STRING</replaceable></option></arg>
 
130
        <arg choice="plain"><option>-H
 
131
        <replaceable>STRING</replaceable></option></arg>
 
132
      </group>
 
133
      <sbr/>
 
134
      <group>
 
135
        <arg choice="plain"><option>--secret
 
136
        <replaceable>FILENAME</replaceable></option></arg>
 
137
        <arg choice="plain"><option>-s
 
138
        <replaceable>FILENAME</replaceable></option></arg>
 
139
      </group>
 
140
      <sbr/>
 
141
      <group>
 
142
        <arg choice="plain"><option>--approve</option></arg>
 
143
        <arg choice="plain"><option>-A</option></arg>
 
144
        <sbr/>
 
145
        <arg choice="plain"><option>--deny</option></arg>
 
146
        <arg choice="plain"><option>-D</option></arg>
160
147
      </group>
161
148
      <sbr/>
162
149
      <group choice="req">
170
157
    <cmdsynopsis>
171
158
      <command>&COMMANDNAME;</command>
172
159
      <group>
173
 
          <arg choice="plain"><option>--verbose</option></arg>
174
 
          <arg choice="plain"><option>-v</option></arg>
175
 
          <sbr/>
176
 
          <arg choice="plain"><option>--dump-json</option></arg>
177
 
          <arg choice="plain"><option>-j</option></arg>
 
160
        <arg choice="plain"><option>--verbose</option></arg>
 
161
        <arg choice="plain"><option>-v</option></arg>
178
162
      </group>
179
163
      <group>
180
164
        <arg rep='repeat' choice='plain'>
204
188
        <arg choice="plain"><option>-v</option></arg>
205
189
      </group>
206
190
    </cmdsynopsis>
207
 
    <cmdsynopsis>
208
 
      <command>&COMMANDNAME;</command>
209
 
      <arg choice="plain"><option>--check</option></arg>
210
 
    </cmdsynopsis>
211
191
  </refsynopsisdiv>
212
192
  
213
193
  <refsect1 id="description">
214
194
    <title>DESCRIPTION</title>
215
195
    <para>
216
 
      <command>&COMMANDNAME;</command> is a program to control or
217
 
      query the operation of the Mandos server
218
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
219
 
      >8</manvolnum></citerefentry>.
 
196
      <command>&COMMANDNAME;</command> is a program to control the
 
197
      operation of the Mandos server <citerefentry><refentrytitle
 
198
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
220
199
    </para>
221
200
    <para>
222
201
      This program can be used to change client settings, approve or
338
317
          </para>
339
318
        </listitem>
340
319
      </varlistentry>
341
 
 
342
 
      <varlistentry>
343
 
        <term><option>--extended-timeout
344
 
        <replaceable>TIME</replaceable></option></term>
345
 
        <listitem>
346
 
          <para>
347
 
            Set the <varname>extended_timeout</varname> option of the
348
 
            specified client(s); see <citerefentry><refentrytitle
349
 
            >mandos-clients.conf</refentrytitle><manvolnum
350
 
            >5</manvolnum></citerefentry>.
351
 
          </para>
352
 
        </listitem>
353
 
      </varlistentry>
354
320
      
355
321
      <varlistentry>
356
322
        <term><option>--interval
480
446
      </varlistentry>
481
447
      
482
448
      <varlistentry>
483
 
        <term><option>--dump-json</option></term>
484
 
        <term><option>-j</option></term>
485
 
        <listitem>
486
 
          <para>
487
 
            Dump client settings as JSON to standard output.
488
 
          </para>
489
 
        </listitem>
490
 
      </varlistentry>
491
 
      
492
 
      <varlistentry>
493
449
        <term><option>--is-enabled</option></term>
494
450
        <term><option>-V</option></term>
495
451
        <listitem>
500
456
        </listitem>
501
457
      </varlistentry>
502
458
      
503
 
      <varlistentry>
504
 
        <term><option>--check</option></term>
505
 
        <listitem>
506
 
          <para>
507
 
            Run self-tests.  This includes any unit tests, etc.
508
 
          </para>
509
 
        </listitem>
510
 
      </varlistentry>
511
 
      
512
459
    </variablelist>
513
460
  </refsect1>
514
461
  
530
477
    </para>
531
478
  </refsect1>
532
479
  
533
 
  <refsect1 id="bugs">
534
 
    <title>BUGS</title>
535
 
    <xi:include href="bugs.xml"/>
536
 
  </refsect1>
 
480
<!--   <refsect1 id="bugs"> -->
 
481
<!--     <title>BUGS</title> -->
 
482
<!--     <para> -->
 
483
<!--     </para> -->
 
484
<!--   </refsect1> -->
537
485
  
538
486
  <refsect1 id="example">
539
487
    <title>EXAMPLE</title>
605
553
  <refsect1 id="see_also">
606
554
    <title>SEE ALSO</title>
607
555
    <para>
608
 
      <citerefentry><refentrytitle>intro</refentrytitle>
609
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
610
556
      <citerefentry><refentrytitle>mandos</refentrytitle>
611
557
      <manvolnum>8</manvolnum></citerefentry>,
612
558
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>