/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: 2016-11-26 23:21:16 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 356.
  • Revision ID: teddy@recompile.se-20161126232116-nhqk9x1qij09b7cx
Add comment in documentation source with clarifying text.

* intro.xml (INTRODUCTION): Add comment with clarification.

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 "2016-06-27">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
38
38
      <year>2014</year>
39
39
      <year>2015</year>
40
40
      <year>2016</year>
41
 
      <year>2017</year>
42
 
      <year>2018</year>
43
 
      <year>2019</year>
44
41
      <holder>Teddy Hogeborn</holder>
45
42
      <holder>Björn Påhlsson</holder>
46
43
    </copyright>
62
59
  <refsynopsisdiv>
63
60
    <cmdsynopsis>
64
61
      <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
62
      <group choice="req">
82
63
        <group>
83
64
          <arg choice="plain"><option>--enable</option></arg>
94
75
        <sbr/>
95
76
        <group>
96
77
          <arg choice="plain"><option>--start-checker</option></arg>
 
78
        </group>
 
79
        <sbr/>
 
80
        <group>
97
81
          <arg choice="plain"><option>--stop-checker</option></arg>
98
82
        </group>
99
83
        <sbr/>
100
84
        <group>
 
85
          <arg choice="plain"><option>--remove</option></arg>
 
86
          <arg choice="plain"><option>-r</option></arg>
 
87
        </group>
 
88
        <sbr/>
 
89
        <group>
101
90
          <arg choice="plain"><option>--checker
102
91
          <replaceable>COMMAND</replaceable></option></arg>
103
92
          <arg choice="plain"><option>-c
141
130
        </group>
142
131
        <sbr/>
143
132
        <group>
 
133
          <arg choice="plain"><option>--interval
 
134
          <replaceable>TIME</replaceable></option></arg>
 
135
          <arg choice="plain"><option>-i
 
136
          <replaceable>TIME</replaceable></option></arg>
 
137
        </group>
 
138
        <sbr/>
 
139
        <group>
144
140
          <arg choice="plain"><option>--host
145
141
          <replaceable>STRING</replaceable></option></arg>
146
142
          <arg choice="plain"><option>-H
163
159
        </group>
164
160
      </group>
165
161
      <sbr/>
166
 
      <arg><option>--debug</option></arg>
167
162
      <group choice="req">
168
163
        <arg choice="plain"><option>--all</option></arg>
169
164
        <arg choice="plain"><option>-a</option></arg>
175
170
    <cmdsynopsis>
176
171
      <command>&COMMANDNAME;</command>
177
172
      <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>
 
173
          <arg choice="plain"><option>--verbose</option></arg>
 
174
          <arg choice="plain"><option>-v</option></arg>
 
175
          <sbr/>
 
176
          <arg choice="plain"><option>--dump-json</option></arg>
 
177
          <arg choice="plain"><option>-j</option></arg>
 
178
      </group>
 
179
      <group>
190
180
        <arg rep='repeat' choice='plain'>
191
181
          <replaceable>CLIENT</replaceable>
192
182
        </arg>
198
188
        <arg choice="plain"><option>--is-enabled</option></arg>
199
189
        <arg choice="plain"><option>-V</option></arg>
200
190
      </group>
201
 
      <arg><option>--debug</option></arg>
202
191
      <arg choice='plain'><replaceable>CLIENT</replaceable></arg>
203
192
    </cmdsynopsis>
204
193
    <cmdsynopsis>
512
501
      </varlistentry>
513
502
      
514
503
      <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
504
        <term><option>--check</option></term>
525
505
        <listitem>
526
506
          <para>
557
537
  
558
538
  <refsect1 id="example">
559
539
    <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
540
    <informalexample>
564
 
      <!-- Test method: test_manual_page_example_1() -->
565
541
      <para>
566
542
        To list all clients:
567
543
      </para>
571
547
    </informalexample>
572
548
    
573
549
    <informalexample>
574
 
      <!-- Test method: test_manual_page_example_2() -->
575
550
      <para>
576
551
        To list <emphasis>all</emphasis> settings for the clients
577
552
        named <quote>foo1.example.org</quote> and <quote
586
561
    </informalexample>
587
562
    
588
563
    <informalexample>
589
 
      <!-- Test method: test_manual_page_example_3() -->
590
564
      <para>
591
565
        To enable all clients:
592
566
      </para>
596
570
    </informalexample>
597
571
    
598
572
    <informalexample>
599
 
      <!-- Test method: test_manual_page_example_4() -->
600
573
      <para>
601
574
        To change timeout and interval value for the clients
602
575
        named <quote>foo1.example.org</quote> and <quote
605
578
      <para>
606
579
 
607
580
<!-- do not wrap this line -->
608
 
<userinput>&COMMANDNAME; --timeout=PT5M --interval=PT1M foo1.example.org foo2.example.org</userinput>
 
581
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
609
582
 
610
583
      </para>
611
584
    </informalexample>
612
585
    
613
586
    <informalexample>
614
 
      <!-- Test method: test_manual_page_example_5() -->
615
587
      <para>
616
 
        To approve all clients currently waiting for approval:
 
588
        To approve all clients currently waiting for it:
617
589
      </para>
618
590
      <para>
619
591
        <userinput>&COMMANDNAME; --approve --all</userinput>