/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

merge

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-09-12">
 
6
<!ENTITY TIMESTAMP "2008-09-01">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
36
36
    </copyright>
37
37
    <xi:include href="legalnotice.xml"/>
38
38
  </refentryinfo>
39
 
  
 
39
 
40
40
  <refmeta>
41
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
42
    <manvolnum>8</manvolnum>
48
48
      Gives encrypted passwords to authenticated Mandos clients
49
49
    </refpurpose>
50
50
  </refnamediv>
51
 
  
 
51
 
52
52
  <refsynopsisdiv>
53
53
    <cmdsynopsis>
54
54
      <command>&COMMANDNAME;</command>
100
100
      <arg choice="plain"><option>--check</option></arg>
101
101
    </cmdsynopsis>
102
102
  </refsynopsisdiv>
103
 
  
 
103
 
104
104
  <refsect1 id="description">
105
105
    <title>DESCRIPTION</title>
106
106
    <para>
115
115
      Any authenticated client is then given the stored pre-encrypted
116
116
      password for that specific client.
117
117
    </para>
 
118
 
118
119
  </refsect1>
119
120
  
120
121
  <refsect1 id="purpose">
121
122
    <title>PURPOSE</title>
 
123
 
122
124
    <para>
123
125
      The purpose of this is to enable <emphasis>remote and unattended
124
126
      rebooting</emphasis> of client host computer with an
125
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
126
128
      linkend="overview"/> for details.
127
129
    </para>
 
130
    
128
131
  </refsect1>
129
132
  
130
133
  <refsect1 id="options">
131
134
    <title>OPTIONS</title>
 
135
    
132
136
    <variablelist>
133
137
      <varlistentry>
134
138
        <term><option>--help</option></term>
186
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
187
191
        </listitem>
188
192
      </varlistentry>
189
 
      
 
193
 
190
194
      <varlistentry>
191
195
        <term><option>--priority <replaceable>
192
196
        PRIORITY</replaceable></option></term>
194
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
195
199
        </listitem>
196
200
      </varlistentry>
197
 
      
 
201
 
198
202
      <varlistentry>
199
203
        <term><option>--servicename
200
204
        <replaceable>NAME</replaceable></option></term>
203
207
                      xpointer="servicename"/>
204
208
        </listitem>
205
209
      </varlistentry>
206
 
      
 
210
 
207
211
      <varlistentry>
208
212
        <term><option>--configdir
209
213
        <replaceable>DIRECTORY</replaceable></option></term>
218
222
          </para>
219
223
        </listitem>
220
224
      </varlistentry>
221
 
      
 
225
 
222
226
      <varlistentry>
223
227
        <term><option>--version</option></term>
224
228
        <listitem>
229
233
      </varlistentry>
230
234
    </variablelist>
231
235
  </refsect1>
232
 
  
 
236
 
233
237
  <refsect1 id="overview">
234
238
    <title>OVERVIEW</title>
235
239
    <xi:include href="overview.xml"/>
239
243
      <acronym>RAM</acronym> disk environment.
240
244
    </para>
241
245
  </refsect1>
242
 
  
 
246
 
243
247
  <refsect1 id="protocol">
244
248
    <title>NETWORK PROTOCOL</title>
245
249
    <para>
297
301
      </row>
298
302
    </tbody></tgroup></table>
299
303
  </refsect1>
300
 
  
 
304
 
301
305
  <refsect1 id="checking">
302
306
    <title>CHECKING</title>
303
307
    <para>
311
315
      <manvolnum>5</manvolnum></citerefentry>.
312
316
    </para>
313
317
  </refsect1>
314
 
  
 
318
 
315
319
  <refsect1 id="logging">
316
320
    <title>LOGGING</title>
317
321
    <para>
321
325
      and also show them on the console.
322
326
    </para>
323
327
  </refsect1>
324
 
  
 
328
 
325
329
  <refsect1 id="exit_status">
326
330
    <title>EXIT STATUS</title>
327
331
    <para>
329
333
      critical error is encountered.
330
334
    </para>
331
335
  </refsect1>
332
 
  
 
336
 
333
337
  <refsect1 id="environment">
334
338
    <title>ENVIRONMENT</title>
335
339
    <variablelist>
349
353
      </varlistentry>
350
354
    </variablelist>
351
355
  </refsect1>
352
 
  
 
356
 
353
357
  <refsect1 id="file">
354
358
    <title>FILES</title>
355
359
    <para>
379
383
        </listitem>
380
384
      </varlistentry>
381
385
      <varlistentry>
382
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
386
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
383
387
        <listitem>
384
388
          <para>
385
389
            The file containing the process id of
434
438
      Debug mode is conflated with running in the foreground.
435
439
    </para>
436
440
    <para>
437
 
      The console log messages does not show a time stamp.
438
 
    </para>
439
 
    <para>
440
 
      This server does not check the expire time of clients’ OpenPGP
441
 
      keys.
 
441
      The console log messages does not show a timestamp.
442
442
    </para>
443
443
  </refsect1>
444
444
  
479
479
      </para>
480
480
    </informalexample>
481
481
  </refsect1>
482
 
  
 
482
 
483
483
  <refsect1 id="security">
484
484
    <title>SECURITY</title>
485
485
    <refsect2 id="SERVER">
487
487
      <para>
488
488
        Running this <command>&COMMANDNAME;</command> server program
489
489
        should not in itself present any security risk to the host
490
 
        computer running it.  The program switches to a non-root user
491
 
        soon after startup.
 
490
        computer running it.  The program does not need any special
 
491
        privileges to run, and is designed to run as a non-root user.
492
492
      </para>
493
493
    </refsect2>
494
494
    <refsect2 id="CLIENTS">
529
529
      </para>
530
530
      <para>
531
531
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
533
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
534
      </para>
535
535
    </refsect2>
536
536
  </refsect1>
537
 
  
 
537
 
538
538
  <refsect1 id="see_also">
539
539
    <title>SEE ALSO</title>
540
540
    <para>
543
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
544
        <refentrytitle>mandos.conf</refentrytitle>
545
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>mandos-client</refentrytitle>
 
546
        <refentrytitle>password-request</refentrytitle>
547
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
549
      </citerefentry>