/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.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
6
<!ENTITY TIMESTAMP "2008-08-29">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
67
67
  <refnamediv>
68
68
    <refname><command>&COMMANDNAME;</command></refname>
69
69
    <refpurpose>
70
 
      Gives encrypted passwords to authenticated Mandos clients
 
70
      Sends encrypted passwords to authenticated Mandos clients
71
71
    </refpurpose>
72
72
  </refnamediv>
73
73
 
74
74
  <refsynopsisdiv>
75
75
    <cmdsynopsis>
76
76
      <command>&COMMANDNAME;</command>
77
 
      <group>
78
 
        <arg choice="plain"><option>--interface
79
 
        <replaceable>NAME</replaceable></option></arg>
80
 
        <arg choice="plain"><option>-i
81
 
        <replaceable>NAME</replaceable></option></arg>
82
 
      </group>
83
 
      <sbr/>
84
 
      <group>
85
 
        <arg choice="plain"><option>--address
86
 
        <replaceable>ADDRESS</replaceable></option></arg>
87
 
        <arg choice="plain"><option>-a
88
 
        <replaceable>ADDRESS</replaceable></option></arg>
89
 
      </group>
90
 
      <sbr/>
91
 
      <group>
92
 
        <arg choice="plain"><option>--port
93
 
        <replaceable>PORT</replaceable></option></arg>
94
 
        <arg choice="plain"><option>-p
95
 
        <replaceable>PORT</replaceable></option></arg>
96
 
      </group>
97
 
      <sbr/>
98
 
      <arg><option>--priority
99
 
      <replaceable>PRIORITY</replaceable></option></arg>
100
 
      <sbr/>
101
 
      <arg><option>--servicename
102
 
      <replaceable>NAME</replaceable></option></arg>
103
 
      <sbr/>
104
 
      <arg><option>--configdir
105
 
      <replaceable>DIRECTORY</replaceable></option></arg>
106
 
      <sbr/>
107
 
      <arg><option>--debug</option></arg>
 
77
      <arg>--interface<arg choice="plain">NAME</arg></arg>
 
78
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
 
79
      <arg>--port<arg choice="plain">PORT</arg></arg>
 
80
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
81
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
82
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
83
      <arg>--debug</arg>
 
84
    </cmdsynopsis>
 
85
    <cmdsynopsis>
 
86
      <command>&COMMANDNAME;</command>
 
87
      <arg>-i<arg choice="plain">NAME</arg></arg>
 
88
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
 
89
      <arg>-p<arg choice="plain">PORT</arg></arg>
 
90
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
 
91
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
 
92
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
93
      <arg>--debug</arg>
108
94
    </cmdsynopsis>
109
95
    <cmdsynopsis>
110
96
      <command>&COMMANDNAME;</command>
111
97
      <group choice="req">
112
 
        <arg choice="plain"><option>--help</option></arg>
113
 
        <arg choice="plain"><option>-h</option></arg>
 
98
        <arg choice="plain">-h</arg>
 
99
        <arg choice="plain">--help</arg>
114
100
      </group>
115
101
    </cmdsynopsis>
116
102
    <cmdsynopsis>
117
103
      <command>&COMMANDNAME;</command>
118
 
      <arg choice="plain"><option>--version</option></arg>
 
104
      <arg choice="plain">--version</arg>
119
105
    </cmdsynopsis>
120
106
    <cmdsynopsis>
121
107
      <command>&COMMANDNAME;</command>
122
 
      <arg choice="plain"><option>--check</option></arg>
 
108
      <arg choice="plain">--check</arg>
123
109
    </cmdsynopsis>
124
110
  </refsynopsisdiv>
125
111
 
149
135
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
136
      linkend="overview"/> for details.
151
137
    </para>
152
 
    
 
138
 
153
139
  </refsect1>
154
140
  
155
141
  <refsect1 id="options">
156
142
    <title>OPTIONS</title>
157
 
    
 
143
 
158
144
    <variablelist>
159
145
      <varlistentry>
160
 
        <term><option>--help</option></term>
161
 
        <term><option>-h</option></term>
 
146
        <term><literal>-h</literal>, <literal>--help</literal></term>
162
147
        <listitem>
163
148
          <para>
