/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: 2015-10-24 17:37:16 UTC
  • mfrom: (790 trunk)
  • mto: This revision was merged to the branch mainline in revision 791.
  • Revision ID: teddy@recompile.se-20151024173716-cmst924xz22yq58z
Merge from trunk.

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 "2019-03-07">
 
5
<!ENTITY TIMESTAMP "2015-07-20">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
37
37
      <year>2013</year>
38
38
      <year>2014</year>
39
39
      <year>2015</year>
40
 
      <year>2016</year>
41
 
      <year>2017</year>
42
 
      <year>2018</year>
43
 
      <year>2019</year>
44
40
      <holder>Teddy Hogeborn</holder>
45
41
      <holder>Björn Påhlsson</holder>
46
42
    </copyright>
55
51
  <refnamediv>
56
52
    <refname><command>&COMMANDNAME;</command></refname>
57
53
    <refpurpose>
58
 
      Control or query the operation of the Mandos server
 
54
      Control the operation of the Mandos server
59
55
    </refpurpose>
60
56
  </refnamediv>
61
57
  
63
59
    <cmdsynopsis>
64
60
      <command>&COMMANDNAME;</command>
65
61
      <group>
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>
 
62
        <arg choice="plain"><option>--enable</option></arg>
 
63
        <arg choice="plain"><option>-e</option></arg>
 
64
        <sbr/>
 
65
        <arg choice="plain"><option>--disable</option></arg>
 
66
        <arg choice="plain"><option>-d</option></arg>
 
67
      </group>
 
68
      <sbr/>
 
69
      <group>
 
70
        <arg choice="plain"><option>--bump-timeout</option></arg>
 
71
        <arg choice="plain"><option>-b</option></arg>
 
72
      </group>
 
73
      <sbr/>
 
74
      <group>
 
75
        <arg choice="plain"><option>--start-checker</option></arg>
 
76
      </group>
 
77
      <sbr/>
 
78
      <group>
 
79
        <arg choice="plain"><option>--stop-checker</option></arg>
 
80
      </group>
 
81
      <sbr/>
 
82
      <group>
 
83
        <arg choice="plain"><option>--remove</option></arg>
 
84
        <arg choice="plain"><option>-r</option></arg>
 
85
      </group>
 
86
      <sbr/>
 
87
      <group>
 
88
        <arg choice="plain"><option>--checker
 
89
        <replaceable>COMMAND</replaceable></option></arg>
 
90
        <arg choice="plain"><option>-c
 
91
        <replaceable>COMMAND</replaceable></option></arg>
 
92
      </group>
 
93
      <sbr/>
 
94
      <group>
 
95
        <arg choice="plain"><option>--timeout
 
96
        <replaceable>TIME</replaceable></option></arg>
 
97
        <arg choice="plain"><option>-t
 
98
        <replaceable>TIME</replaceable></option></arg>
 
99
      </group>
 
100
      <sbr/>
 
101
      <group>
 
102
        <arg choice="plain"><option>--extended-timeout
 
103
        <replaceable>TIME</replaceable></option></arg>
 
104
      </group>
 
105
      <sbr/>
 
106
      <group>
 
107
        <arg choice="plain"><option>--interval
 
108
        <replaceable>TIME</replaceable></option></arg>
 
109
        <arg choice="plain"><option>-i
 
110
        <replaceable>TIME</replaceable></option></arg>
 
111
      </group>
 
112
      <sbr/>
 
113
      <group>
 
114
        <arg choice="plain"><option>--approve-by-default</option
 
115
        ></arg>
 
116
        <sbr/>
 
117
        <arg choice="plain"><option>--deny-by-default</option></arg>
 
118
      </group>
 
119
      <sbr/>
 
120
      <group>
 
121
        <arg choice="plain"><option>--approval-delay
 
122
        <replaceable>TIME</replaceable></option></arg>
 
123
      </group>
 
124
      <sbr/>
 
125
      <group>
 
126
        <arg choice="plain"><option>--approval-duration
 
