/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

* plugins.d/plymouth.c: Break lines, fix whitespace.  Remove
                        unnecessary casts.

  (main) Exit with EX_UNAVAILABLE if plymouth is not found.  Use first
         argument of error() where useful.  Simplify logic of checking
         results of running the ask-for-password command.  Simplify
         assigning value to "plymouthd_argv".

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 "2019-03-07">
 
5
<!ENTITY TIMESTAMP "2010-09-21">
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>--host
 
105
        <replaceable>STRING</replaceable></option></arg>
 
106
        <arg choice="plain"><option>-H
 
107
        <replaceable>STRING</replaceable></option></arg>
 
108
      </group>
 
109
      <sbr/>
 
110
      <group>
 
111
        <arg choice="plain"><option>--secret
 
112
        <replaceable>FILENAME</replaceable></option></arg>
 
113
        <arg choice="plain"><option>-s
 
114
        <replaceable>FILENAME</replaceable></option></arg>
 
115
      </group>
 
116
      <sbr/>
 
117
      <group>
 
118
        <arg choice="plain"><option>--approve</option></arg>
 
119
        <arg choice="plain"><option>-A</option></arg>
 
120
        <sbr/>
176
121
        <arg choice="plain"><option>--deny</option></arg>
177
122
        <arg choice="plain"><option>-D</option></arg>
178
123
      </group>
179
 
      <group choice="req">
180
 
          <arg choice="plain"><option>--remove</option></arg>
181
 
          <arg choice="plain"><option>-r</option></arg>
182
 
      </group>
 
124
      <sbr/>
183
125
      <group choice="req">
184
126
        <arg choice="plain"><option>--all</option></arg>
185
127
        <arg choice="plain"><option>-a</option></arg>
190
132
    </cmdsynopsis>
191
133
    <cmdsynopsis>
192
134
      <command>&COMMANDNAME;</command>
 
135
      <group>
 
136
        <arg choice="plain"><option>--verbose</option></arg>
 
137
        <arg choice="plain"><option>-v</option></arg>
 
138
      </group>
 
139
      <group>
 
140
        <arg rep='repeat' choice='plain'>
 
141
          <replaceable>CLIENT</replaceable>
 
142
        </arg>
 
143
      </group>
 
144
    </cmdsynopsis>
 
145
    <cmdsynopsis>
 
146
      <command>&COMMANDNAME;</command>
193
147
      <group choice="req">
194
148
        <arg choice="plain"><option>--is-enabled</option></arg>
195
149
        <arg choice="plain"><option>-V</option></arg>
210
164
        <arg choice="plain"><option>-v</option></arg>
211
165
      </group>
212
166
    </cmdsynopsis>
213
 
    <cmdsynopsis>
214
 
      <command>&COMMANDNAME;</command>
215
 
      <arg choice="plain"><option>--check</option></arg>
216
 
    </cmdsynopsis>
217
167
  </refsynopsisdiv>
218
168
  
219
169
  <refsect1 id="description">
220
170
    <title>DESCRIPTION</title>
221
171
    <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>.
 
172
      <command>&COMMANDNAME;</command> is a program to control the
 
173
      operation of the Mandos server <citerefentry><refentrytitle
 
174
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
226
175
    </para>
227
176
    <para>
228
177
      This program can be used to change client settings, approve or
324
273
          <para>
325
274
            Set the <varname>checker</varname> option of the specified
326
275
            client(s); see <citerefentry><refentrytitle
327
 
            >mandos-clients.conf</refentrytitle><manvolnum
328
 
            >5</manvolnum></citerefentry>.
 
276
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
277
            ></citerefentry>.
329
278
          </para>
330
279
        </listitem>
331
280
      </varlistentry>
339
288
          <para>
340
289
            Set the <varname>timeout</varname> option of the specified
341
290
            client(s); see <citerefentry><refentrytitle
342
 
            >mandos-clients.conf</refentrytitle><manvolnum
343
 
            >5</manvolnum></citerefentry>.
344
 
          </para>
345
 
        </listitem>
346
 
      </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>.
 
291
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
292
            ></citerefentry>.
357
293
          </para>
358
294
        </listitem>
359
295
      </varlistentry>
365
301
        <replaceable>TIME</replaceable></option></term>
366
302
        <listitem>
367
303
          <para>
368
 
            Set the <varname>interval</varname> option of the
369
 
            specified client(s); see <citerefentry><refentrytitle
370
 
            >mandos-clients.conf</refentrytitle><manvolnum
371
 
            >5</manvolnum></citerefentry>.
372
 
          </para>
373
 
        </listitem>
374
 
      </varlistentry>
375
 
      
376
 
      <varlistentry>
377
 
        <term><option>--approve-by-default</option></term>
378
 
        <term><option>--deny-by-default</option></term>
379
 
        <listitem>
380
 
          <para>
381
 
            Set the <varname>approved_by_default</varname> option of
382
 
            the specified client(s) to <literal>True</literal> or
383
 
            <literal>False</literal>, respectively; see
384
 
            <citerefentry><refentrytitle
385
 
            >mandos-clients.conf</refentrytitle><manvolnum
386
 
            >5</manvolnum></citerefentry>.
387
 
          </para>
388
 
        </listitem>
389
 
      </varlistentry>
390
 
      
391
 
      <varlistentry>
392
 
        <term><option>--approval-delay
393
 
        <replaceable>TIME</replaceable></option></term>
394
 
        <listitem>
395
 
          <para>
