/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

Update copyright year to "2011" wherever appropriate.

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 "2019-03-07">
 
5
<!ENTITY TIMESTAMP "2011-02-27">
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
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
 
      <year>2019</year>
44
36
      <holder>Teddy Hogeborn</holder>
45
37
      <holder>Björn Påhlsson</holder>
46
38
    </copyright>
55
47
  <refnamediv>
56
48
    <refname><command>&COMMANDNAME;</command></refname>
57
49
    <refpurpose>
58
 
      Control or query the operation of the Mandos server
 
50
      Control the operation of the Mandos server
59
51
    </refpurpose>
60
52
  </refnamediv>
61
53
  
62
54
  <refsynopsisdiv>
63
55
    <cmdsynopsis>
64
56
      <command>&COMMANDNAME;</command>
65
 
      <group choice="req">
66
 
        <group>
67
 
          <arg choice="plain"><option>--enable</option></arg>
68
 
          <arg choice="plain"><option>-e</option></arg>
69
 
          <sbr/>
70
 
          <arg choice="plain"><option>--disable</option></arg>
71
 
          <arg choice="plain"><option>-d</option></arg>
72
 
        </group>
73
 
        <sbr/>
74
 
        <group>
75
 
          <arg choice="plain"><option>--bump-timeout</option></arg>
76
 
          <arg choice="plain"><option>-b</option></arg>
77
 
        </group>
78
 
        <sbr/>
79
 
        <group>
80
 
          <arg choice="plain"><option>--start-checker</option></arg>
81
 
          <arg choice="plain"><option>--stop-checker</option></arg>
82
 
        </group>
83
 
        <sbr/>
84
 
        <group>
85
 
          <arg choice="plain"><option>--checker
86
 
          <replaceable>COMMAND</replaceable></option></arg>
87
 
          <arg choice="plain"><option>-c
88
 
          <replaceable>COMMAND</replaceable></option></arg>
89
 
        </group>
90
 
        <sbr/>
91
 
        <group>
92
 
          <arg choice="plain"><option>--timeout
93
 
          <replaceable>TIME</replaceable></option></arg>
94
 
          <arg choice="plain"><option>-t
95
 
          <replaceable>TIME</replaceable></option></arg>
96
 
        </group>
97
 
        <sbr/>
98
 
        <group>
99
 
          <arg choice="plain"><option>--extended-timeout
100
 
          <replaceable>TIME</replaceable></option></arg>
101
 
        </group>
102
 
        <sbr/>
103
 
        <group>
104
 
          <arg choice="plain"><option>--interval
105
 
          <replaceable>TIME</replaceable></option></arg>
106
 
          <arg choice="plain"><option>-i
107
 
          <replaceable>TIME</replaceable></option></arg>
108
 
        </group>
109
 
        <sbr/>
110
 
        <group>
111
 
          <arg choice="plain"><option>--approve-by-default</option
112
 
          ></arg>
113
 
          <sbr/>
114
 
          <arg choice="plain"><option>--deny-by-default</option></arg>
115
 
        </group>
116
 
        <sbr/>
117
 
        <group>
118
 
          <arg choice="plain"><option>--approval-delay
119
 
          <replaceable>TIME</replaceable></option></arg>
120
 
        </group>
121
 
        <sbr/>
122
 
        <group>
123
 
          <arg choice="plain"><option>--approval-duration
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>
147
 
        </group>
148
 
      </group>
149
 
      <sbr/>
150
 
      <group choice="req">
151
 
        <arg choice="plain"><option>--all</option></arg>
152
 
        <arg choice="plain"><option>-a</option></arg>
153
 
        <arg rep='repeat' choice='plain'>
154
 
          <replaceable>CLIENT</replaceable>
155
 
        </arg>
156
 
      </group>
157
 
    </cmdsynopsis>
158
 
    <cmdsynopsis>
159
 
      <command>&COMMANDNAME;</command>
160
 
      <group>
 
57
      <group>
 
58
        <arg choice="plain"><option>--enable</option></arg>
 
59
        <arg choice="plain"><option>-e</option></arg>
 
60
        <sbr/>
 
61
        <arg choice="plain"><option>--disable</option></arg>
 
