/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-03-05 21:42:56 UTC
  • Revision ID: teddy@recompile.se-20160305214256-79progf0wfkd9068
Add bug reporting information to manual pages

* bugs.xml: New file.
* intro.xml (BUGS): New section; include "bugs.xml".
* mandos-clients.conf.xml (BUGS): Include "bugs.xml".
* mandos-ctl.xml (BUGS): Uncommented; include "bugs.xml".
* mandos-keygen.xml (BUGS): - '' -
* mandos-monitor.xml (BUGS): Include "bugs.xml".
* mandos.conf.xml (BUGS): - '' -
* mandos.xml (BUGS): - '' -
* plugin-runner.xml (BUGS): - '' -
* plugins.d/askpass-fifo.xml (BUGS): New section; include
                                     "../bugs.xml".
* plugins.d/mandos-client.xml (BUGS): Uncommented; include
                                     "../bugs.xml".
* plugins.d/password-prompt.xml (BUGS): Include "../bugs.xml".
* plugins.d/plymouth.xml (BUGS): - '' -
* plugins.d/splashy.xml (BUGS): - '' -
* plugins.d/usplash.xml (BUGS): - '' -

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 "2010-09-25">
 
5
<!ENTITY TIMESTAMP "2016-03-05">
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@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.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@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.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>
35
41
      <holder>Teddy Hogeborn</holder>
36
42
      <holder>Björn Påhlsson</holder>
37
43
    </copyright>
94
100
      </group>
95
101
      <sbr/>
96
102
      <group>
 
103
        <arg choice="plain"><option>--extended-timeout
 
104
        <replaceable>TIME</replaceable></option></arg>
 
105
      </group>
 
106
      <sbr/>
 
107
      <group>
 
108
        <arg choice="plain"><option>--interval
 
109
        <replaceable>TIME</replaceable></option></arg>
 
110
        <arg choice="plain"><option>-i
 
111
        <replaceable>TIME</replaceable></option></arg>
 
112
      </group>
 
113
      <sbr/>
 
114
      <group>
 
115
        <arg choice="plain"><option>--approve-by-default</option
 
116
        ></arg>
 
117
        <sbr/>
 
118
        <arg choice="plain"><option>--deny-by-default</option></arg>
 
119
      </group>
 
120
      <sbr/>
 
121
      <group>
 
122
        <arg choice="plain"><option>--approval-delay
 
123
        <replaceable>TIME</replaceable></option></arg>
 
124
      </group>
 
125
      <sbr/>
 
126
      <group>
 
127
        <arg choice="plain"><option>--approval-duration
 
128
        <replaceable>TIME</replaceable></option></arg>
 
129
      </group>
 
130
      <sbr/>
 
131
      <group>
97
132
        <arg choice="plain"><option>--interval
98
133
        <replaceable>TIME</replaceable></option></arg>
99
134
        <arg choice="plain"><option>-i
164
199
        <arg choice="plain"><option>-v</option></arg>
165
200
      </group>
166
201
    </cmdsynopsis>
 
202
    <cmdsynopsis>
 
203
      <command>&COMMANDNAME;</command>
 
204
      <arg choice="plain"><option>--check</option></arg>
 
205
    </cmdsynopsis>
167
206
  </refsynopsisdiv>
168
207
  
169
208
  <refsect1 id="description">
273
312
          <para>
274
313
            Set the <varname>checker</varname> option of the specified
275
314
            client(s); see <citerefentry><refentrytitle
276
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
277
 
            ></citerefentry>.
 
315
            >mandos-clients.conf</refentrytitle><manvolnum
 
316
            >5</manvolnum></citerefentry>.
278
317
          </para>
279
318
        </listitem>
280
319
      </varlistentry>
288
327
          <para>
289
328
            Set the <varname>timeout</varname> option of the specified
290
329
            client(s); see <citerefentry><refentrytitle
291
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
292
 
            ></citerefentry>.
 
330
            >mandos-clients.conf</refentrytitle><manvolnum
 
331
            >5</manvolnum></citerefentry>.
 
332
          </para>
 
333
        </listitem>
 
334
      </varlistentry>
 
335
 
 
336
      <varlistentry>
 
337
        <term><option>--extended-timeout
 
338
        <replaceable>TIME</replaceable></option></term>
 
339
        <listitem>
 
340
          <para>
 
341
            Set the <varname>extended_timeout</varname> option of the
 
342
            specified client(s); see <citerefentry><refentrytitle
 
343
            >mandos-clients.conf</refentrytitle><manvolnum
 
344
            >5</manvolnum></citerefentry>.
293
345
          </para>
294
346
        </listitem>
295
347
      </varlistentry>
301
353
        <replaceable>TIME</replaceable></option></term>
302
354
        <listitem>
