/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: Björn Påhlsson
  • Date: 2011-12-21 00:29:33 UTC
  • mfrom: (518.1.15 mandos-persistent)
  • Revision ID: belorn@recompile.se-20111221002933-6sc0a64o1ns2s2s8
Working persistant state

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 "2016-06-27">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
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>
41
36
      <holder>Teddy Hogeborn</holder>
42
37
      <holder>Björn Påhlsson</holder>
43
38
    </copyright>
52
47
  <refnamediv>
53
48
    <refname><command>&COMMANDNAME;</command></refname>
54
49
    <refpurpose>
55
 
      Control or query the operation of the Mandos server
 
50
      Control the operation of the Mandos server
56
51
    </refpurpose>
57
52
  </refnamediv>
58
53
  
59
54
  <refsynopsisdiv>
60
55
    <cmdsynopsis>
61
56
      <command>&COMMANDNAME;</command>
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>
 
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>
160
153
      </group>
161
154
      <sbr/>
162
155
      <group choice="req">
170
163
    <cmdsynopsis>
171
164
      <command>&COMMANDNAME;</command>
172
165
      <group>
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>
 
166
        <arg choice="plain"><option>--verbose</option></arg>
 
167
        <arg choice="plain"><option>-v</option></arg>
178
168
      </group>
179
169
      <group>
180
170
        <arg rep='repeat' choice='plain'>
204
194
        <arg choice="plain"><option>-v</option></arg>
205
195
      </group>
206
196
    </cmdsynopsis>
207
 
    <cmdsynopsis>
208
 
      <command>&COMMANDNAME;</command>
209
 
      <arg choice="plain"><option>--check</option></arg>
210
 
    </cmdsynopsis>
211
197
  </refsynopsisdiv>
212
198
  
213
199
  <refsect1 id="description">
214
200
    <title>DESCRIPTION</title>
215
201
    <para>
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>.
 
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>.
220
205
    </para>
221
206
    <para>
222
207
      This program can be used to change client settings, approve or
480
465
      </varlistentry>
481
466
      
482
467
      <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>
493
468
        <term><option>--is-enabled</option></term>
494
469
        <term><option>-V</option></term>
495
470
        <listitem>
500
475
        </listitem>
501
476
      </varlistentry>
502
477
      
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
 
      
512
478
    </variablelist>
513
479
  </refsect1>
514
480
  
530
496
    </para>
531
497
  </refsect1>
532
498
  
533
 
  <refsect1 id="bugs">
534
 
    <title>BUGS</title>
535
 
    <xi:include href="bugs.xml"/>
536
 
  </refsect1>
 
499
<!--   <refsect1 id="bugs"> -->
 
500
<!--     <title>BUGS</title> -->
 
501
<!--     <para> -->
 
502
<!--     </para> -->
 
503
<!--   </refsect1> -->
537
504
  
538
505
  <refsect1 id="example">
539
506
    <title>EXAMPLE</title>