/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 Hogeborn
  • Date: 2019-03-06 22:24:59 UTC
  • Revision ID: teddy@recompile.se-20190306222459-7q5j7dqwtiiwglg7
mandos-ctl.xml: Fix documentation bug

* mandos-ctl.xml (SYNOPSIS): Remove duplicate "--interval" option.

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 "2011-02-27">
 
5
<!ENTITY TIMESTAMP "2019-03-06">
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@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.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@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.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>
36
44
      <holder>Teddy Hogeborn</holder>
37
45
      <holder>Björn Påhlsson</holder>
38
46
    </copyright>
47
55
  <refnamediv>
48
56
    <refname><command>&COMMANDNAME;</command></refname>
49
57
    <refpurpose>
50
 
      Control the operation of the Mandos server
 
58
      Control or query the operation of the Mandos server
51
59
    </refpurpose>
52
60
  </refnamediv>
53
61
  
54
62
  <refsynopsisdiv>
55
63
    <cmdsynopsis>
56
64
      <command>&COMMANDNAME;</command>
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/>
146
 
        <arg choice="plain"><option>--deny</option></arg>
147
 
        <arg choice="plain"><option>-D</option></arg>
 
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
        </group>
 
82
        <sbr/>
 
83
        <group>
 
84
          <arg choice="plain"><option>--stop-checker</option></arg>
 
85
        </group>
 
86
        <sbr/>
 
87
        <group>
 
88
          <arg choice="plain"><option>--remove</option></arg>
 
89
          <arg choice="plain"><option>-r</option></arg>
 
90
        </group>
 
91
        <sbr/>
 
92
        <group>
 
93
          <arg choice="plain"><option>--checker
 
94
          <replaceable>COMMAND</replaceable></option></arg>
 
95
          <arg choice="plain"><option>-c
 
96
          <replaceable>COMMAND</replaceable></option></arg>
 
97
        </group>
 
98
        <sbr/>
 
99
        <group>
 
100
          <arg choice="plain"><option>--timeout
 
101
          <replaceable>TIME</replaceable></option></arg>
 
102
          <arg choice="plain"><option>-t
 
103
          <replaceable>TIME</replaceable></option></arg>
 
104
        </group>
 
105
        <sbr/>
 
106
        <group>
 
107
          <arg choice="plain"><option>--extended-timeout
 
108
          <replaceable>TIME</replaceable></option></arg>
 
109
        </group>
 
110
        <sbr/>
 
111
        <group>
 
112
          <arg choice="plain"><option>--interval
 
113
          <replaceable>TIME</replaceable></option></arg>
 
114
          <arg choice="plain"><option>-i
 
115
          <replaceable>TIME</replaceable></option></arg>
 
116
        </group>
 
117
        <sbr/>
 
118
        <group>
 
119
          <arg choice="plain"><option>--approve-by-default</option
 
120
          ></arg>
 
121
          <sbr/>
 
122
          <arg choice="plain"><option>--deny-by-default</option></arg>
 
123
        </group>
 
124
        <sbr/>
 
125
        <group>
 
126
          <arg choice="plain"><option>--approval-delay
 
127
          <replaceable>TIME</replaceable></option></arg>
 
128
        </group>
 
129
        <sbr/>
 
130
        <group>
 
131
          <arg choice="plain"><option>--approval-duration
 
132
          <replaceable>TIME</replaceable></option></arg>
 
133
        </group>
 
134
        <sbr/>
 
135
        <group>
 
136
          <arg choice="plain"><option>--host
 
137
          <replaceable>STRING</replaceable></option></arg>
 
138
          <arg choice="plain"><option>-H
 
139
          <replaceable>STRING</replaceable></option></arg>
 
140
        </group>
 
141
        <sbr/>
 
142
        <group>
 
143
          <arg choice="plain"><option>--secret
 
144
          <replaceable>FILENAME</replaceable></option></arg>
 
145
          <arg choice="plain"><option>-s
 
146
          <replaceable>FILENAME</replaceable></option></arg>
 
147
        </group>
 
148
        <sbr/>
 
149
        <group>
 
150
          <arg choice="plain"><option>--approve</option></arg>
 
151
          <arg choice="plain"><option>-A</option></arg>
 
152
          <sbr/>
 
153
          <arg choice="plain"><option>--deny</option></arg>
 
