/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 14:02:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831140237-oz9knd88esz8cj4y
* plugin-runner.xml: Removed <?xml-stylesheet>.
* plugins.d/password-request.xml: - '' -

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