/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

Merge from release branch.

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-21">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
101
101
      </group>
102
102
      <sbr/>
103
103
      <group>
 
104
        <arg choice="plain"><option>--approve-by-default</option
 
105
        ></arg>
 
106
        <sbr/>
 
107
        <arg choice="plain"><option>--deny-by-default</option></arg>
 
108
      </group>
 
109
      <sbr/>
 
110
      <group>
 
111
        <arg choice="plain"><option>--approval-delay
 
112
        <replaceable>TIME</replaceable></option></arg>
 
113
      </group>
 
114
      <sbr/>
 
115
      <group>
 
116
        <arg choice="plain"><option>--approval-duration
 
117
        <replaceable>TIME</replaceable></option></arg>
 
118
      </group>
 
119
      <sbr/>
 
120
      <group>
 
121
        <arg choice="plain"><option>--interval
 
122
        <replaceable>TIME</replaceable></option></arg>
 
123
        <arg choice="plain"><option>-i
 
124
        <replaceable>TIME</replaceable></option></arg>
 
125
      </group>
 
126
      <sbr/>
 
127
      <group>
104
128
        <arg choice="plain"><option>--host
105
129
        <replaceable>STRING</replaceable></option></arg>
106
130
        <arg choice="plain"><option>-H
273
297
          <para>
274
298
            Set the <varname>checker</varname> option of the specified
275
299
            client(s); see <citerefentry><refentrytitle
276
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
277
 
            ></citerefentry>.
 
300
            >mandos-clients.conf</refentrytitle><manvolnum
 
301
            >5</manvolnum></citerefentry>.
278
302
          </para>
279
303
        </listitem>
280
304
      </varlistentry>
288
312
          <para>
289
313
            Set the <varname>timeout</varname> option of the specified
290
314
            client(s); see <citerefentry><refentrytitle
291
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
292
 
            ></citerefentry>.
 
315
            >mandos-clients.conf</refentrytitle><manvolnum
 
316
            >5</manvolnum></citerefentry>.
293
317
          </para>
294
318
        </listitem>
295
319
      </varlistentry>
301
325
        <replaceable>TIME</replaceable></option></term>
302
326
        <listitem>
303
327
          <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>.
 
328
            Set the <varname>interval</varname> option of the
 
329
            specified 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>--approve-by-default</option></term>
 
338
        <term><option>--deny-by-default</option></term>
 
339
        <listitem>
 
340
          <para>
 
341
            Set the <varname>approved_by_default</varname> option of
 
342
            the specified client(s) to <literal>True</literal> or
 
343
            <literal>False</literal>, respectively; see
 
344
            <citerefentry><refentrytitle
 
345
            >mandos-clients.conf</refentrytitle><manvolnum
 
346
            >5</manvolnum></citerefentry>.
 
347
          </para>
 
348
        </listitem>
 
349
      </varlistentry>
 
350
      
 
351
      <varlistentry>
 
352
        <term><option>--approval-delay
 
353
        <replaceable>TIME</replaceable></option></term>
 
354
        <listitem>
 
355
          <para>
 
356
            Set the <varname>approval_delay</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>--approval-duration
 
366
        <replaceable>TIME</replaceable></option></term>
 
367
        <listitem>
 
368
          <para>
 
369
            Set the <varname>approval_duration</varname> option of the
 
370
            specified client(s); see <citerefentry><refentrytitle
 
371
            >mandos-clients.conf</refentrytitle><manvolnum
 
372
            >5</manvolnum></citerefentry>.
308
373
          </para>
309
374
        </listitem>
310
375
      </varlistentry>
318
383
          <para>
319
384
            Set the <varname>host</varname> option of the specified
320
385
            client(s); see <citerefentry><refentrytitle
321
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
322
 
            ></citerefentry>.
 
386
            >mandos-clients.conf</refentrytitle><manvolnum
 
387
            >5</manvolnum></citerefentry>.
323
388
          </para>
324
389
        </listitem>
325
390
      </varlistentry>
333
398
          <para>
334
399
            Set the <varname>secfile</varname> option of the specified
335
400
            client(s); see <citerefentry><refentrytitle
336
 
            >mandos-client.conf</refentrytitle><manvolnum>5</manvolnum
337
 
            ></citerefentry>.
 
401
            >mandos-clients.conf</refentrytitle><manvolnum
 
402
            >5</manvolnum></citerefentry>.
338
403
          </para>
339
404
        </listitem>
340
405
      </varlistentry>
422
487
    <title>EXAMPLE</title>
423
488
    <informalexample>
424
489
      <para>
425
 
        List all clients with some of their settings:
 
490
        To list all clients:
426
491
      </para>
427
492
      <para>
428
493
        <userinput>&COMMANDNAME;</userinput>
429
494
      </para>
430
495
    </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
 
 
 
496
    
 
497
    <informalexample>
 
498
      <para>
 
499
        To list <emphasis>all</emphasis> settings for the clients
 
500
        named <quote>foo1.example.org</quote> and <quote
 
501
        >foo2.example.org</quote>:
 
502
      </para>
 
503
      <para>
 
504
 
 
505
<!-- do not wrap this line -->
 
506
<userinput>&COMMANDNAME; --verbose foo1.example.org foo2.example.org</userinput>
 
507
 
 
508
      </para>
 
509
    </informalexample>
 
510
    
 
511
    <informalexample>
 
512
      <para>
 
513
        To enable all clients:
 
514
      </para>
 
515
      <para>
 
516
        <userinput>&COMMANDNAME; --enable --all</userinput>
 
517
      </para>
 
518
    </informalexample>
 
519
    
 
520
    <informalexample>
 
521
      <para>
 
522
        To change timeout and interval value for the clients
 
523
        named <quote>foo1.example.org</quote> and <quote
 
524
        >foo2.example.org</quote>:
 
525
      </para>
 
526
      <para>
 
527
 
 
528
<!-- do not wrap this line -->
 
529
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
 
530
 
 
531
      </para>
 
532
    </informalexample>
 
533
    
 
534
    <informalexample>
 
535
      <para>
 
536
        To approve all clients currently waiting for it:
 
537
      </para>
 
538
      <para>
 
539
        <userinput>&COMMANDNAME; --approve --all</userinput>
441
540
      </para>
442
541
    </informalexample>
443
542
  </refsect1>