62
        <arg choice="plain"><option>-d</option></arg>
 
63
      </group>
 
64
      <sbr/>
 
65
      <group>
 
66
        <arg choice="plain"><option>--bump-timeout</option></arg>
 
67
        <arg choice="plain"><option>-b</option></arg>
 
68
      </group>
 
69
      <sbr/>
 
70
      <group>
 
71
        <arg choice="plain"><option>--start-checker</option></arg>
 
72
      </group>
 
73
      <sbr/>
 
74
      <group>
 
75
        <arg choice="plain"><option>--stop-checker</option></arg>
 
76
      </group>
 
77
      <sbr/>
 
78
      <group>
 
79
        <arg choice="plain"><option>--remove</option></arg>
 
80
        <arg choice="plain"><option>-r</option></arg>
 
81
      </group>
 
82
      <sbr/>
 
83
      <group>
 
84
        <arg choice="plain"><option>--checker
 
85
        <replaceable>COMMAND</replaceable></option></arg>
 
86
        <arg choice="plain"><option>-c
 
87
        <replaceable>COMMAND</replaceable></option></arg>
 
88
      </group>
 
89
      <sbr/>
 
90
      <group>
 
91
        <arg choice="plain"><option>--timeout
 
92
        <replaceable>TIME</replaceable></option></arg>
 
93
        <arg choice="plain"><option>-t
 
94
        <replaceable>TIME</replaceable></option></arg>
 
95
      </group>
 
96
      <sbr/>
 
97
      <group>
 
98
        <arg choice="plain"><option>--interval
 
99
        <replaceable>TIME</replaceable></option></arg>
 
100
        <arg choice="plain"><option>-i
 
101
        <replaceable>TIME</replaceable></option></arg>
 
102
      </group>
 
103
      <sbr/>
 
104
      <group>
 
105
        <arg choice="plain"><option>--approve-by-default</option
 
106
        ></arg>
 
107
        <sbr/>
 
108
        <arg choice="plain"><option>--deny-by-default</option></arg>
 
109
      </group>
 
110
      <sbr/>
 
111
      <group>
 
112
        <arg choice="plain"><option>--approval-delay
 
113
        <replaceable>TIME</replaceable></option></arg>
 
114
      </group>
 
115
      <sbr/>
 
116
      <group>
 
117
        <arg choice="plain"><option>--approval-duration
 
118
        <replaceable>TIME</replaceable></option></arg>
 
119
      </group>
 
120
      <sbr/>
 
121
      <group>
 
122
        <arg choice="plain"><option>--interval
 
123
        <replaceable>TIME</replaceable></option></arg>
 
124
        <arg choice="plain"><option>-i
 
125
        <replaceable>TIME</replaceable></option></arg>
 
126
      </group>
 
127
      <sbr/>
 
128
      <group>
 
129
        <arg choice="plain"><option>--host
 
130
        <replaceable>STRING</replaceable></option></arg>
 
131
        <arg choice="plain"><option>-H
 
132
        <replaceable>STRING</replaceable></option></arg>
 
133
      </group>
 
134
      <sbr/>
 
135
      <group>
 
136
        <arg choice="plain"><option>--secret
 
137
        <replaceable>FILENAME</replaceable></option></arg>
 
138
        <arg choice="plain"><option>-s
 
139
        <replaceable>FILENAME</replaceable></option></arg>
 
140
      </group>
 
141
      <sbr/>
 
142
      <group>
 
143
        <arg choice="plain"><option>--approve</option></arg>
 
144
        <arg choice="plain"><option>-A</option></arg>
 
145
        <sbr/>
161
146
        <arg choice="plain"><option>--deny</option></arg>
162
147
        <arg choice="plain"><option>-D</option></arg>
163
148
      </group>
164
 
      <group choice="req">
165
 
          <arg choice="plain"><option>--remove</option></arg>
166
 
          <arg choice="plain"><option>-r</option></arg>
167
 
      </group>
 
149
      <sbr/>
168
150
      <group choice="req">
169
151
        <arg choice="plain"><option>--all</option></arg>
170
152
        <arg choice="plain"><option>-a</option></arg>
176
158
    <cmdsynopsis>