164
149
            Show a help message and exit
165
150
          </para>
166
151
        </listitem>
167
152
      </varlistentry>
168
 
      
 
153
 
169
154
      <varlistentry>
170
 
        <term><option>--interface</option>
171
 
        <replaceable>NAME</replaceable></term>
172
 
        <term><option>-i</option>
173
 
        <replaceable>NAME</replaceable></term>
 
155
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
156
        >NAME</replaceable></literal></term>
174
157
        <listitem>
175
158
          <xi:include href="mandos-options.xml" xpointer="interface"/>
176
159
        </listitem>
177
160
      </varlistentry>
178
 
      
 
161
 
179
162
      <varlistentry>
180
 
        <term><option>--address
181
 
        <replaceable>ADDRESS</replaceable></option></term>
182
 
        <term><option>-a
183
 
        <replaceable>ADDRESS</replaceable></option></term>
 
163
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
164
        ADDRESS</replaceable></literal></term>
184
165
        <listitem>
185
166
          <xi:include href="mandos-options.xml" xpointer="address"/>
186
167
        </listitem>
187
168
      </varlistentry>
188
 
      
 
169
 
189
170
      <varlistentry>
190
 
        <term><option>--port
191
 
        <replaceable>PORT</replaceable></option></term>
192
 
        <term><option>-p
193
 
        <replaceable>PORT</replaceable></option></term>
 
171
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
172
        PORT</replaceable></literal></term>
194
173
        <listitem>
195
174
          <xi:include href="mandos-options.xml" xpointer="port"/>
196
175
        </listitem>
197
176
      </varlistentry>
198
 
      
 
177
 
199
178
      <varlistentry>
200
 
        <term><option>--check</option></term>
 
179
        <term><literal>--check</literal></term>
201
180
        <listitem>
202
181
          <para>
203
182
            Run the server’s self-tests.  This includes any unit
205
184
          </para>
206
185
        </listitem>
207
186
      </varlistentry>
208
 
      
 
187
 
209
188
      <varlistentry>
210
 
        <term><option>--debug</option></term>
 
189
        <term><literal>--debug</literal></term>
211
190
        <listitem>
212
191
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
192
        </listitem>
214
193
      </varlistentry>
215
194
 
216
195
      <varlistentry>
217
 
        <term><option>--priority <replaceable>
218
 
        PRIORITY</replaceable></option></term>
 
196
        <term><literal>--priority <replaceable>
 
197
        PRIORITY</replaceable></literal></term>
219
198
        <listitem>
220
199
          <xi:include href="mandos-options.xml" xpointer="priority"/>
221
200
        </listitem>
222
201
      </varlistentry>
223
202
 
224
203
      <varlistentry>
225
 
        <term><option>--servicename
226
 
        <replaceable>NAME</replaceable></option></term>
 
204
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
205
        </literal></term>
227
206
        <listitem>
228
207
          <xi:include href="mandos-options.xml"
229
208
                      xpointer="servicename"/>
231
210
      </varlistentry>
232
211
 
233
212
      <varlistentry>
234
 
        <term><option>--configdir
235
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
213
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
214
        </literal></term>
236
215
        <listitem>
237
216
          <para>
238
217
            Directory to search for configuration files.  Default is
246
225
      </varlistentry>
247
226
 
248
227
      <varlistentry>
249
 
        <term><option>--version</option></term>
 
228
        <term><literal>--version</literal></term>
250
229
        <listitem>
251
230
          <para>
252
231
            Prints the program version and exit.
360
339
    <title>ENVIRONMENT</title>
361
340
    <variablelist>
362
341
      <varlistentry>
363
 
        <term><envar>PATH</envar></term>
 
342
        <term><varname>PATH</varname></term>
364
343
        <listitem>
365
344
          <para>
366
345
            To start the configured checker (see <xref
561
540
    <title>SEE ALSO</title>
562
541
    <para>
563
542
      <citerefentry>
 
543
        <refentrytitle>mandos.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
545
        <refentrytitle>mandos-clients.conf</refentrytitle>
565
546
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
 
        <refentrytitle>mandos.conf</refentrytitle>
567
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
547
        <refentrytitle>password-request</refentrytitle>
569
548
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
549
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>