/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 at bsnet
  • Date: 2010-09-24 18:33:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100924183339-268yiitwo9yjp3gj
* 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 "2016-03-05">
 
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
35
      <holder>Teddy Hogeborn</holder>
42
36
      <holder>Björn Påhlsson</holder>
43
37
    </copyright>
100
94
      </group>
101
95
      <sbr/>
102
96
      <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>
132
97
        <arg choice="plain"><option>--interval
133
98
        <replaceable>TIME</replaceable></option></arg>
134
99
        <arg choice="plain"><option>-i
199
164
        <arg choice="plain"><option>-v</option></arg>
200
165
      </group>
201
166
    </cmdsynopsis>
202
 
    <cmdsynopsis>
203
 
      <command>&COMMANDNAME;</command>
204
 
      <arg choice="plain"><option>--check</option></arg>
205
 
    </cmdsynopsis>
206
167
  </refsynopsisdiv>
207
168
  
208
169
  <refsect1 id="description">
312
273
          <para>
313
274
            Set the <varname>checker</varname> option of the specified
314
275
            client(s); see <citerefentry><refentrytitle
315
 
            >mandos-clients.conf</refentrytitle><manvolnum
316
 
            >5</manvolnum></citerefentry>.
 
276
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
277
            ></citerefentry>.
317
278
          </para>
318
279
        </listitem>
319
280
      </varlistentry>
327
288
          <para>
328
289
            Set the <varname>timeout</varname> option of the specified
329
290
            client(s); see <citerefentry><refentrytitle
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>.
 
291
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
292
            ></citerefentry>.
345
293
          </para>
346
294
        </listitem>
347
295
      </varlistentry>
353
301
        <replaceable>TIME</replaceable></option></term>
354
302
        <listitem>
355
303
          <para>
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>.
 
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>.
401
308
          </para>
402
309
        </listitem>
403
310
      </varlistentry>
411
318
          <para>
412
319
            Set the <varname>host</varname> option of the specified
413
320
            client(s); see <citerefentry><refentrytitle
414
 
            >mandos-clients.conf</refentrytitle><manvolnum
415
 
            >5</manvolnum></citerefentry>.
 
321
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
322
            ></citerefentry>.
416
323
          </para>
417
324
        </listitem>
418
325
      </varlistentry>
426
333
          <para>
427
334
            Set the <varname>secfile</varname> option of the specified
428
335
            client(s); see <citerefentry><refentrytitle
429
 
            >mandos-clients.conf</refentrytitle><manvolnum
430
 
            >5</manvolnum></citerefentry>.
 
336
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
 
337
            ></citerefentry>.
431
338
          </para>
432
339
        </listitem>
433
340
      </varlistentry>
484
391
        </listitem>
485
392
      </varlistentry>
486
393
      
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
 
      
496
394
    </variablelist>
497
395
  </refsect1>
498
396
  
514
412
    </para>
515
413
  </refsect1>
516
414
  
517
 
  <refsect1 id="bugs">
518
 
    <title>BUGS</title>
519
 
    <xi:include href="bugs.xml"/>
520
 
  </refsect1>
 
415
<!--   <refsect1 id="bugs"> -->
 
416
<!--     <title>BUGS</title> -->
 
417
<!--     <para> -->
 
418
<!--     </para> -->
 
419
<!--   </refsect1> -->
521
420
  
522
421
  <refsect1 id="example">
523
422
    <title>EXAMPLE</title>
524
423
    <informalexample>
525
424
      <para>
526
 
        To list all clients:
 
425
        List all clients with some of their settings:
527
426
      </para>
528
427
      <para>
529
428
        <userinput>&COMMANDNAME;</userinput>
530
429
      </para>
531
430
    </informalexample>
532
 
    
533
 
    <informalexample>
534
 
      <para>
535
 
        To list <emphasis>all</emphasis> settings for the clients
536
 
        named <quote>foo1.example.org</quote> and <quote
537
 
        >foo2.example.org</quote>:
538
 
      </para>
539
 
      <para>
540
 
 
541
 
<!-- do not wrap this line -->
542
 
<userinput>&COMMANDNAME; --verbose foo1.example.org foo2.example.org</userinput>
543
 
 
544
 
      </para>
545
 
    </informalexample>
546
 
    
547
 
    <informalexample>
548
 
      <para>
549
 
        To enable all clients:
550
 
      </para>
551
 
      <para>
552
 
        <userinput>&COMMANDNAME; --enable --all</userinput>
553
 
      </para>
554
 
    </informalexample>
555
 
    
556
 
    <informalexample>
557
 
      <para>
558
 
        To change timeout and interval value for the clients
559
 
        named <quote>foo1.example.org</quote> and <quote
560
 
        >foo2.example.org</quote>:
561
 
      </para>
562
 
      <para>
563
 
 
564
 
<!-- do not wrap this line -->
565
 
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
566
 
 
567
 
      </para>
568
 
    </informalexample>
569
 
    
570
 
    <informalexample>
571
 
      <para>
572
 
        To approve all clients currently waiting for it:
573
 
      </para>
574
 
      <para>
575
 
        <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
 
576
441
      </para>
577
442
    </informalexample>
578
443
  </refsect1>
589
454
  <refsect1 id="see_also">
590
455
    <title>SEE ALSO</title>
591
456
    <para>
592
 
      <citerefentry><refentrytitle>intro</refentrytitle>
593
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
594
457
      <citerefentry><refentrytitle>mandos</refentrytitle>
595
458
      <manvolnum>8</manvolnum></citerefentry>,
596
459
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>