/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: 2019-03-07 21:37:10 UTC
  • Revision ID: teddy@recompile.se-20190307213710-brbbpkpqxcq8e444
mandos-ctl.xml: Clarify the conflicting nature of some options

* mandos-ctl.xml (SYNOPSIS): Show --start-checker and --stop-checker
                             as mutually exclusive.  Show --remove as
                             incompatible with everything except
                             --deny.

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-07-29">
 
5
<!ENTITY TIMESTAMP "2019-03-07">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
62
62
  <refsynopsisdiv>
63
63
    <cmdsynopsis>
64
64
      <command>&COMMANDNAME;</command>
65
 
      <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
 
      <arg><option>--debug</option></arg>
73
 
      <group>
74
 
        <arg rep='repeat' choice='plain'>
75
 
          <replaceable>CLIENT</replaceable>
76
 
        </arg>
77
 
      </group>
78
 
    </cmdsynopsis>
79
 
    <cmdsynopsis>
80
 
      <command>&COMMANDNAME;</command>
81
65
      <group choice="req">
82
66
        <group>
83
67
          <arg choice="plain"><option>--enable</option></arg>
163
147
        </group>
164
148
      </group>
165
149
      <sbr/>
166
 
      <arg><option>--debug</option></arg>
167
150
      <group choice="req">
168
151
        <arg choice="plain"><option>--all</option></arg>
169
152
        <arg choice="plain"><option>-a</option></arg>
182
165
          <arg choice="plain"><option>--remove</option></arg>
183
166
          <arg choice="plain"><option>-r</option></arg>
184
167
      </group>
185
 
      <sbr/>
186
 
      <arg><option>--debug</option></arg>
187
168
      <group choice="req">
188
169
        <arg choice="plain"><option>--all</option></arg>
189
170
        <arg choice="plain"><option>-a</option></arg>
194
175
    </cmdsynopsis>
195
176
    <cmdsynopsis>
196
177
      <command>&COMMANDNAME;</command>
 
178
      <group>
 
179
          <arg choice="plain"><option>--verbose</option></arg>
 
180
          <arg choice="plain"><option>-v</option></arg>
 
181
          <sbr/>
 
182
          <arg choice="plain"><option>--dump-json</option></arg>
 
183
          <arg choice="plain"><option>-j</option></arg>
 
184
      </group>
 
185
      <group>
 
186
        <arg rep='repeat' choice='plain'>
 
187
          <replaceable>CLIENT</replaceable>
 
188
        </arg>
 
189
      </group>
 
190
    </cmdsynopsis>
 
191
    <cmdsynopsis>
 
192
      <command>&COMMANDNAME;</command>
197
193
      <group choice="req">
198
194
        <arg choice="plain"><option>--is-enabled</option></arg>
199
195
        <arg choice="plain"><option>-V</option></arg>
200
196
      </group>
201
 
      <arg><option>--debug</option></arg>
202
197
      <arg choice='plain'><replaceable>CLIENT</replaceable></arg>
203
198
    </cmdsynopsis>
204
199
    <cmdsynopsis>
512
507
      </varlistentry>
513
508
      
514
509
      <varlistentry>
515
 
        <term><option>--debug</option></term>
516
 
        <listitem>
517
 
          <para>
518
 
            Show debug output; currently, this means show D-Bus calls.
519
 
          </para>
520
 
        </listitem>
521
 
      </varlistentry>
522
 
      
523
 
      <varlistentry>
524
510
        <term><option>--check</option></term>
525
511
        <listitem>
526
512
          <para>
557
543
  
558
544
  <refsect1 id="example">
559
545
    <title>EXAMPLE</title>
560
 
    <!-- Name of test methods in class Test_commands_from_options are
561
 
         written in comments below.  When adding an example, add a
562
 
         test too which tests the documented behavior. -->
563
546
    <informalexample>
564
 
      <!-- Test method: test_manual_page_example_1() -->
565
547
      <para>
566
548
        To list all clients:
567
549
      </para>
571
553
    </informalexample>
572
554
    
573
555
    <informalexample>
574
 
      <!-- Test method: test_manual_page_example_2() -->
575
556
      <para>
576
557
        To list <emphasis>all</emphasis> settings for the clients
577
558
        named <quote>foo1.example.org</quote> and <quote
586
567
    </informalexample>
587
568
    
588
569
    <informalexample>
589
 
      <!-- Test method: test_manual_page_example_3() -->
590
570
      <para>
591
571
        To enable all clients:
592
572
      </para>
596
576
    </informalexample>
597
577
    
598
578
    <informalexample>
599
 
      <!-- Test method: test_manual_page_example_4() -->
600
579
      <para>
601
580
        To change timeout and interval value for the clients
602
581
        named <quote>foo1.example.org</quote> and <quote
605
584
      <para>
606
585
 
607
586
<!-- do not wrap this line -->
608
 
<userinput>&COMMANDNAME; --timeout=PT5M --interval=PT1M foo1.example.org foo2.example.org</userinput>
 
587
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
609
588
 
610
589
      </para>
611
590
    </informalexample>
612
591
    
613
592
    <informalexample>
614
 
      <!-- Test method: test_manual_page_example_5() -->
615
593
      <para>
616
 
        To approve all clients currently waiting for approval:
 
594
        To approve all clients currently waiting for it:
617
595
      </para>
618
596
      <para>
619
597
        <userinput>&COMMANDNAME; --approve --all</userinput>