/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-07 21:38:47 UTC
  • Revision ID: teddy@recompile.se-20190307213847-9ans204sp9s3ki1s
mandos-ctl.xml: Move most normal command to top of synopsis

* mandos-ctl.xml (SYNOPSIS): Move --verbose | --dump-json to top.

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-10-03">
 
5
<!ENTITY TIMESTAMP "2019-03-07">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
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
  
55
63
    <cmdsynopsis>
56
64
      <command>&COMMANDNAME;</command>
57
65
      <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>--extended-timeout
99
 
        <replaceable>TIME</replaceable></option></arg>
100
 
      </group>
101
 
      <sbr/>
102
 
      <group>
103
 
        <arg choice="plain"><option>--interval
104
 
        <replaceable>TIME</replaceable></option></arg>
105
 
        <arg choice="plain"><option>-i
106
 
        <replaceable>TIME</replaceable></option></arg>
107
 
      </group>
108
 
      <sbr/>
109
 
      <group>
110
 
        <arg choice="plain"><option>--approve-by-default</option
111
 
        ></arg>
112
 
        <sbr/>
113
 
        <arg choice="plain"><option>--deny-by-default</option></arg>
114
 
      </group>
115
 
      <sbr/>
116
 
      <group>
117
 
        <arg choice="plain"><option>--approval-delay
118
 
        <replaceable>TIME</replaceable></option></arg>
119
 
      </group>
120
 
      <sbr/>
121
 
      <group>
122
 
        <arg choice="plain"><option>--approval-duration
123
 
        <replaceable>TIME</replaceable></option></arg>
124
 
      </group>
125
 
      <sbr/>
126
 
      <group>
127
 
        <arg choice="plain"><option>--interval
128
 
        <replaceable>TIME</replaceable></option></arg>
129
 
        <arg choice="plain"><option>-i
130
 
        <replaceable>TIME</replaceable></option></arg>
131
 
      </group>
132
 
      <sbr/>
133
 
      <group>
134
 
        <arg choice="plain"><option>--host
135
 
        <replaceable>STRING</replaceable></option></arg>
136
 
        <arg choice="plain"><option>-H
137
 
        <replaceable>STRING</replaceable></option></arg>
138
 
      </group>
139
 
      <sbr/>
140
 
      <group>
141
 
        <arg choice="plain"><option>--secret
142
 
        <replaceable>FILENAME</replaceable></option></arg>
143
 
        <arg choice="plain"><option>-s
144
 
        <replaceable>FILENAME</replaceable></option></arg>
145
 
      </group>
146
 
      <sbr/>
147
 
      <group>
148
 
        <arg choice="plain"><option>--approve</option></arg>
149
 
        <arg choice="plain"><option>-A</option></arg>
150
 
        <sbr/>
 
66
          <arg choice="plain"><option>--verbose</option></arg>
 
67
          <arg choice="plain"><option>-v</option></arg>
 
68
          <sbr/>
 
69
          <arg choice="plain"><option>--dump-json</option></arg>
 
70
          <arg choice="plain"><option>-j</option></arg>
 
71
      </group>
 
72
      <group>
 
73
        <arg rep='repeat' choice='plain'>
 
74
          <replaceable>CLIENT</replaceable>
 
75
        </arg>
 
76
      </group>
 
77
    </cmdsynopsis>
 
78
    <cmdsynopsis>
 
79
      <command>&COMMANDNAME;</command>
 
80
      <group choice="req">
 
81
        <group>
 
82
          <arg choice="plain"><option>--enable</option></arg>
 
83
          <arg choice="plain"><option>-e</option></arg>
 
84
          <sbr/>
 
85
          <arg choice="plain"><option>--disable</option></arg>
 
86
          <arg choice="plain"><option>-d</option></arg>
 
87
        </group>
 
88
        <sbr/>
 
89
        <group>
 
90
          <arg choice="plain"><option>--bump-timeout</option></arg>
 
91
          <arg choice="plain"><option>-b</option></arg>
 
92
        </group>
 
93
        <sbr/>
 
94
        <group>
 
95
          <arg choice="plain"><option>--start-checker</option></arg>
 
96
          <arg choice="plain"><option>--stop-checker</option></arg>
 
97
        </group>
 
98
        <sbr/>
 
99
        <group>
 
100
          <arg choice="plain"><option>--checker
 
101
          <replaceable>COMMAND</replaceable></option></arg>
 
102
          <arg choice="plain"><option>-c
 
103
          <replaceable>COMMAND</replaceable></option></arg>
 
104
        </group>
 
105
        <sbr/>
 
106
        <group>
 
107
          <arg choice="plain"><option>--timeout
 
108
          <replaceable>TIME</replaceable></option></arg>
 
109
          <arg choice="plain"><option>-t
 
110
          <replaceable>TIME</replaceable></option></arg>
 
111
        </group>
 
112
        <sbr/>
 
113
        <group>
 
114
          <arg choice="plain"><option>--extended-timeout
 
115
          <replaceable>TIME</replaceable></option></arg>
 
116
        </group>
 
117
        <sbr/>
 
118
        <group>
 
119
          <arg choice="plain"><option>--interval
 
120
          <replaceable>TIME</replaceable></option></arg>
 
121
          <arg choice="plain"><option>-i
 
