/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-09-01 08:29:23 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901082923-i2liq6t7warmu9xe
* mandos.xml: Enclose "RAM" with <acronym>.
* overview.xml: - '' -

* plugin-runner.xml (DESCRIPTION): Improved wording.
  (PURPOSE): New section.
  (OPTIONS): Improved wording.
  (OVERVIEW, PLUGINS): New section.
  (FALLBACK): New empty placeholder section.

* plugins.d/password-prompt.xml: Enclose "RAM" with <acronym>.

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-29">
 
6
<!ENTITY TIMESTAMP "2008-09-01">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
34
34
      <holder>Teddy Hogeborn</holder>
35
35
      <holder>Björn Påhlsson</holder>
36
36
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
37
    <xi:include href="legalnotice.xml"/>
60
38
  </refentryinfo>
61
39
 
62
40
  <refmeta>
67
45
  <refnamediv>
68
46
    <refname><command>&COMMANDNAME;</command></refname>
69
47
    <refpurpose>
70
 
      Sends encrypted passwords to authenticated Mandos clients
 
48
      Gives encrypted passwords to authenticated Mandos clients
71
49
    </refpurpose>
72
50
  </refnamediv>
73
51
 
74
52
  <refsynopsisdiv>
75
53
    <cmdsynopsis>
76
54
      <command>&COMMANDNAME;</command>
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>
 
55
      <group>
 
56
        <arg choice="plain"><option>--interface
 
57
        <replaceable>NAME</replaceable></option></arg>
 
58
        <arg choice="plain"><option>-i
 
59
        <replaceable>NAME</replaceable></option></arg>
 
60
      </group>
 
61
      <sbr/>
 
62
      <group>
 
63
        <arg choice="plain"><option>--address
 
64
        <replaceable>ADDRESS</replaceable></option></arg>
 
65
        <arg choice="plain"><option>-a
 
66
        <replaceable>ADDRESS</replaceable></option></arg>
 
67
      </group>
 
68
      <sbr/>
 
69
      <group>
 
70
        <arg choice="plain"><option>--port
 
71
        <replaceable>PORT</replaceable></option></arg>
 
72
        <arg choice="plain"><option>-p
 
73
        <replaceable>PORT</replaceable></option></arg>
 
74
      </group>
 
75
      <sbr/>
 
76
      <arg><option>--priority
 
77
      <replaceable>PRIORITY</replaceable></option></arg>
 
78
      <sbr/>
 
79
      <arg><option>--servicename
 
80
      <replaceable>NAME</replaceable></option></arg>
 
81
      <sbr/>
 
82
      <arg><option>--configdir
 
83
      <replaceable>DIRECTORY</replaceable></option></arg>
 
84
      <sbr/>
 
85
      <arg><option>--debug</option></arg>
94
86
    </cmdsynopsis>
95
87
    <cmdsynopsis>
96
88
      <command>&COMMANDNAME;</command>
97
89
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
 
90
        <arg choice="plain"><option>--help</option></arg>
 
91
        <arg choice="plain"><option>-h</option></arg>
100
92
      </group>
101
93
    </cmdsynopsis>
102
94
    <cmdsynopsis>
103
95
      <command>&COMMANDNAME;</command>
104
 
      <arg choice="plain">--version</arg>
 
96
      <arg choice="plain"><option>--version</option></arg>
105
97
    </cmdsynopsis>
106
98
    <cmdsynopsis>
107
99
      <command>&COMMANDNAME;</command>
108
 
      <arg choice="plain">--check</arg>
 
100
      <arg choice="plain"><option>--check</option></arg>
109
101
    </cmdsynopsis>
110
102
  </refsynopsisdiv>
111
103
 
135
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
136
128
      linkend="overview"/> for details.
137
129
    </para>
138
 
 
 
130
    
139
131
  </refsect1>
140
132
  
141
133
  <refsect1 id="options">
142
134
    <title>OPTIONS</title>
143
 
 
 
135
    
144
136
    <variablelist>
145
137
      <varlistentry>
146
 
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
138
        <term><option>--help</option></term>
 
139
        <term><option>-h</option></term>
147
140
        <listitem>
148
141
          <para>
149
142
            Show a help message and exit
150
143
          </para>
151
144
        </listitem>
152
145
      </varlistentry>
153
 
 
 
146
      
154
147
      <varlistentry>
155
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
156
 
        >NAME</replaceable></literal></term>
 
148
        <term><option>--interface</option>
 
149
        <replaceable>NAME</replaceable></term>
 
150
        <term><option>-i</option>
 
151
        <replaceable>NAME</replaceable></term>
157
152
        <listitem>
158
153
          <xi:include href="mandos-options.xml" xpointer="interface"/>