127
        <replaceable>TIME</replaceable></option></arg>
 
128
      </group>
 
129
      <sbr/>
 
130
      <group>
 
131
        <arg choice="plain"><option>--interval
 
132
        <replaceable>TIME</replaceable></option></arg>
 
133
        <arg choice="plain"><option>-i
 
134
        <replaceable>TIME</replaceable></option></arg>
 
135
      </group>
 
136
      <sbr/>
 
137
      <group>
 
138
        <arg choice="plain"><option>--host
 
139
        <replaceable>STRING</replaceable></option></arg>
 
140
        <arg choice="plain"><option>-H
 
141
        <replaceable>STRING</replaceable></option></arg>
 
142
      </group>
 
143
      <sbr/>
 
144
      <group>
 
145
        <arg choice="plain"><option>--secret
 
146
        <replaceable>FILENAME</replaceable></option></arg>
 
147
        <arg choice="plain"><option>-s
 
148
        <replaceable>FILENAME</replaceable></option></arg>
 
149
      </group>
 
150
      <sbr/>
 
151
      <group>
 
152
        <arg choice="plain"><option>--approve</option></arg>
 
153
        <arg choice="plain"><option>-A</option></arg>
 
154
        <sbr/>
176
155
        <arg choice="plain"><option>--deny</option></arg>
177
156
        <arg choice="plain"><option>-D</option></arg>
178
157
      </group>
179
 
      <group choice="req">
180
 
          <arg choice="plain"><option>--remove</option></arg>
181
 
          <arg choice="plain"><option>-r</option></arg>
182
 
      </group>
 
158
      <sbr/>
183
159
      <group choice="req">
184
160
        <arg choice="plain"><option>--all</option></arg>
185
161
        <arg choice="plain"><option>-a</option></arg>
190
166
    </cmdsynopsis>
191
167
    <cmdsynopsis>
192
168
      <command>&COMMANDNAME;</command>
 
169
      <group>
 
170
        <arg choice="plain"><option>--verbose</option></arg>
 
171
        <arg choice="plain"><option>-v</option></arg>
 
172
      </group>
 
173
      <group>
 
174
        <arg rep='repeat' choice='plain'>
 
175
          <replaceable>CLIENT</replaceable>
 
176
        </arg>
 
177
      </group>
 
178
    </cmdsynopsis>
 
179
    <cmdsynopsis>
 
180
      <command>&COMMANDNAME;</command>
193
181
      <group choice="req">
194
182
        <arg choice="plain"><option>--is-enabled</option></arg>
195
183
        <arg choice="plain"><option>-V</option></arg>
219
207
  <refsect1 id="description">
220
208
    <title>DESCRIPTION</title>
221
209
    <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>.
 
210
      <command>&COMMANDNAME;</command> is a program to control the
 
211
      operation of the Mandos server <citerefentry><refentrytitle
 
212
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
226
213
    </para>
227
214
    <para>
228
215
      This program can be used to change client settings, approve or
486
473
      </varlistentry>
487
474
      
488
475
      <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
476
        <term><option>--is-enabled</option></term>
500
477
        <term><option>-V</option></term>
501
478
        <listitem>
536
513
    </para>
537
514
  </refsect1>
538
515
  
539
 
  <refsect1 id="bugs">
540
 
    <title>BUGS</title>
541
 
    <xi:include href="bugs.xml"/>
542
 
  </refsect1>
 
516
<!--   <refsect1 id="bugs"> -->
 
517
<!--     <title>BUGS</title> -->
 
518
<!--     <para> -->
 
519
<!--     </para> -->
 
520
<!--   </refsect1> -->
543
521
  
544
522
  <refsect1 id="example">
545
523
    <title>EXAMPLE</title>
584
562
      <para>
585
563
 
586
564
<!-- do not wrap this line -->
587
 
<userinput>&COMMANDNAME; --timeout="PT5M" --interval="PT1M" foo1.example.org foo2.example.org</userinput>
 
565
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
588
566
 
589
567
      </para>
590
568
    </informalexample>