122
          <replaceable>TIME</replaceable></option></arg>
 
123
        </group>
 
124
        <sbr/>
 
125
        <group>
 
126
          <arg choice="plain"><option>--approve-by-default</option
 
127
          ></arg>
 
128
          <sbr/>
 
129
          <arg choice="plain"><option>--deny-by-default</option></arg>
 
130
        </group>
 
131
        <sbr/>
 
132
        <group>
 
133
          <arg choice="plain"><option>--approval-delay
 
134
          <replaceable>TIME</replaceable></option></arg>
 
135
        </group>
 
136
        <sbr/>
 
137
        <group>
 
138
          <arg choice="plain"><option>--approval-duration
 
139
          <replaceable>TIME</replaceable></option></arg>
 
140
        </group>
 
141
        <sbr/>
 
142
        <group>
 
143
          <arg choice="plain"><option>--host
 
144
          <replaceable>STRING</replaceable></option></arg>
 
145
          <arg choice="plain"><option>-H
 
146
          <replaceable>STRING</replaceable></option></arg>
 
147
        </group>
 
148
        <sbr/>
 
149
        <group>
 
150
          <arg choice="plain"><option>--secret
 
151
          <replaceable>FILENAME</replaceable></option></arg>
 
152
          <arg choice="plain"><option>-s
 
153
          <replaceable>FILENAME</replaceable></option></arg>
 
154
        </group>
 
155
        <sbr/>
 
156
        <group>
 
157
          <arg choice="plain"><option>--approve</option></arg>
 
158
          <arg choice="plain"><option>-A</option></arg>
 
159
          <sbr/>
 
160
          <arg choice="plain"><option>--deny</option></arg>
 
161
          <arg choice="plain"><option>-D</option></arg>
 
162
        </group>
 
163
      </group>
 
164
      <sbr/>
 
165
      <group choice="req">
 
166
        <arg choice="plain"><option>--all</option></arg>
 
167
        <arg choice="plain"><option>-a</option></arg>
 
168
        <arg rep='repeat' choice='plain'>
 
169
          <replaceable>CLIENT</replaceable>
 
170
        </arg>
 
171
      </group>
 
172
    </cmdsynopsis>
 
173
    <cmdsynopsis>
 
174
      <command>&COMMANDNAME;</command>
 
175
      <group>
151
176
        <arg choice="plain"><option>--deny</option></arg>
152
177
        <arg choice="plain"><option>-D</option></arg>
153
178
      </group>
154
 
      <sbr/>
 
179
      <group choice="req">
 
180
          <arg choice="plain"><option>--remove</option></arg>
 
181
          <arg choice="plain"><option>-r</option></arg>
 
182
      </group>
155
183
      <group choice="req">
156
184
        <arg choice="plain"><option>--all</option></arg>
157
185
        <arg choice="plain"><option>-a</option></arg>
162
190
    </cmdsynopsis>
163
191
    <cmdsynopsis>
164
192
      <command>&COMMANDNAME;</command>
165
 
      <group>
166
 
        <arg choice="plain"><option>--verbose</option></arg>
167
 
        <arg choice="plain"><option>-v</option></arg>
168
 
      </group>
169
 
      <group>
170
 
        <arg rep='repeat' choice='plain'>
171
 
          <replaceable>CLIENT</replaceable>
172
 
        </arg>
173
 
      </group>
174
 
    </cmdsynopsis>
175
 
    <cmdsynopsis>
176
 
      <command>&COMMANDNAME;</command>
177
193
      <group choice="req">
178
194
        <arg choice="plain"><option>--is-enabled</option></arg>
179
195
        <arg choice="plain"><option>-V</option></arg>
194
210
        <arg choice="plain"><option>-v</option></arg>
195
211
      </group>
196
212
    </cmdsynopsis>
 
213
    <cmdsynopsis>
 
214
      <command>&COMMANDNAME;</command>
 
215
      <arg choice="plain"><option>--check</option></arg>
 
216
    </cmdsynopsis>
197
217
  </refsynopsisdiv>
198
218
  
199
219
  <refsect1 id="description">
200
220
    <title>DESCRIPTION</title>
201
221
    <para>
202
 
      <command>&COMMANDNAME;</command> is a program to control the
203
 
      operation of the Mandos server <citerefentry><refentrytitle
204
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
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>.
205
226
    </para>
206
227
    <para>
207
228
      This program can be used to change client settings, approve or
465
486
      </varlistentry>
466
487
      
467
488
      <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>
468
499
        <term><option>--is-enabled</option></term>
469
500
        <term><option>-V</option></term>
470
501
        <listitem>
475
506
        </listitem>
476
507
      </varlistentry>
477
508
      
 
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
      
478
518
    </variablelist>
479
519
  </refsect1>
480
520
  
496
536
    </para>
497
537
  </refsect1>
498
538
  
499
 
<!--   <refsect1 id="bugs"> -->
500
 
<!--     <title>BUGS</title> -->
501
 
<!--     <para> -->
502
 
<!--     </para> -->
503
 
<!--   </refsect1> -->
 
539
  <refsect1 id="bugs">
 
540
    <title>BUGS</title>
 
541
    <xi:include href="bugs.xml"/>
 
542
  </refsect1>
504
543
  
505
544
  <refsect1 id="example">
506
545
    <title>EXAMPLE</title>