/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: 2010-10-02 17:41:05 UTC
  • mto: (24.1.169 mandos)
  • mto: This revision was merged to the branch mainline in revision 453.
  • Revision ID: teddy@fukt.bsnet.se-20101002174105-xfqa0j8y1puvedo3
* debian/source/format: New; contains "3.0 (quilt)".

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 "2019-03-07">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
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@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.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@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2010</year>
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>
44
35
      <holder>Teddy Hogeborn</holder>
45
36
      <holder>Björn Påhlsson</holder>
46
37
    </copyright>
55
46
  <refnamediv>
56
47
    <refname><command>&COMMANDNAME;</command></refname>
57
48
    <refpurpose>
58
 
      Control or query the operation of the Mandos server
 
49
      Control the operation of the Mandos server
59
50
    </refpurpose>
60
51
  </refnamediv>
61
52
  
63
54
    <cmdsynopsis>
64
55
      <command>&COMMANDNAME;</command>
65
56
      <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>
 
57
        <arg choice="plain"><option>--enable</option></arg>
 
58
        <arg choice="plain"><option>-e</option></arg>
 
59
        <sbr/>
 
60
        <arg choice="plain"><option>--disable</option></arg>
 
61
        <arg choice="plain"><option>-d</option></arg>
 
62
      </group>
 
63
      <sbr/>
 
64
      <group>
 
65
        <arg choice="plain"><option>--bump-timeout</option></arg>
 
66
        <arg choice="plain"><option>-b</option></arg>
 
67
      </group>
 
68
      <sbr/>
 
69
      <group>
 
70
        <arg choice="plain"><option>--start-checker</option></arg>
 
71
      </group>
 
72
      <sbr/>
 
73
      <group>
 
74
        <arg choice="plain"><option>--stop-checker</option></arg>
 
75
      </group>
 
76
      <sbr/>
 
77
      <group>
 
78
        <arg choice="plain"><option>--remove</option></arg>
 
79
        <arg choice="plain"><option>-r</option></arg>
 
80
      </group>
 
81
      <sbr/>
 
82
      <group>
 
83
        <arg choice="plain"><option>--checker
 
84
        <replaceable>COMMAND</replaceable></option></arg>
 
85
        <arg choice="plain"><option>-c
 
86
        <replaceable>COMMAND</replaceable></option></arg>
 
87
      </group>
 
88
      <sbr/>
 
89
      <group>
 
90
        <arg choice="plain"><option>--timeout
 
91
        <replaceable>TIME</replaceable></option></arg>
 
92
        <arg choice="plain"><option>-t
 
93
        <replaceable>TIME</replaceable></option></arg>
 
94
      </group>
 
95
      <sbr/>
 
96
      <group>
 
97
        <arg choice="plain"><option>--interval
 
98
        <replaceable>TIME</replaceable></option></arg>
 
99
        <arg choice="plain"><option>-i
 
100
        <replaceable>TIME</replaceable></option></arg>
 
101
      </group>
 
102
      <sbr/>
 
103
      <group>
 
104
        <arg choice="plain"><option>--approve-by-default</option
 
105
        ></arg>
 
106
        <sbr/>
 
107
        <arg choice="plain"><option>--deny-by-default</option></arg>
 
108
      </group>
 
109
      <sbr/>
 
110
      <group>
 
111
        <arg choice="plain"><option>--approval-delay
 
112
        <replaceable>TIME</replaceable></option></arg>
 
113
      </group>
 
114
      <sbr/>
 
115
      <group>
 
116
        <arg choice="plain"><option>--approval-duration
 
117
        <replaceable>TIME</replaceable></option></arg>
 
118
      </group>
 
119
      <sbr/>
 
120
      <group>
 
121
        <arg choice="plain"><option>--interval
 
122
        <replaceable>TIME</replaceable></option></arg>
 
123
        <arg choice="plain"><option>-i
 
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/>
176
145
        <arg choice="plain"><option>--deny</option></arg>
177
146
        <arg choice="plain"><option>-D</option></arg>
178
147
      </group>
179
 
      <group choice="req">
180
 
          <arg choice="plain"><option>--remove</option></arg>
