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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 12:23:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831122333-qgppahxb4d4b0coc
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
                                            the ones in the SYNOPSIS.
                                            Split <term> tags into one
                                            for each option.  Use
                                            <option> tags instead of
                                            <literal>.  Moved long
                                            options before short.

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-30">
 
6
<!ENTITY TIMESTAMP "2008-08-31">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
109
109
    <cmdsynopsis>
110
110
      <command>&COMMANDNAME;</command>
111
111
      <group choice="req">
 
112
        <arg choice="plain"><option>--help</option></arg>
112
113
        <arg choice="plain"><option>-h</option></arg>
113
 
        <arg choice="plain"><option>--help</option></arg>
114
114
      </group>
115
115
    </cmdsynopsis>
116
116
    <cmdsynopsis>
149
149
      <emphasis>encrypted root file system</emphasis>.  See <xref
150
150
      linkend="overview"/> for details.
151
151
    </para>
152
 
 
 
152
    
153
153
  </refsect1>
154
154
  
155
155
  <refsect1 id="options">
156
156
    <title>OPTIONS</title>
157
 
 
 
157
    
158
158
    <variablelist>
159
159
      <varlistentry>
 
160
        <term><option>--help</option></term>
160
161
        <term><option>-h</option></term>
161
 
        <term><option>--help</option></term>
162
162
        <listitem>
163
163
          <para>
164
164
            Show a help message and exit
165
165
          </para>
166
166
        </listitem>
167
167
      </varlistentry>
168
 
 
 
168
      
169
169
      <varlistentry>
 
170
        <term><option>--interface</option>
 
171
        <replaceable>NAME</replaceable></term>
170
172
        <term><option>-i</option>
171
173
        <replaceable>NAME</replaceable></term>
172
 
        <term><option>--interface</option>
173
 
        <replaceable>NAME</replaceable></term>
174
174
        <listitem>
175
175
          <xi:include href="mandos-options.xml" xpointer="interface"/>
176
176
        </listitem>
177
177
      </varlistentry>
178
 
 
 
178
      
179
179
      <varlistentry>
180
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
181
 
        ADDRESS</replaceable></literal></term>
 
180
        <term><option>--address
 
181
        <replaceable>ADDRESS</replaceable></option></term>
 
182
        <term><option>-a
 
183
        <replaceable>ADDRESS</replaceable></option></term>
182
184
        <listitem>
183
185
          <xi:include href="mandos-options.xml" xpointer="address"/>
184
186
        </listitem>
185
187
      </varlistentry>
186
 
 
 
188
      
187
189
      <varlistentry>
188
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
189
 
        PORT</replaceable></literal></term>
 
190
        <term><option>--port
 
191
        <replaceable>PORT</replaceable></option></term>
 
192
        <term><option>-p
 
193
        <replaceable>PORT</replaceable></option></term>
190
194
        <listitem>
191
195
          <xi:include href="mandos-options.xml" xpointer="port"/>
192
196
        </listitem>
193
197
      </varlistentry>
194
 
 
 
198
      
195
199
      <varlistentry>
196
 
        <term><literal>--check</literal></term>
 
200
        <term><option>--check</option></term>
197
201
        <listitem>
198
202
          <para>
199
203
            Run the server’s self-tests.  This includes any unit
201
205
          </para>
202
206
        </listitem>
203
207
      </varlistentry>
204
 
 
 
208
      
205
209
      <varlistentry>
206
 
        <term><literal>--debug</literal></term>
 
210
        <term><option>--debug</option></term>
207
211
        <listitem>
208
212
          <xi:include href="mandos-options.xml" xpointer="debug"/>
209
213
        </listitem>
210
214
      </varlistentry>
211
215
 
212
216
      <varlistentry>
213
 
        <term><literal>--priority <replaceable>
214
 
        PRIORITY</replaceable></literal></term>
 
217
        <term><option>--priority <replaceable>
 
218
        PRIORITY</replaceable></option></term>
215
219
        <listitem>
216
220
          <xi:include href="mandos-options.xml" xpointer="priority"/>
217
221
        </listitem>
218
222
      </varlistentry>
219
223
 
220
224
      <varlistentry>
221
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
222
 
        </literal></term>
 
225
        <term><option>--servicename
 
226
        <replaceable>NAME</replaceable></option></term>
223
227
        <listitem>
224
228
          <xi:include href="mandos-options.xml"
225
229
                      xpointer="servicename"/>
227
231
      </varlistentry>
228
232
 
229
233
      <varlistentry>
230
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
231
 
        </literal></term>
 
234
        <term><option>--configdir
 
235
        <replaceable>DIRECTORY</replaceable></option></term>
232
236
        <listitem>
233
237
          <para>
234
238
            Directory to search for configuration files.  Default is
242
246
      </varlistentry>
243
247
 
244
248
      <varlistentry>
245
 
        <term><literal>--version</literal></term>
 
249
        <term><option>--version</option></term>
246
250
        <listitem>
247
251
          <para>
248
252
            Prints the program version and exit.