/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: 2016-10-08 04:33:04 UTC
  • Revision ID: teddy@recompile.se-20161008043304-u4wqp55iacqfbwhb
Tags: version-1.7.13-1
* Makefile (version): Change to 1.7.13.
* NEWS (Version 1.7.13): Add new entry.
* debian/changelog (1.7.13-1): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-08-08">
 
5
<!ENTITY TIMESTAMP "2016-06-27">
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>
36
41
      <holder>Teddy Hogeborn</holder>
37
42
      <holder>Björn Påhlsson</holder>
38
43
    </copyright>
47
52
  <refnamediv>
48
53
    <refname><command>&COMMANDNAME;</command></refname>
49
54
    <refpurpose>
50
 
      Control the operation of the Mandos server
 
55
      Control or query the operation of the Mandos server
51
56
    </refpurpose>
52
57
  </refnamediv>
53
58
  
54
59
  <refsynopsisdiv>
55
60
    <cmdsynopsis>
56
61
      <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>--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/>
151
 
        <arg choice="plain"><option>--deny</option></arg>
152
 
        <arg choice="plain"><option>-D</option></arg>
 
62
      <group choice="req">
 
63
        <group>
 
64
          <arg choice="plain"><option>--enable</option></arg>
 
65
          <arg choice="plain"><option>-e</option></arg>
 
66
          <sbr/>
 
67
          <arg choice="plain"><option>--disable</option></arg>
 
68
          <arg choice="plain"><option>-d</option></arg>
 
69
        </group>
 
70
        <sbr/>
 
71
        <group>
 
72
          <arg choice="plain"><option>--bump-timeout</option></arg>
 
73
          <arg choice="plain"><option>-b</option></arg>
 
74
        </group>
 
75
        <sbr/>
 
76
        <group>
 
77
          <arg choice="plain"><option>--start-checker</option></arg>
 
78
        </group>
 
79
        <sbr/>
 
80
        <group>
 
81
          <arg choice="plain"><option>--stop-checker</option></arg>
 
82
        </group>
 
83
        <sbr/>
 
84
        <group>
 
85
          <arg choice="plain"><option>--remove</option></arg>
 
86
          <arg choice="plain"><option>-r</option></arg>
 
87
        </group>
 
88
        <sbr/>
 
89
        <group>
 
90
          <arg choice="plain"><option>--checker
 
91
          <replaceable>COMMAND</replaceable></option></arg>
 
92
          <arg choice="plain"><option>-c
 
93
          <replaceable>COMMAND</replaceable></option></arg>
 
94
        </group>
 
95
        <sbr/>
 
96
        <group>
 
97
          <arg choice="plain"><option>--timeout
 
98
          <replaceable>TIME</replaceable></option></arg>
 
99
          <arg choice="plain"><option>-t
 
100
          <replaceable>TIME</replaceable></option></arg>
 
101
        </group>
 
102
        <sbr/>
 
103
        <group>
 
104
          <arg choice="plain"><option>--extended-timeout
 
105
          <replaceable>TIME</replaceable></option></arg>
 
106
        </group>
 
107
        <sbr/>
 
108
        <group>
 
109
          <arg choice="plain"><option>--interval
 
110
          <replaceable>TIME</replaceable></option></arg>
 
111
          <arg choice="plain"><option>-i
 
112
          <replaceable>TIME</replaceable></option></arg>
 
113
        </group>
 
114
        <sbr/>
 
115
        <group>
 
116
          <arg choice="plain"><option>--approve-by-default</option
 
117
          ></arg>
 
118
          <sbr/>
 
119
          <arg choice="plain"><option>--deny-by-default</option></arg>
 
120
        </group>
 
121
        <sbr/>
 
122
        <group>
 
123
          <arg choice="plain"><option>--approval-delay
 
124
          <replaceable>TIME</replaceable></option></arg>
 
125
        </group>
 
126
        <sbr/>
 
127
        <group>
 
128
          <arg choice="plain"><option>--approval-duration
 
129
          <replaceable>TIME</replaceable></option></arg>
 
130
        </group>
 
131
        <sbr/>
 
132
        <group>
 
133
          <arg choice="plain"><option>--interval
 
134
          <replaceable>TIME</replaceable></option></arg>
 
