/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: 2012-06-01 21:48:12 UTC
  • mto: (237.7.144 trunk) (301.1.1 release)
  • mto: This revision was merged to the branch mainline in revision 302.
  • Revision ID: teddy@recompile.se-20120601214812-g7685v5oeiuhi2qw
* debian/copyright (Copyright): Join the two lines to one line.
* debian/mandos-client.README.Debian: Refer to new location of example
  network hooks.
* debian/mandos-client.docs (network-hooks.d): Removed.
* debian/mandos-client.examples: New; contains "network-hooks.d".
* debian/rules (binary-common): Added "dh_installexamples".
  (binary-common/dh_fixperms): Changed to exclude new location of
  "network-hooks.d".
* init.d-mandos (status): Support new "status" action.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-21">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
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>
35
37
      <holder>Teddy Hogeborn</holder>
36
38
      <holder>Björn Påhlsson</holder>
37
39
    </copyright>
94
96
      </group>
95
97
      <sbr/>
96
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>
97
128
        <arg choice="plain"><option>--interval
98
129
        <replaceable>TIME</replaceable></option></arg>
99
130
        <arg choice="plain"><option>-i
273
304
          <para>
274
305
            Set the <varname>checker</varname> option of the specified
275
306
            client(s); see <citerefentry><refentrytitle
276
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
277
 
            ></citerefentry>.
 
307
            >mandos-clients.conf</refentrytitle><manvolnum
 
308
            >5</manvolnum></citerefentry>.
278
309
          </para>
279
310
        </listitem>
280
311
      </varlistentry>
288
319
          <para>
289
320
            Set the <varname>timeout</varname> option of the specified
290
321
            client(s); see <citerefentry><refentrytitle
291
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
292
 
            ></citerefentry>.
 
322
            >mandos-clients.conf</refentrytitle><manvolnum
 
323
            >5</manvolnum></citerefentry>.
 
324
          </para>
 
325
        </listitem>
 
326
      </varlistentry>
 
327
 
 
328
      <varlistentry>
 
329
        <term><option>--extended-timeout
 
330
        <replaceable>TIME</replaceable></option></term>
 
331
        <listitem>
 
332
          <para>
 
333
            Set the <varname>extended_timeout</varname> option of the
 
334
            specified client(s); see <citerefentry><refentrytitle
 
335
            >mandos-clients.conf</refentrytitle><manvolnum
 
336
            >5</manvolnum></citerefentry>.
293
337
          </para>
294
338
        </listitem>
295
339
      </varlistentry>
301
345
        <replaceable>TIME</replaceable></option></term>
302
346
        <listitem>
303
347
          <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>.
 
348
            Set the <varname>interval</varname> option of the
 
349
            specified client(s); see <citerefentry><refentrytitle
 
350
            >mandos-clients.conf</refentrytitle><manvolnum
 
351
            >5</manvolnum></citerefentry>.
 
352
          </para>
 
353
        </listitem>
 
354
      </varlistentry>
 
355
      
 
356
      <varlistentry>
 
357
        <term><option>--approve-by-default</option></term>
 
358
        <term><option>--deny-by-default</option></term>
 
359
        <listitem>
 
360
          <para>
 
361
            Set the <varname>approved_by_default</varname> option of
 
362
            the specified client(s) to <literal>True</literal> or
 
363
            <literal>False</literal>, respectively; see
 
364
            <citerefentry><refentrytitle
 
365
            >mandos-clients.conf</refentrytitle><manvolnum
 
366
            >5</manvolnum></citerefentry>.
 
367
          </para>
 
368
        </listitem>
 
369
      </varlistentry>
 
370
      
 
371
      <varlistentry>
 
372
        <term><option>--approval-delay
 
373
        <replaceable>TIME</replaceable></option></term>
 
374
        <listitem>
 
375
          <para>
 
376
            Set the <varname>approval_delay</varname> option of the
 
377
            specified client(s); see <citerefentry><refentrytitle
 