159
154
        </listitem>
160
155
      </varlistentry>
161
 
 
 
156
      
162
157
      <varlistentry>
163
 
        <term><literal>-a</literal>, <literal>--address <replaceable>
164
 
        ADDRESS</replaceable></literal></term>
 
158
        <term><option>--address
 
159
        <replaceable>ADDRESS</replaceable></option></term>
 
160
        <term><option>-a
 
161
        <replaceable>ADDRESS</replaceable></option></term>
165
162
        <listitem>
166
163
          <xi:include href="mandos-options.xml" xpointer="address"/>
167
164
        </listitem>
168
165
      </varlistentry>
169
 
 
 
166
      
170
167
      <varlistentry>
171
 
        <term><literal>-p</literal>, <literal>--port <replaceable>
172
 
        PORT</replaceable></literal></term>
 
168
        <term><option>--port
 
169
        <replaceable>PORT</replaceable></option></term>
 
170
        <term><option>-p
 
171
        <replaceable>PORT</replaceable></option></term>
173
172
        <listitem>
174
173
          <xi:include href="mandos-options.xml" xpointer="port"/>
175
174
        </listitem>
176
175
      </varlistentry>
177
 
 
 
176
      
178
177
      <varlistentry>
179
 
        <term><literal>--check</literal></term>
 
178
        <term><option>--check</option></term>
180
179
        <listitem>
181
180
          <para>
182
181
            Run the server’s self-tests.  This includes any unit
184
183
          </para>
185
184
        </listitem>
186
185
      </varlistentry>
187
 
 
 
186
      
188
187
      <varlistentry>
189
 
        <term><literal>--debug</literal></term>
 
188
        <term><option>--debug</option></term>
190
189
        <listitem>
191
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
192
191
        </listitem>
193
192
      </varlistentry>
194
193
 
195
194
      <varlistentry>
196
 
        <term><literal>--priority <replaceable>
197
 
        PRIORITY</replaceable></literal></term>
 
195
        <term><option>--priority <replaceable>
 
196
        PRIORITY</replaceable></option></term>
198
197
        <listitem>
199
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
200
199
        </listitem>
201
200
      </varlistentry>
202
201
 
203
202
      <varlistentry>
204
 
        <term><literal>--servicename <replaceable>NAME</replaceable>
205
 
        </literal></term>
 
203
        <term><option>--servicename
 
204
        <replaceable>NAME</replaceable></option></term>
206
205
        <listitem>
207
206
          <xi:include href="mandos-options.xml"
208
207
                      xpointer="servicename"/>
210
209
      </varlistentry>
211
210
 
212
211
      <varlistentry>
213
 
        <term><literal>--configdir <replaceable>DIR</replaceable>
214
 
        </literal></term>
 
212
        <term><option>--configdir
 
213
        <replaceable>DIRECTORY</replaceable></option></term>
215
214
        <listitem>
216
215
          <para>
217
216
            Directory to search for configuration files.  Default is
225
224
      </varlistentry>
226
225
 
227
226
      <varlistentry>
228
 
        <term><literal>--version</literal></term>
 
227
        <term><option>--version</option></term>
229
228
        <listitem>
230
229
          <para>
231
230
            Prints the program version and exit.
241
240
    <para>
242
241
      This program is the server part.  It is a normal server program
243
242
      and will run in a normal system environment, not in an initial
244
 
      RAM disk environment.
 
243
      <acronym>RAM</acronym> disk environment.
245
244
    </para>
246
245
  </refsect1>
247
246
 
339
338
    <title>ENVIRONMENT</title>
340
339
    <variablelist>
341
340
      <varlistentry>
342
 
        <term><varname>PATH</varname></term>
 
341
        <term><envar>PATH</envar></term>
343
342
        <listitem>
344
343
          <para>
345
344
            To start the configured checker (see <xref
522
521
        restarting servers if it is suspected that a client has, in
523
522
        fact, been compromised by parties who may now be running a
524
523
        fake Mandos client with the keys from the non-encrypted
525
 
        initial RAM image of the client host.  What should be done in
526
 
        that case (if restarting the server program really is
527
 
        necessary) is to stop the server program, edit the
 
524
        initial <acronym>RAM</acronym> image of the client host.  What
 
525
        should be done in that case (if restarting the server program
 
526
        really is necessary) is to stop the server program, edit the
528
527
        configuration file to omit any suspect clients, and restart
529
528
        the server program.
530
529
      </para>
540
539
    <title>SEE ALSO</title>
541
540
    <para>
542
541
      <citerefentry>
 
542
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
544
        <refentrytitle>mandos.conf</refentrytitle>
544
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
546
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
546
        <refentrytitle>password-request</refentrytitle>
548
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>