/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: 2016-06-28 18:52:00 UTC
  • Revision ID: teddy@recompile.se-20160628185200-vv6fikpt18r977x3
mandos-ctl: Include "Expires" and "LastCheckerStatus" properties

* mandos-ctl (tablewords): Add "Expires" and "LastCheckerStatus".
  (main/keywords): - '' -

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 "2015-07-20">
 
5
<!ENTITY TIMESTAMP "2016-06-27">
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>
40
41
      <holder>Teddy Hogeborn</holder>
41
42
      <holder>Björn Påhlsson</holder>
42
43
    </copyright>
51
52
  <refnamediv>
52
53
    <refname><command>&COMMANDNAME;</command></refname>
53
54
    <refpurpose>
54
 
      Control the operation of the Mandos server
 
55
      Control or query the operation of the Mandos server
55
56
    </refpurpose>
56
57
  </refnamediv>
57
58
  
58
59
  <refsynopsisdiv>
59
60
    <cmdsynopsis>
60
61
      <command>&COMMANDNAME;</command>
61
 
      <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/>
155
 
        <arg choice="plain"><option>--deny</option></arg>
156
 
        <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>
157
160
      </group>
158
161
      <sbr/>
159
162
      <group choice="req">
167
170
    <cmdsynopsis>
168
171
      <command>&COMMANDNAME;</command>
169
172
      <group>
170
 
        <arg choice="plain"><option>--verbose</option></arg>
171
 
        <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>
172
178
      </group>
173
179
      <group>
174
180
        <arg rep='repeat' choice='plain'>
207
213
  <refsect1 id="description">
208
214
    <title>DESCRIPTION</title>
209
215
    <para>
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>.
 
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>.
213
220
    </para>
214
221
    <para>
215
222
      This program can be used to change client settings, approve or
473
480
      </varlistentry>
474
481
      
475
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>
476
493
        <term><option>--is-enabled</option></term>
477
494
        <term><option>-V</option></term>
478
495
        <listitem>
513
530
    </para>
514
531
  </refsect1>
515
532
  
516
 
<!--   <refsect1 id="bugs"> -->
517
 
<!--     <title>BUGS</title> -->
518
 
<!--     <para> -->
519
 
<!--     </para> -->
520
 
<!--   </refsect1> -->
 
533
  <refsect1 id="bugs">
 
534
    <title>BUGS</title>
 
535
    <xi:include href="bugs.xml"/>
 
536
  </refsect1>
521
537
  
522
538
  <refsect1 id="example">
523
539
    <title>EXAMPLE</title>