177
159
      <command>&COMMANDNAME;</command>
178
160
      <group>
179
 
          <arg choice="plain"><option>--verbose</option></arg>
180
 
          <arg choice="plain"><option>-v</option></arg>
181
 
          <sbr/>
182
 
          <arg choice="plain"><option>--dump-json</option></arg>
183
 
          <arg choice="plain"><option>-j</option></arg>
 
161
        <arg choice="plain"><option>--verbose</option></arg>
 
162
        <arg choice="plain"><option>-v</option></arg>
184
163
      </group>
185
164
      <group>
186
165
        <arg rep='repeat' choice='plain'>
210
189
        <arg choice="plain"><option>-v</option></arg>
211
190
      </group>
212
191
    </cmdsynopsis>
213
 
    <cmdsynopsis>
214
 
      <command>&COMMANDNAME;</command>
215
 
      <arg choice="plain"><option>--check</option></arg>
216
 
    </cmdsynopsis>
217
192
  </refsynopsisdiv>
218
193
  
219
194
  <refsect1 id="description">
220
195
    <title>DESCRIPTION</title>
221
196
    <para>
222
 
      <command>&COMMANDNAME;</command> is a program to control or
223
 
      query the operation of the Mandos server
224
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
225
 
      >8</manvolnum></citerefentry>.
 
197
      <command>&COMMANDNAME;</command> is a program to control the
 
198
      operation of the Mandos server <citerefentry><refentrytitle
 
199
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
226
200
    </para>
227
201
    <para>
228
202
      This program can be used to change client settings, approve or
344
318
          </para>
345
319
        </listitem>
346
320
      </varlistentry>
347
 
 
348
 
      <varlistentry>
349
 
        <term><option>--extended-timeout
350
 
        <replaceable>TIME</replaceable></option></term>
351
 
        <listitem>
352
 
          <para>
353
 
            Set the <varname>extended_timeout</varname> option of the
354
 
            specified client(s); see <citerefentry><refentrytitle
355
 
            >mandos-clients.conf</refentrytitle><manvolnum
356
 
            >5</manvolnum></citerefentry>.
357
 
          </para>
358
 
        </listitem>
359
 
      </varlistentry>
360
321
      
361
322
      <varlistentry>
362
323
        <term><option>--interval
486
447
      </varlistentry>
487
448
      
488
449
      <varlistentry>
489
 
        <term><option>--dump-json</option></term>
490
 
        <term><option>-j</option></term>
491
 
        <listitem>
492
 
          <para>
493
 
            Dump client settings as JSON to standard output.
494
 
          </para>
495
 
        </listitem>
496
 
      </varlistentry>
497
 
      
498
 
      <varlistentry>
499
450
        <term><option>--is-enabled</option></term>
500
451
        <term><option>-V</option></term>
501
452
        <listitem>
506
457
        </listitem>
507
458
      </varlistentry>
508
459
      
509
 
      <varlistentry>
510
 
        <term><option>--check</option></term>
511
 
        <listitem>
512
 
          <para>
513
 
            Run self-tests.  This includes any unit tests, etc.
514
 
          </para>
515
 
        </listitem>
516
 
      </varlistentry>
517
 
      
518
460
    </variablelist>
519
461
  </refsect1>
520
462
  
536
478
    </para>
537
479
  </refsect1>
538
480
  
539
 
  <refsect1 id="bugs">
540
 
    <title>BUGS</title>
541
 
    <xi:include href="bugs.xml"/>
542
 
  </refsect1>
 
481
<!--   <refsect1 id="bugs"> -->
 
482
<!--     <title>BUGS</title> -->
 
483
<!--     <para> -->
 
484
<!--     </para> -->
 
485
<!--   </refsect1> -->
543
486
  
544
487
  <refsect1 id="example">
545
488
    <title>EXAMPLE</title>
611
554
  <refsect1 id="see_also">
612
555
    <title>SEE ALSO</title>
613
556
    <para>
614
 
      <citerefentry><refentrytitle>intro</refentrytitle>
615
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
616
557
      <citerefentry><refentrytitle>mandos</refentrytitle>
617
558
      <manvolnum>8</manvolnum></citerefentry>,
618
559
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>