/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

  • Committer: Teddy Hogeborn
  • Date: 2019-03-07 21:37:10 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 382.
  • 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 "2012-01-01">
 
5
<!ENTITY TIMESTAMP "2019-03-07">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
34
34
      <year>2010</year>
35
35
      <year>2011</year>
36
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>
37
44
      <holder>Teddy Hogeborn</holder>
38
45
      <holder>Björn Påhlsson</holder>
39
46
    </copyright>
48
55
  <refnamediv>
49
56
    <refname><command>&COMMANDNAME;</command></refname>
50
57
    <refpurpose>
51
 
      Control the operation of the Mandos server
 
58
      Control or query the operation of the Mandos server
52
59
    </refpurpose>
53
60
  </refnamediv>
54
61
  
55
62
  <refsynopsisdiv>
56
63
    <cmdsynopsis>
57
64
      <command>&COMMANDNAME;</command>
58
 
      <group>
59
 
        <arg choice="plain"><option>--enable</option></arg>
60
 
        <arg choice="plain"><option>-e</option></arg>
61
 
        <sbr/>
62
 
        <arg choice="plain"><option>--disable</option></arg>
63
 
        <arg choice="plain"><option>-d</option></arg>
64
 
      </group>
65
 
      <sbr/>
66
 
      <group>
67
 
        <arg choice="plain"><option>--bump-timeout</option></arg>
68
 
        <arg choice="plain"><option>-b</option></arg>
69
 
      </group>
70
 
      <sbr/>
71
 
      <group>
72
 
        <arg choice="plain"><option>--start-checker</option></arg>
73
 
      </group>
74
 
      <sbr/>
75
 
      <group>
76
 
        <arg choice="plain"><option>--stop-checker</option></arg>
77
 
      </group>
78
 
      <sbr/>
79
 
      <group>
80
 
        <arg choice="plain"><option>--remove</option></arg>
81
 
        <arg choice="plain"><option>-r</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>--interval
129
 
        <replaceable>TIME</replaceable></option></arg>
130
 
        <arg choice="plain"><option>-i
131
 
        <replaceable>TIME</replaceable></option></arg>
132
 
      </group>
133
 
      <sbr/>
134
 
      <group>
135
 
        <arg choice="plain"><option>--host
136
 
        <replaceable>STRING</replaceable></option></arg>
137
 
        <arg choice="plain"><option>-H
138
 
        <replaceable>STRING</replaceable></option></arg>
139
 
      </group>
140
 
      <sbr/>
141
 
      <group>
142
 
        <arg choice="plain"><option>--secret
143
 
        <replaceable>FILENAME</replaceable></option></arg>
144
 
        <arg choice="plain"><option>-s
145
 
        <replaceable>FILENAME</replaceable></option></arg>
146
 
      </group>
147
 
      <sbr/>
148
 
      <group>
149
 
        <arg choice="plain"><option>--approve</option></arg>
150
 
        <arg choice="plain"><option>-A</option></arg>
151
 
        <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>
152
161
        <arg choice="plain"><option>--deny</option></arg>
153
162
        <arg choice="plain"><option>-D</option></arg>
154
163
      </group>
155
 
      <sbr/>
 
164
      <group choice="req">
 
165
          <arg choice="plain"><option>--remove</option></arg>
 
166
          <arg choice="plain"><option>-r</option></arg>
 
167
      </group>
156
168
      <group choice="req">
157
169
        <arg choice="plain"><option>--all</option></arg>
158
170
        <arg choice="plain"><option>-a</option></arg>
164
176
    <cmdsynopsis>
165
177
      <command>&COMMANDNAME;</command>
166
178
      <group>
167
 
        <arg choice="plain"><option>--verbose</option></arg>
168
 
        <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>
169
184
      </group>
170
185
      <group>
171
186
        <arg rep='repeat' choice='plain'>
195
210
        <arg choice="plain"><option>-v</option></arg>
196
211
      </group>
197
212
    </cmdsynopsis>
 
213
    <cmdsynopsis>
 
214
      <command>&COMMANDNAME;</command>
 
215
      <arg choice="plain"><option>--check</option></arg>
 
216
    </cmdsynopsis>
198
217
  </refsynopsisdiv>
199
218
  
200
219
  <refsect1 id="description">
201
220
    <title>DESCRIPTION</title>
202
221
    <para>
203
 
      <command>&COMMANDNAME;</command> is a program to control the
204
 
      operation of the Mandos server <citerefentry><refentrytitle
205
 
      >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>.
206
226
    </para>
207
227
    <para>
208
228
      This program can be used to change client settings, approve or
466
486
      </varlistentry>
467
487
      
468
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>
469
499
        <term><option>--is-enabled</option></term>
470
500
        <term><option>-V</option></term>
471
501
        <listitem>
476
506
        </listitem>
477
507
      </varlistentry>
478
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
      
479
518
    </variablelist>
480
519
  </refsect1>
481
520
  
497
536
    </para>
498
537
  </refsect1>
499
538
  
500
 
<!--   <refsect1 id="bugs"> -->
501
 
<!--     <title>BUGS</title> -->
502
 
<!--     <para> -->
503
 
<!--     </para> -->
504
 
<!--   </refsect1> -->
 
539
  <refsect1 id="bugs">
 
540
    <title>BUGS</title>
 
541
    <xi:include href="bugs.xml"/>
 
542
  </refsect1>
505
543
  
506
544
  <refsect1 id="example">
507
545
    <title>EXAMPLE</title>