396
 
            Set the <varname>approval_delay</varname> option of the
397
 
            specified client(s); see <citerefentry><refentrytitle
398
 
            >mandos-clients.conf</refentrytitle><manvolnum
399
 
            >5</manvolnum></citerefentry>.
400
 
          </para>
401
 
        </listitem>
402
 
      </varlistentry>
403
 
      
404
 
      <varlistentry>
405
 
        <term><option>--approval-duration
406
 
        <replaceable>TIME</replaceable></option></term>
407
 
        <listitem>
408
 
          <para>
409
 
            Set the <varname>approval_duration</varname> option of the
410
 
            specified client(s); see <citerefentry><refentrytitle
411
 
            >mandos-clients.conf</refentrytitle><manvolnum
412
 
            >5</manvolnum></citerefentry>.
 
304
            Set the <varname>interval</varname> option of the specified
 
305
            client(s); see <citerefentry><refentrytitle
 
306
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
307
            ></citerefentry>.
413
308
          </para>
414
309
        </listitem>
415
310
      </varlistentry>
423
318
          <para>
424
319
            Set the <varname>host</varname> option of the specified
425
320
            client(s); see <citerefentry><refentrytitle
426
 
            >mandos-clients.conf</refentrytitle><manvolnum
427
 
            >5</manvolnum></citerefentry>.
 
321
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
322
            ></citerefentry>.
428
323
          </para>
429
324
        </listitem>
430
325
      </varlistentry>
438
333
          <para>
439
334
            Set the <varname>secfile</varname> option of the specified
440
335
            client(s); see <citerefentry><refentrytitle
441
 
            >mandos-clients.conf</refentrytitle><manvolnum
442
 
            >5</manvolnum></citerefentry>.
 
336
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
337
            ></citerefentry>.
443
338
          </para>
444
339
        </listitem>
445
340
      </varlistentry>
486
381
      </varlistentry>
487
382
      
488
383
      <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
384
        <term><option>--is-enabled</option></term>
500
385
        <term><option>-V</option></term>
501
386
        <listitem>
506
391
        </listitem>
507
392
      </varlistentry>
508
393
      
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
394
    </variablelist>
519
395
  </refsect1>
520
396
  
536
412
    </para>
537
413
  </refsect1>
538
414
  
539
 
  <refsect1 id="bugs">
540
 
    <title>BUGS</title>
541
 
    <xi:include href="bugs.xml"/>
542
 
  </refsect1>
 
415
<!--   <refsect1 id="bugs"> -->
 
416
<!--     <title>BUGS</title> -->
 
417
<!--     <para> -->
 
418
<!--     </para> -->
 
419
<!--   </refsect1> -->
543
420
  
544
421
  <refsect1 id="example">
545
422
    <title>EXAMPLE</title>
546
423
    <informalexample>
547
424
      <para>
548
 
        To list all clients:
 
425
        List all clients with some of their settings:
549
426
      </para>
550
427
      <para>
551
428
        <userinput>&COMMANDNAME;</userinput>
552
429
      </para>
553
430
    </informalexample>
554
 
    
555
 
    <informalexample>
556
 
      <para>
557
 
        To list <emphasis>all</emphasis> settings for the clients
558
 
        named <quote>foo1.example.org</quote> and <quote
559
 
        >foo2.example.org</quote>:
560
 
      </para>
561
 
      <para>
562
 
 
563
 
<!-- do not wrap this line -->
564
 
<userinput>&COMMANDNAME; --verbose foo1.example.org foo2.example.org</userinput>
565
 
 
566
 
      </para>
567
 
    </informalexample>
568
 
    
569
 
    <informalexample>
570
 
      <para>
571
 
        To enable all clients:
572
 
      </para>
573
 
      <para>
574
 
        <userinput>&COMMANDNAME; --enable --all</userinput>
575
 
      </para>
576
 
    </informalexample>
577
 
    
578
 
    <informalexample>
579
 
      <para>
580
 
        To change timeout and interval value for the clients
581
 
        named <quote>foo1.example.org</quote> and <quote
582
 
        >foo2.example.org</quote>:
583
 
      </para>
584
 
      <para>
585
 
 
586
 
<!-- do not wrap this line -->
587
 
<userinput>&COMMANDNAME; --timeout="PT5M" --interval="PT1M" foo1.example.org foo2.example.org</userinput>
588
 
 
589
 
      </para>
590
 
    </informalexample>
591
 
    
592
 
    <informalexample>
593
 
      <para>
594
 
        To approve all clients currently waiting for it:
595
 
      </para>
596
 
      <para>
597
 
        <userinput>&COMMANDNAME; --approve --all</userinput>
 
431
    <informalexample>
 
432
      <para>
 
433
        Show all settings for the clients named <quote>foo</quote> and
 
434
        <quote>bar</quote>:
 
435
      </para>
 
436
      <para>
 
437
 
 
438
<!-- do not wrap this line -->
 
439
<userinput>&COMMANDNAME; --verbose foo bar</userinput>
 
440
 
598
441
      </para>
599
442
    </informalexample>
600
443
  </refsect1>
611
454
  <refsect1 id="see_also">
612
455
    <title>SEE ALSO</title>
613
456
    <para>
614
 
      <citerefentry><refentrytitle>intro</refentrytitle>
615
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
616
457
      <citerefentry><refentrytitle>mandos</refentrytitle>
617
458
      <manvolnum>8</manvolnum></citerefentry>,
618
459
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>