/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: 2017-08-20 13:54:01 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 360.
  • Revision ID: teddy@recompile.se-20170820135401-nbm84h6hhyy40dr2
Bug fix: Detect failure of ssh-keyscan in mandos-keygen --password.

* mandos-keygen: Detect failure of ssh-keyscan in --password mode.

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