154
          <arg choice="plain"><option>-D</option></arg>
 
155
        </group>
148
156
      </group>
149
157
      <sbr/>
150
158
      <group choice="req">
158
166
    <cmdsynopsis>
159
167
      <command>&COMMANDNAME;</command>
160
168
      <group>
161
 
        <arg choice="plain"><option>--verbose</option></arg>
162
 
        <arg choice="plain"><option>-v</option></arg>
 
169
          <arg choice="plain"><option>--verbose</option></arg>
 
170
          <arg choice="plain"><option>-v</option></arg>
 
171
          <sbr/>
 
172
          <arg choice="plain"><option>--dump-json</option></arg>
 
173
          <arg choice="plain"><option>-j</option></arg>
163
174
      </group>
164
175
      <group>
165
176
        <arg rep='repeat' choice='plain'>
189
200
        <arg choice="plain"><option>-v</option></arg>
190
201
      </group>
191
202
    </cmdsynopsis>
 
203
    <cmdsynopsis>
 
204
      <command>&COMMANDNAME;</command>
 
205
      <arg choice="plain"><option>--check</option></arg>
 
206
    </cmdsynopsis>
192
207
  </refsynopsisdiv>
193
208
  
194
209
  <refsect1 id="description">
195
210
    <title>DESCRIPTION</title>
196
211
    <para>
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>.
 
212
      <command>&COMMANDNAME;</command> is a program to control or
 
213
      query the operation of the Mandos server
 
214
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
215
      >8</manvolnum></citerefentry>.
200
216
    </para>
201
217
    <para>
202
218
      This program can be used to change client settings, approve or
318
334
          </para>
319
335
        </listitem>
320
336
      </varlistentry>
 
337
 
 
338
      <varlistentry>
 
339
        <term><option>--extended-timeout
 
340
        <replaceable>TIME</replaceable></option></term>
 
341
        <listitem>
 
342
          <para>
 
343
            Set the <varname>extended_timeout</varname> option of the
 
344
            specified client(s); see <citerefentry><refentrytitle
 
345
            >mandos-clients.conf</refentrytitle><manvolnum
 
346
            >5</manvolnum></citerefentry>.
 
347
          </para>
 
348
        </listitem>
 
349
      </varlistentry>
321
350
      
322
351
      <varlistentry>
323
352
        <term><option>--interval
447
476
      </varlistentry>
448
477
      
449
478
      <varlistentry>
 
479
        <term><option>--dump-json</option></term>
 
480
        <term><option>-j</option></term>
 
481
        <listitem>
 
482
          <para>
 
483
            Dump client settings as JSON to standard output.
 
484
          </para>
 
485
        </listitem>
 
486
      </varlistentry>
 
487
      
 
488
      <varlistentry>
450
489
        <term><option>--is-enabled</option></term>
451
490
        <term><option>-V</option></term>
452
491
        <listitem>
457
496
        </listitem>
458
497
      </varlistentry>
459
498
      
 
499
      <varlistentry>
 
500
        <term><option>--check</option></term>
 
501
        <listitem>
 
502
          <para>
 
503
            Run self-tests.  This includes any unit tests, etc.
 
504
          </para>
 
505
        </listitem>
 
506
      </varlistentry>
 
507
      
460
508
    </variablelist>
461
509
  </refsect1>
462
510
  
478
526
    </para>
479
527
  </refsect1>
480
528
  
481
 
<!--   <refsect1 id="bugs"> -->
482
 
<!--     <title>BUGS</title> -->
483
 
<!--     <para> -->
484
 
<!--     </para> -->
485
 
<!--   </refsect1> -->
 
529
  <refsect1 id="bugs">
 
530
    <title>BUGS</title>
 
531
    <xi:include href="bugs.xml"/>
 
532
  </refsect1>
486
533
  
487
534
  <refsect1 id="example">
488
535
    <title>EXAMPLE</title>
554
601
  <refsect1 id="see_also">
555
602
    <title>SEE ALSO</title>
556
603
    <para>
 
604
      <citerefentry><refentrytitle>intro</refentrytitle>
 
605
      <manvolnum>8mandos</manvolnum></citerefentry>,
557
606
      <citerefentry><refentrytitle>mandos</refentrytitle>
558
607
      <manvolnum>8</manvolnum></citerefentry>,
559
608
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>