/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-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
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>-h</option></term>
160
161
        <term><option>--help</option></term>
161
 
        <term><option>-h</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>-i</option>
 
171
        <replaceable>NAME</replaceable></term>
170
172
        <term><option>--interface</option>
171
173
        <replaceable>NAME</replaceable></term>
172
 
        <term><option>-i</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><option>--address
181
 
        <replaceable>ADDRESS</replaceable></option></term>
182
 
        <term><option>-a
183
 
        <replaceable>ADDRESS</replaceable></option></term>
 
180
        <term><literal>-a</literal>, <literal>--address <replaceable>
 
181
        ADDRESS</replaceable></literal></term>
184
182
        <listitem>
185
183
          <xi:include href="mandos-options.xml" xpointer="address"/>
186
184
        </listitem>
187
185
      </varlistentry>
188
 
      
 
186
 
189
187
      <varlistentry>
190
 
        <term><option>--port
191
 
        <replaceable>PORT</replaceable></option></term>
192
 
        <term><option>-p
193
 
        <replaceable>PORT</replaceable></option></term>
 
188
        <term><literal>-p</literal>, <literal>--port <replaceable>
 
189
        PORT</replaceable></literal></term>
194
190
        <listitem>
195
191
          <xi:include href="mandos-options.xml" xpointer="port"/>
196
192
        </listitem>
197
193
      </varlistentry>
198
 
      
 
194
 
199
195
      <varlistentry>
200
 
        <term><option>--check</option></term>
 
196
        <term><literal>--check</literal></term>
201
197
        <listitem>
202
198
          <para>
203
199
            Run the server’s self-tests.  This includes any unit
205
201
          </para>
206
202
        </listitem>
207
203
      </varlistentry>
208
 
      
 
204
 
209
205
      <varlistentry>
210
 
        <term><option>--debug</option></term>
 
206
        <term><literal>--debug</literal></term>
211
207
        <listitem>
212
208
          <xi:include href="mandos-options.xml" xpointer="debug"/>
213
209
        </listitem>
214
210
      </varlistentry>
215
211
 
216
212
      <varlistentry>
217
 
        <term><option>--priority <replaceable>
218
 
        PRIORITY</replaceable></option></term>
 
213
        <term><literal>--priority <replaceable>
 
214
        PRIORITY</replaceable></literal></term>
219
215
        <listitem>
220
216
          <xi:include href="mandos-options.xml" xpointer="priority"/>
221
217
        </listitem>
222
218
      </varlistentry>
223
219
 
224
220
      <varlistentry>
225
 
        <term><option>--servicename
226
 
        <replaceable>NAME</replaceable></option></term>
 
221
        <term><literal>--servicename <replaceable>NAME</replaceable>
 
222
        </literal></term>
227
223
        <listitem>
228
224
          <xi:include href="mandos-options.xml"
229
225
                      xpointer="servicename"/>
231
227
      </varlistentry>
232
228
 
233
229
      <varlistentry>
234
 
        <term><option>--configdir
235
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
230
        <term><literal>--configdir <replaceable>DIR</replaceable>
 
231
        </literal></term>
236
232
        <listitem>
237
233
          <para>
238
234
            Directory to search for configuration files.  Default is
246
242
      </varlistentry>
247
243
 
248
244
      <varlistentry>
249
 
        <term><option>--version</option></term>
 
245
        <term><literal>--version</literal></term>
250
246
        <listitem>
251
247
          <para>
252
248
            Prints the program version and exit.