/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-06 22:24:59 UTC
  • Revision ID: teddy@recompile.se-20190306222459-7q5j7dqwtiiwglg7
mandos-ctl.xml: Fix documentation bug

* mandos-ctl.xml (SYNOPSIS): Remove duplicate "--interval" option.

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-06">
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>
94
78
        <sbr/>
95
79
        <group>
96
80
          <arg choice="plain"><option>--start-checker</option></arg>
 
81
        </group>
 
82
        <sbr/>
 
83
        <group>
97
84
          <arg choice="plain"><option>--stop-checker</option></arg>
98
85
        </group>
99
86
        <sbr/>
100
87
        <group>
 
88
          <arg choice="plain"><option>--remove</option></arg>
 
89
          <arg choice="plain"><option>-r</option></arg>
 
90
        </group>
 
91
        <sbr/>
 
92
        <group>
101
93
          <arg choice="plain"><option>--checker
102
94
          <replaceable>COMMAND</replaceable></option></arg>
103
95
          <arg choice="plain"><option>-c
163
155
        </group>
164
156
      </group>
165
157
      <sbr/>
166
 
      <arg><option>--debug</option></arg>
167
158
      <group choice="req">
168
159
        <arg choice="plain"><option>--all</option></arg>
169
160
        <arg choice="plain"><option>-a</option></arg>
175
166
    <cmdsynopsis>
176
167
      <command>&COMMANDNAME;</command>
177
168
      <group>
178
 
        <arg choice="plain"><option>--deny</option></arg>
179
 
        <arg choice="plain"><option>-D</option></arg>
180
 
      </group>
181
 
      <group choice="req">
182
 
          <arg choice="plain"><option>--remove</option></arg>
183
 
          <arg choice="plain"><option>-r</option></arg>
184
 
      </group>
185
 
      <sbr/>
186
 
      <arg><option>--debug</option></arg>
187
 
      <group choice="req">
188
 
        <arg choice="plain"><option>--all</option></arg>
189
 
        <arg choice="plain"><option>-a</option></arg>
 
169
          <arg choice="plain"><option>--verbose</option></arg>
 
170
          <arg choice="plain"><option>-v</option></arg>
 
171
          <sbr/>
 
172
          <arg choice="plain"><option>--dump-json</option></arg>
 
173
          <arg choice="plain"><option>-j</option></arg>
 
174
      </group>
 
175
      <group>
190
176
        <arg rep='repeat' choice='plain'>
191
177
          <replaceable>CLIENT</replaceable>
192
178
        </arg>
198
184
        <arg choice="plain"><option>--is-enabled</option></arg>
199
185
        <arg choice="plain"><option>-V</option></arg>
200
186
      </group>
201
 
      <arg><option>--debug</option></arg>
202
187
      <arg choice='plain'><replaceable>CLIENT</replaceable></arg>
203
188
    </cmdsynopsis>
204
189
    <cmdsynopsis>
512
497
      </varlistentry>
513
498
      
514
499
      <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
500
        <term><option>--check</option></term>
525
501
        <listitem>
526
502
          <para>
557
533
  
558
534
  <refsect1 id="example">
559
535
    <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
536
    <informalexample>
564
 
      <!-- Test method: test_manual_page_example_1() -->
565
537
      <para>
566
538
        To list all clients:
567
539
      </para>
571
543
    </informalexample>
572
544
    
573
545
    <informalexample>
574
 
      <!-- Test method: test_manual_page_example_2() -->
575
546
      <para>
576
547
        To list <emphasis>all</emphasis> settings for the clients
577
548
        named <quote>foo1.example.org</quote> and <quote
586
557
    </informalexample>
587
558
    
588
559
    <informalexample>
589
 
      <!-- Test method: test_manual_page_example_3() -->
590
560
      <para>
591
561
        To enable all clients:
592
562
      </para>
596
566
    </informalexample>
597
567
    
598
568
    <informalexample>
599
 
      <!-- Test method: test_manual_page_example_4() -->
600
569
      <para>
601
570
        To change timeout and interval value for the clients
602
571
        named <quote>foo1.example.org</quote> and <quote
605
574
      <para>
606
575
 
607
576
<!-- do not wrap this line -->
608
 
<userinput>&COMMANDNAME; --timeout=PT5M --interval=PT1M foo1.example.org foo2.example.org</userinput>
 
577
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
609
578
 
610
579
      </para>
611
580
    </informalexample>
612
581
    
613
582
    <informalexample>
614
 
      <!-- Test method: test_manual_page_example_5() -->
615
583
      <para>
616
 
        To approve all clients currently waiting for approval:
 
584
        To approve all clients currently waiting for it:
617
585
      </para>
618
586
      <para>
619
587
        <userinput>&COMMANDNAME; --approve --all</userinput>