135
          <arg choice="plain"><option>-i
 
136
          <replaceable>TIME</replaceable></option></arg>
 
137
        </group>
 
138
        <sbr/>
 
139
        <group>
 
140
          <arg choice="plain"><option>--host
 
141
          <replaceable>STRING</replaceable></option></arg>
 
142
          <arg choice="plain"><option>-H
 
143
          <replaceable>STRING</replaceable></option></arg>
 
144
        </group>
 
145
        <sbr/>
 
146
        <group>
 
147
          <arg choice="plain"><option>--secret
 
148
          <replaceable>FILENAME</replaceable></option></arg>
 
149
          <arg choice="plain"><option>-s
 
150
          <replaceable>FILENAME</replaceable></option></arg>
 
151
        </group>
 
152
        <sbr/>
 
153
        <group>
 
154
          <arg choice="plain"><option>--approve</option></arg>
 
155
          <arg choice="plain"><option>-A</option></arg>
 
156
          <sbr/>
 
157
          <arg choice="plain"><option>--deny</option></arg>
 
158
          <arg choice="plain"><option>-D</option></arg>
 
159
        </group>
153
160
      </group>
154
161
      <sbr/>
155
162
      <group choice="req">
163
170
    <cmdsynopsis>
164
171
      <command>&COMMANDNAME;</command>
165
172
      <group>
166
 
        <arg choice="plain"><option>--verbose</option></arg>
167
 
        <arg choice="plain"><option>-v</option></arg>
 
173
          <arg choice="plain"><option>--verbose</option></arg>
 
174
          <arg choice="plain"><option>-v</option></arg>
 
175
          <sbr/>
 
176
          <arg choice="plain"><option>--dump-json</option></arg>
 
177
          <arg choice="plain"><option>-j</option></arg>
168
178
      </group>
169
179
      <group>
170
180
        <arg rep='repeat' choice='plain'>
194
204
        <arg choice="plain"><option>-v</option></arg>
195
205
      </group>
196
206
    </cmdsynopsis>
 
207
    <cmdsynopsis>
 
208
      <command>&COMMANDNAME;</command>
 
209
      <arg choice="plain"><option>--check</option></arg>
 
210
    </cmdsynopsis>
197
211
  </refsynopsisdiv>
198
212
  
199
213
  <refsect1 id="description">
200
214
    <title>DESCRIPTION</title>
201
215
    <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>.
 
216
      <command>&COMMANDNAME;</command> is a program to control or
 
217
      query the operation of the Mandos server
 
218
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
219
      >8</manvolnum></citerefentry>.
205
220
    </para>
206
221
    <para>
207
222
      This program can be used to change client settings, approve or
465
480
      </varlistentry>
466
481
      
467
482
      <varlistentry>
 
483
        <term><option>--dump-json</option></term>
 
484
        <term><option>-j</option></term>
 
485
        <listitem>
 
486
          <para>
 
487
            Dump client settings as JSON to standard output.
 
488
          </para>
 
489
        </listitem>
 
490
      </varlistentry>
 
491
      
 
492
      <varlistentry>
468
493
        <term><option>--is-enabled</option></term>
469
494
        <term><option>-V</option></term>
470
495
        <listitem>
475
500
        </listitem>
476
501
      </varlistentry>
477
502
      
 
503
      <varlistentry>
 
504
        <term><option>--check</option></term>
 
505
        <listitem>
 
506
          <para>
 
507
            Run self-tests.  This includes any unit tests, etc.
 
508
          </para>
 
509
        </listitem>
 
510
      </varlistentry>
 
511
      
478
512
    </variablelist>
479
513
  </refsect1>
480
514
  
496
530
    </para>
497
531
  </refsect1>
498
532
  
499
 
<!--   <refsect1 id="bugs"> -->
500
 
<!--     <title>BUGS</title> -->
501
 
<!--     <para> -->
502
 
<!--     </para> -->
503
 
<!--   </refsect1> -->
 
533
  <refsect1 id="bugs">
 
534
    <title>BUGS</title>
 
535
    <xi:include href="bugs.xml"/>
 
536
  </refsect1>
504
537
  
505
538
  <refsect1 id="example">
506
539
    <title>EXAMPLE</title>