303
355
          <para>
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>.
 
356
            Set the <varname>interval</varname> option of the
 
357
            specified client(s); see <citerefentry><refentrytitle
 
358
            >mandos-clients.conf</refentrytitle><manvolnum
 
359
            >5</manvolnum></citerefentry>.
 
360
          </para>
 
361
        </listitem>
 
362
      </varlistentry>
 
363
      
 
364
      <varlistentry>
 
365
        <term><option>--approve-by-default</option></term>
 
366
        <term><option>--deny-by-default</option></term>
 
367
        <listitem>
 
368
          <para>
 
369
            Set the <varname>approved_by_default</varname> option of
 
370
            the specified client(s) to <literal>True</literal> or
 
371
            <literal>False</literal>, respectively; see
 
372
            <citerefentry><refentrytitle
 
373
            >mandos-clients.conf</refentrytitle><manvolnum
 
374
            >5</manvolnum></citerefentry>.
 
375
          </para>
 
376
        </listitem>
 
377
      </varlistentry>
 
378
      
 
379
      <varlistentry>
 
380
        <term><option>--approval-delay
 
381
        <replaceable>TIME</replaceable></option></term>
 
382
        <listitem>
 
383
          <para>
 
384
            Set the <varname>approval_delay</varname> option of the
 
385
            specified client(s); see <citerefentry><refentrytitle
 
386
            >mandos-clients.conf</refentrytitle><manvolnum
 
387
            >5</manvolnum></citerefentry>.
 
388
          </para>
 
389
        </listitem>
 
390
      </varlistentry>
 
391
      
 
392
      <varlistentry>
 
393
        <term><option>--approval-duration
 
394
        <replaceable>TIME</replaceable></option></term>
 
395
        <listitem>
 
396
          <para>
 
397
            Set the <varname>approval_duration</varname> option of the
 
398
            specified client(s); see <citerefentry><refentrytitle
 
399
            >mandos-clients.conf</refentrytitle><manvolnum
 
400
            >5</manvolnum></citerefentry>.
308
401
          </para>
309
402
        </listitem>
310
403
      </varlistentry>
318
411
          <para>
319
412
            Set the <varname>host</varname> option of the specified
320
413
            client(s); see <citerefentry><refentrytitle
321
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
322
 
            ></citerefentry>.
 
414
            >mandos-clients.conf</refentrytitle><manvolnum
 
415
            >5</manvolnum></citerefentry>.
323
416
          </para>
324
417
        </listitem>
325
418
      </varlistentry>
333
426
          <para>
334
427
            Set the <varname>secfile</varname> option of the specified
335
428
            client(s); see <citerefentry><refentrytitle
336
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
337
 
            ></citerefentry>.
 
429
            >mandos-clients.conf</refentrytitle><manvolnum
 
430
            >5</manvolnum></citerefentry>.
338
431
          </para>
339
432
        </listitem>
340
433
      </varlistentry>
391
484
        </listitem>
392
485
      </varlistentry>
393
486
      
 
487
      <varlistentry>
 
488
        <term><option>--check</option></term>
 
489
        <listitem>
 
490
          <para>
 
491
            Run self-tests.  This includes any unit tests, etc.
 
492
          </para>
 
493
        </listitem>
 
494
      </varlistentry>
 
495
      
394
496
    </variablelist>
395
497
  </refsect1>
396
498
  
412
514
    </para>
413
515
  </refsect1>
414
516
  
415
 
<!--   <refsect1 id="bugs"> -->
416
 
<!--     <title>BUGS</title> -->
417
 
<!--     <para> -->
418
 
<!--     </para> -->
419
 
<!--   </refsect1> -->
 
517
  <refsect1 id="bugs">
 
518
    <title>BUGS</title>
 
519
    <xi:include href="bugs.xml"/>
 
520
  </refsect1>
420
521
  
421
522
  <refsect1 id="example">
422
523
    <title>EXAMPLE</title>
471
572
        To approve all clients currently waiting for it:
472
573
      </para>
473
574
      <para>
474
 
 
475
 
<!-- do not wrap this line -->
476
 
<userinput>&COMMANDNAME; --approve --all</userinput>
477
 
 
 
575
        <userinput>&COMMANDNAME; --approve --all</userinput>
478
576
      </para>
479
577
    </informalexample>
480
578
  </refsect1>
491
589
  <refsect1 id="see_also">
492
590
    <title>SEE ALSO</title>
493
591
    <para>
 
592
      <citerefentry><refentrytitle>intro</refentrytitle>
 
593
      <manvolnum>8mandos</manvolnum></citerefentry>,
494
594
      <citerefentry><refentrytitle>mandos</refentrytitle>
495
595
      <manvolnum>8</manvolnum></citerefentry>,
496
596
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>