/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:37:10 UTC
  • Revision ID: teddy@recompile.se-20190307213710-brbbpkpqxcq8e444
mandos-ctl.xml: Clarify the conflicting nature of some options

* mandos-ctl.xml (SYNOPSIS): Show --start-checker and --stop-checker
                             as mutually exclusive.  Show --remove as
                             incompatible with everything except
                             --deny.

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-03-05">
 
5
<!ENTITY TIMESTAMP "2019-03-07">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
38
38
      <year>2014</year>
39
39
      <year>2015</year>
40
40
      <year>2016</year>
 
41
      <year>2017</year>
 
42
      <year>2018</year>
 
43
      <year>2019</year>
41
44
      <holder>Teddy Hogeborn</holder>
42
45
      <holder>Björn Påhlsson</holder>
43
46
    </copyright>
52
55
  <refnamediv>
53
56
    <refname><command>&COMMANDNAME;</command></refname>
54
57
    <refpurpose>
55
 
      Control the operation of the Mandos server
 
58
      Control or query the operation of the Mandos server
56
59
    </refpurpose>
57
60
  </refnamediv>
58
61
  
59
62
  <refsynopsisdiv>
60
63
    <cmdsynopsis>
61
64
      <command>&COMMANDNAME;</command>
62
 
      <group>
63
 
        <arg choice="plain"><option>--enable</option></arg>
64
 
        <arg choice="plain"><option>-e</option></arg>
65
 
        <sbr/>
66
 
        <arg choice="plain"><option>--disable</option></arg>
67
 
        <arg choice="plain"><option>-d</option></arg>
68
 
      </group>
69
 
      <sbr/>
70
 
      <group>
71
 
        <arg choice="plain"><option>--bump-timeout</option></arg>
72
 
        <arg choice="plain"><option>-b</option></arg>
73
 
      </group>
74
 
      <sbr/>
75
 
      <group>
76
 
        <arg choice="plain"><option>--start-checker</option></arg>
77
 
      </group>
78
 
      <sbr/>
79
 
      <group>
80
 
        <arg choice="plain"><option>--stop-checker</option></arg>
81
 
      </group>
82
 
      <sbr/>
83
 
      <group>
84
 
        <arg choice="plain"><option>--remove</option></arg>
85
 
        <arg choice="plain"><option>-r</option></arg>
86
 
      </group>
87
 
      <sbr/>
88
 
      <group>
89
 
        <arg choice="plain"><option>--checker
90
 
        <replaceable>COMMAND</replaceable></option></arg>
91
 
        <arg choice="plain"><option>-c
92
 
        <replaceable>COMMAND</replaceable></option></arg>
93
 
      </group>
94
 
      <sbr/>
95
 
      <group>
96
 
        <arg choice="plain"><option>--timeout
97
 
        <replaceable>TIME</replaceable></option></arg>
98
 
        <arg choice="plain"><option>-t
99
 
        <replaceable>TIME</replaceable></option></arg>
100
 
      </group>
101
 
      <sbr/>
102
 
      <group>
103
 
        <arg choice="plain"><option>--extended-timeout
104
 
        <replaceable>TIME</replaceable></option></arg>
105
 
      </group>
106
 
      <sbr/>
107
 
      <group>
108
 
        <arg choice="plain"><option>--interval
109
 
        <replaceable>TIME</replaceable></option></arg>
110
 
        <arg choice="plain"><option>-i
111
 
        <replaceable>TIME</replaceable></option></arg>
112
 
      </group>
113
 
      <sbr/>
114
 
      <group>
115
 
        <arg choice="plain"><option>--approve-by-default</option
116
 
        ></arg>
117
 
        <sbr/>
118
 
        <arg choice="plain"><option>--deny-by-default</option></arg>
119
 
      </group>
120
 
      <sbr/>
121
 
      <group>
122
 
        <arg choice="plain"><option>--approval-delay
123
 
        <replaceable>TIME</replaceable></option></arg>
124
 
      </group>
125
 
      <sbr/>
126
 
      <group>
127
 
        <arg choice="plain"><option>--approval-duration
128
 
        <replaceable>TIME</replaceable></option></arg>
129
 
      </group>
130
 
      <sbr/>
131
 
      <group>
132
 
        <arg choice="plain"><option>--interval
133
 
        <replaceable>TIME</replaceable></option></arg>
134
 
        <arg choice="plain"><option>-i
135
 
        <replaceable>TIME</replaceable></option></arg>
136
 
      </group>
137
 
      <sbr/>
138
 
      <group>
139
 
        <arg choice="plain"><option>--host
140
 
        <replaceable>STRING</replaceable></option></arg>
141
 
        <arg choice="plain"><option>-H
142
 
        <replaceable>STRING</replaceable></option></arg>
143
 
      </group>
144
 
      <sbr/>
145
 
      <group>
146
 
        <arg choice="plain"><option>--secret
147
 
        <replaceable>FILENAME</replaceable></option></arg>
148
 
        <arg choice="plain"><option>-s
149
 
        <replaceable>FILENAME</replaceable></option></arg>
150
 
      </group>
151
 
      <sbr/>
152
 
      <group>
153
 
        <arg choice="plain"><option>--approve</option></arg>
154
 
        <arg choice="plain"><option>-A</option></arg>
155
 
        <sbr/>
 
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>
156
161
        <arg choice="plain"><option>--deny</option></arg>
157
162
        <arg choice="plain"><option>-D</option></arg>
158
163
      </group>
159
 
      <sbr/>
 
164
      <group choice="req">
 
165
          <arg choice="plain"><option>--remove</option></arg>
 
166
          <arg choice="plain"><option>-r</option></arg>
 
167
      </group>
160
168
      <group choice="req">
161
169
        <arg choice="plain"><option>--all</option></arg>
162
170
        <arg choice="plain"><option>-a</option></arg>
168
176
    <cmdsynopsis>
169
177
      <command>&COMMANDNAME;</command>
170
178
      <group>
171
 
        <arg choice="plain"><option>--verbose</option></arg>
172
 
        <arg choice="plain"><option>-v</option></arg>
 
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>
173
184
      </group>
174
185
      <group>
175
186
        <arg rep='repeat' choice='plain'>
208
219
  <refsect1 id="description">
209
220
    <title>DESCRIPTION</title>
210
221
    <para>
211
 
      <command>&COMMANDNAME;</command> is a program to control the
212
 
      operation of the Mandos server <citerefentry><refentrytitle
213
 
      >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>.
214
226
    </para>
215
227
    <para>
216
228
      This program can be used to change client settings, approve or
474
486
      </varlistentry>
475
487
      
476
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>
477
499
        <term><option>--is-enabled</option></term>
478
500
        <term><option>-V</option></term>
479
501
        <listitem>