181
 
          <arg choice="plain"><option>-r</option></arg>
182
 
      </group>
 
148
      <sbr/>
183
149
      <group choice="req">
184
150
        <arg choice="plain"><option>--all</option></arg>
185
151
        <arg choice="plain"><option>-a</option></arg>
190
156
    </cmdsynopsis>
191
157
    <cmdsynopsis>
192
158
      <command>&COMMANDNAME;</command>
 
159
      <group>
 
160
        <arg choice="plain"><option>--verbose</option></arg>
 
161
        <arg choice="plain"><option>-v</option></arg>
 
162
      </group>
 
163
      <group>
 
164
        <arg rep='repeat' choice='plain'>
 
165
          <replaceable>CLIENT</replaceable>
 
166
        </arg>
 
167
      </group>
 
168
    </cmdsynopsis>
 
169
    <cmdsynopsis>
 
170
      <command>&COMMANDNAME;</command>
193
171
      <group choice="req">
194
172
        <arg choice="plain"><option>--is-enabled</option></arg>
195
173
        <arg choice="plain"><option>-V</option></arg>
210
188
        <arg choice="plain"><option>-v</option></arg>
211
189
      </group>
212
190
    </cmdsynopsis>
213
 
    <cmdsynopsis>
214
 
      <command>&COMMANDNAME;</command>
215
 
      <arg choice="plain"><option>--check</option></arg>
216
 
    </cmdsynopsis>
217
191
  </refsynopsisdiv>
218
192
  
219
193
  <refsect1 id="description">
220
194
    <title>DESCRIPTION</title>
221
195
    <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>.
 
196
      <command>&COMMANDNAME;</command> is a program to control the
 
197
      operation of the Mandos server <citerefentry><refentrytitle
 
198
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
226
199
    </para>
227
200
    <para>
228
201
      This program can be used to change client settings, approve or
344
317
          </para>
345
318
        </listitem>
346
319
      </varlistentry>
347
 
 
348
 
      <varlistentry>
349
 
        <term><option>--extended-timeout
350
 
        <replaceable>TIME</replaceable></option></term>
351
 
        <listitem>
352
 
          <para>
353
 
            Set the <varname>extended_timeout</varname> option of the
354
 
            specified client(s); see <citerefentry><refentrytitle
355
 
            >mandos-clients.conf</refentrytitle><manvolnum
356
 
            >5</manvolnum></citerefentry>.
357
 
          </para>
358
 
        </listitem>
359
 
      </varlistentry>
360
320
      
361
321
      <varlistentry>
362
322
        <term><option>--interval
486
446
      </varlistentry>
487
447
      
488
448
      <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
449
        <term><option>--is-enabled</option></term>
500
450
        <term><option>-V</option></term>
501
451
        <listitem>
506
456
        </listitem>
507
457
      </varlistentry>
508
458
      
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
 
      
518
459
    </variablelist>
519
460
  </refsect1>
520
461
  
536
477
    </para>
537
478
  </refsect1>
538
479
  
539
 
  <refsect1 id="bugs">
540
 
    <title>BUGS</title>
541
 
    <xi:include href="bugs.xml"/>
542
 
  </refsect1>
 
480
<!--   <refsect1 id="bugs"> -->
 
481
<!--     <title>BUGS</title> -->
 
482
<!--     <para> -->
 
483
<!--     </para> -->
 
484
<!--   </refsect1> -->
543
485
  
544
486
  <refsect1 id="example">
545
487
    <title>EXAMPLE</title>
584
526
      <para>
585
527
 
586
528
<!-- do not wrap this line -->
587
 
<userinput>&COMMANDNAME; --timeout="PT5M" --interval="PT1M" foo1.example.org foo2.example.org</userinput>
 
529
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
588
530
 
589
531
      </para>
590
532
    </informalexample>
611
553
  <refsect1 id="see_also">
612
554
    <title>SEE ALSO</title>
613
555
    <para>
614
 
      <citerefentry><refentrytitle>intro</refentrytitle>
615
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
616
556
      <citerefentry><refentrytitle>mandos</refentrytitle>
617
557
      <manvolnum>8</manvolnum></citerefentry>,
618
558
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>