378
            >mandos-clients.conf</refentrytitle><manvolnum
 
379
            >5</manvolnum></citerefentry>.
 
380
          </para>
 
381
        </listitem>
 
382
      </varlistentry>
 
383
      
 
384
      <varlistentry>
 
385
        <term><option>--approval-duration
 
386
        <replaceable>TIME</replaceable></option></term>
 
387
        <listitem>
 
388
          <para>
 
389
            Set the <varname>approval_duration</varname> option of the
 
390
            specified client(s); see <citerefentry><refentrytitle
 
391
            >mandos-clients.conf</refentrytitle><manvolnum
 
392
            >5</manvolnum></citerefentry>.
308
393
          </para>
309
394
        </listitem>
310
395
      </varlistentry>
318
403
          <para>
319
404
            Set the <varname>host</varname> option of the specified
320
405
            client(s); see <citerefentry><refentrytitle
321
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
322
 
            ></citerefentry>.
 
406
            >mandos-clients.conf</refentrytitle><manvolnum
 
407
            >5</manvolnum></citerefentry>.
323
408
          </para>
324
409
        </listitem>
325
410
      </varlistentry>
333
418
          <para>
334
419
            Set the <varname>secfile</varname> option of the specified
335
420
            client(s); see <citerefentry><refentrytitle
336
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
337
 
            ></citerefentry>.
 
421
            >mandos-clients.conf</refentrytitle><manvolnum
 
422
            >5</manvolnum></citerefentry>.
338
423
          </para>
339
424
        </listitem>
340
425
      </varlistentry>
422
507
    <title>EXAMPLE</title>
423
508
    <informalexample>
424
509
      <para>
425
 
        List all clients with some of their settings:
 
510
        To list all clients:
426
511
      </para>
427
512
      <para>
428
513
        <userinput>&COMMANDNAME;</userinput>
429
514
      </para>
430
515
    </informalexample>
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
 
 
 
516
    
 
517
    <informalexample>
 
518
      <para>
 
519
        To list <emphasis>all</emphasis> settings for the clients
 
520
        named <quote>foo1.example.org</quote> and <quote
 
521
        >foo2.example.org</quote>:
 
522
      </para>
 
523
      <para>
 
524
 
 
525
<!-- do not wrap this line -->
 
526
<userinput>&COMMANDNAME; --verbose foo1.example.org foo2.example.org</userinput>
 
527
 
 
528
      </para>
 
529
    </informalexample>
 
530
    
 
531
    <informalexample>
 
532
      <para>
 
533
        To enable all clients:
 
534
      </para>
 
535
      <para>
 
536
        <userinput>&COMMANDNAME; --enable --all</userinput>
 
537
      </para>
 
538
    </informalexample>
 
539
    
 
540
    <informalexample>
 
541
      <para>
 
542
        To change timeout and interval value for the clients
 
543
        named <quote>foo1.example.org</quote> and <quote
 
544
        >foo2.example.org</quote>:
 
545
      </para>
 
546
      <para>
 
547
 
 
548
<!-- do not wrap this line -->
 
549
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
 
550
 
 
551
      </para>
 
552
    </informalexample>
 
553
    
 
554
    <informalexample>
 
555
      <para>
 
556
        To approve all clients currently waiting for it:
 
557
      </para>
 
558
      <para>
 
559
        <userinput>&COMMANDNAME; --approve --all</userinput>
441
560
      </para>
442
561
    </informalexample>
443
562
  </refsect1>
454
573
  <refsect1 id="see_also">
455
574
    <title>SEE ALSO</title>
456
575
    <para>
 
576
      <citerefentry><refentrytitle>intro</refentrytitle>
 
577
      <manvolnum>8mandos</manvolnum></citerefentry>,
457
578
      <citerefentry><refentrytitle>mandos</refentrytitle>
458
579
      <manvolnum>8</manvolnum></citerefentry>,
459
580
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>