/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: 2024-09-08 00:11:24 UTC
  • Revision ID: teddy@recompile.se-20240908001124-nq0ja17503ua9nmw
Minor documentation improvements 

* TODO (mandos-applet): Add link.
* debian/mandos-client.README.Debian: Fix spelling.

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-03-07">
 
5
<!ENTITY TIMESTAMP "2019-07-29">
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>
65
81
      <group choice="req">
66
82
        <group>
67
83
          <arg choice="plain"><option>--enable</option></arg>
147
163
        </group>
148
164
      </group>
149
165
      <sbr/>
 
166
      <arg><option>--debug</option></arg>
150
167
      <group choice="req">
151
168
        <arg choice="plain"><option>--all</option></arg>
152
169
        <arg choice="plain"><option>-a</option></arg>
165
182
          <arg choice="plain"><option>--remove</option></arg>
166
183
          <arg choice="plain"><option>-r</option></arg>
167
184
      </group>
 
185
      <sbr/>
 
186
      <arg><option>--debug</option></arg>
168
187
      <group choice="req">
169
188
        <arg choice="plain"><option>--all</option></arg>
170
189
        <arg choice="plain"><option>-a</option></arg>
175
194
    </cmdsynopsis>
176
195
    <cmdsynopsis>
177
196
      <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>
193
197
      <group choice="req">
194
198
        <arg choice="plain"><option>--is-enabled</option></arg>
195
199
        <arg choice="plain"><option>-V</option></arg>
196
200
      </group>
 
201
      <arg><option>--debug</option></arg>
197
202
      <arg choice='plain'><replaceable>CLIENT</replaceable></arg>
198
203
    </cmdsynopsis>
199
204
    <cmdsynopsis>
507
512
      </varlistentry>
508
513
      
509
514
      <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>
510
524
        <term><option>--check</option></term>
511
525
        <listitem>
512
526
          <para>
543
557
  
544
558
  <refsect1 id="example">
545
559
    <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. -->
546
563
    <informalexample>
 
564
      <!-- Test method: test_manual_page_example_1() -->
547
565
      <para>
548
566
        To list all clients:
549
567
      </para>
553
571
    </informalexample>
554
572
    
555
573
    <informalexample>
 
574
      <!-- Test method: test_manual_page_example_2() -->
556
575
      <para>
557
576
        To list <emphasis>all</emphasis> settings for the clients
558
577
        named <quote>foo1.example.org</quote> and <quote
567
586
    </informalexample>
568
587
    
569
588
    <informalexample>
 
589
      <!-- Test method: test_manual_page_example_3() -->
570
590
      <para>
571
591
        To enable all clients:
572
592
      </para>
576
596
    </informalexample>
577
597
    
578
598
    <informalexample>
 
599
      <!-- Test method: test_manual_page_example_4() -->
579
600
      <para>
580
601
        To change timeout and interval value for the clients
581
602
        named <quote>foo1.example.org</quote> and <quote
584
605
      <para>
585
606
 
586
607
<!-- do not wrap this line -->
587
 
<userinput>&COMMANDNAME; --timeout="5m" --interval="1m" foo1.example.org foo2.example.org</userinput>
 
608
<userinput>&COMMANDNAME; --timeout=PT5M --interval=PT1M foo1.example.org foo2.example.org</userinput>
588
609
 
589
610
      </para>
590
611
    </informalexample>
591
612
    
592
613
    <informalexample>
 
614
      <!-- Test method: test_manual_page_example_5() -->
593
615
      <para>
594
 
        To approve all clients currently waiting for it:
 
616
        To approve all clients currently waiting for approval:
595
617
      </para>
596
618
      <para>
597
619
        <userinput>&COMMANDNAME; --approve --all</userinput>