/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-08-04 12:42:49 UTC
  • Revision ID: teddy@recompile.se-20190804124249-69cq19d1bgbmm0gh
Describe role of password-agent(8mandos) in intro(8mandos)

Describe the role of password-agent(8mandos) in the intro(8mandos)
manual.

* intro.xml (SYSTEMD): New section.
  (SEE ALSO): Add reference to password-agent(8mandos).

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