/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 plugins.d/password-request.xml

Added all sections needed for mandos-client manual page

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
5
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
6
<!ENTITY VERSION "1.0">
7
7
<!ENTITY COMMANDNAME "password-request">
8
 
<!ENTITY TIMESTAMP "2008-08-31">
9
8
]>
10
9
 
11
10
<refentry>
12
11
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
12
    <title>&COMMANDNAME;</title>
14
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
 
14
    <productname>&COMMANDNAME;</productname>
16
15
    <productnumber>&VERSION;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
18
16
    <authorgroup>
19
17
      <author>
20
18
        <firstname>Björn</firstname>
75
73
  <refsynopsisdiv>
76
74
    <cmdsynopsis>
77
75
      <command>&COMMANDNAME;</command>
78
 
      <group>
79
 
        <arg choice="plain"><option>--connect
80
 
        <replaceable>IPADDR</replaceable><literal>:</literal
81
 
        ><replaceable>PORT</replaceable></option></arg>
82
 
        <arg choice="plain"><option>-c
83
 
        <replaceable>IPADDR</replaceable><literal>:</literal
84
 
        ><replaceable>PORT</replaceable></option></arg>
85
 
      </group>
86
 
      <sbr/>
87
 
      <group>
88
 
        <arg choice="plain"><option>--keydir
89
 
        <replaceable>DIRECTORY</replaceable></option></arg>
90
 
        <arg choice="plain"><option>-d
91
 
        <replaceable>DIRECTORY</replaceable></option></arg>
92
 
      </group>
93
 
      <sbr/>
94
 
      <group>
95
 
        <arg choice="plain"><option>--interface
96
 
        <replaceable>NAME</replaceable></option></arg>
97
 
        <arg choice="plain"><option>-i
98
 
        <replaceable>NAME</replaceable></option></arg>
99
 
      </group>
100
 
      <sbr/>
101
 
      <group>
102
 
        <arg choice="plain"><option>--pubkey
103
 
        <replaceable>FILE</replaceable></option></arg>
104
 
        <arg choice="plain"><option>-p
105
 
        <replaceable>FILE</replaceable></option></arg>
106
 
      </group>
107
 
      <sbr/>
108
 
      <group>
109
 
        <arg choice="plain"><option>--seckey
110
 
        <replaceable>FILE</replaceable></option></arg>
111
 
        <arg choice="plain"><option>-s
112
 
        <replaceable>FILE</replaceable></option></arg>
113
 
      </group>
114
 
      <sbr/>
115
 
      <arg>
116
 
        <option>--priority <replaceable>STRING</replaceable></option>
117
 
      </arg>
118
 
      <sbr/>
119
 
      <arg>
120
 
        <option>--dh-bits <replaceable>BITS</replaceable></option>
121
 
      </arg>
122
 
      <sbr/>
123
 
      <arg>
124
 
        <option>--debug</option>
125
 
      </arg>
126
 
    </cmdsynopsis>
127
 
    <cmdsynopsis>
128
 
      <command>&COMMANDNAME;</command>
129
 
      <group choice="req">
130
 
        <arg choice='plain'><option>--help</option></arg>
131
 
        <arg choice='plain'><option>-?</option></arg>
132
 
      </group>
133
 
    </cmdsynopsis>
134
 
    <cmdsynopsis>
135
 
      <command>&COMMANDNAME;</command>
136
 
      <arg choice='plain'><option>--usage</option></arg>
137
 
    </cmdsynopsis>
138
 
    <cmdsynopsis>
139
 
      <command>&COMMANDNAME;</command>
140
 
      <group choice="req">
141
 
        <arg choice='plain'><option>--version</option></arg>
142
 
        <arg choice='plain'><option>-V</option></arg>
143
 
      </group>
144
 
    </cmdsynopsis>
 
76
      <arg choice='opt'>--connect<arg choice='plain'>IP</arg></arg>
 
77
      <arg choice='opt'>--keydir<arg choice='plain'>KEYDIR</arg></arg>
 
78
      <arg choice='opt'>--interface<arg choice='plain'>INTERFACE</arg></arg>
 
79
      <arg choice='opt'>--pubkey<arg choice='plain'>PUBKEY</arg></arg>
 
80
      <arg choice='opt'>--seckey<arg choice='plain'>SECKEY</arg></arg>
 
81
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
 
82
      <arg choice='opt'>--dh-bits<arg choice='plain'>BITS</arg></arg>      
 
83
      <arg choice='opt'>--debug</arg>
 
84
    </cmdsynopsis>
 
85
    <cmdsynopsis>
 
86
      <command>&COMMANDNAME;</command>
 
87
      <arg choice='plain'>--help</arg>
 
88
    </cmdsynopsis>
 
89
    <cmdsynopsis>
 
90
      <command>&COMMANDNAME;</command>
 
91
      <arg choice='plain'>--usage</arg>
 
92
    </cmdsynopsis>
 
93
    <cmdsynopsis>
 
94
      <command>&COMMANDNAME;</command>
 
95
      <arg choice='plain'>--version</arg>
 
96
    </cmdsynopsis>    
145
97
  </refsynopsisdiv>
146
98
 
147
99
  <refsect1 id="description">
153
105
      passwords given is automaticly decrypted and passed to
154
106
      cryptsetup.
155
107
    </para>
156
 
  </refsect1>
157
 
  
158
 
  <refsect1 id="options">
159
 
    <title>OPTIONS</title>
160
 
    <para>
161
 
      Commonly not invoked as command lines but from configuration
162
 
      file of plugin runner.
163
 
    </para>
164
108
 
165
109
    <variablelist>
166
110
      <varlistentry>
167
 
        <term><option>--connect=<replaceable
168
 
        >IPADDR</replaceable><literal>:</literal><replaceable
169
 
        >PORT</replaceable></option></term>
170
 
        <term><option>-c
171
 
        <replaceable>IPADDR</replaceable><literal>:</literal
172
 
        ><replaceable>PORT</replaceable></option></term>
 
111
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
112
        IP</replaceable></literal></term>
173
113
        <listitem>
174
114
          <para>
175
 
            Connect directly to a specified mandos server
 
115
            Connect directly to a sepcified mandos server
176
116
          </para>
177
117
        </listitem>
178
118
      </varlistentry>
179
119
 
180
120
      <varlistentry>
181
 
        <term><option>--keydir=<replaceable
182
 
        >DIRECTORY</replaceable></option></term>
183
 
        <term><option>-d
184
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
121
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
122
        KEYDIR</replaceable></literal></term>
185
123
        <listitem>
186
124
          <para>
187
125
            Directory where the openpgp keyring is
188
126
          </para>
189
127
        </listitem>
190
 
      </varlistentry>
 
128
      </varlistentry>      
191
129
 
192
130
      <varlistentry>
193
 
        <term><option>--interface=
194
 
        <replaceable>NAME</replaceable></option></term>
195
 
        <term><option>-i
196
 
        <replaceable>NAME</replaceable></option></term>
 
131
        <term><literal>-i</literal>, <literal>--interface=
 
132
        <replaceable>INTERFACE</replaceable></literal></term>
197
133
        <listitem>
198
134
          <para>
199
 
            Interface that Avahi will connect through
 
135
            Interface that Avahi will conntect through
200
136
          </para>
201
137
        </listitem>
202
 
      </varlistentry>
 
138
      </varlistentry>      
203
139
 
204
140
      <varlistentry>
205
 
        <term><option>--pubkey=<replaceable
206
 
        >FILE</replaceable></option></term>
207
 
        <term><option>-p
208
 
        <replaceable>FILE</replaceable></option></term>
 
141
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
142
        PUBKEY</replaceable></literal></term>
209
143
        <listitem>
210
144
          <para>
211
145
            Public openpgp key for gnutls authentication
212
146
          </para>
213
147
        </listitem>
214
 
      </varlistentry>
215
 
 
216
 
      <varlistentry>
217
 
        <term><option>--seckey=<replaceable
218
 
        >FILE</replaceable></option></term>
219
 
        <term><option>-s
220
 
        <replaceable>FILE</replaceable></option></term>
221
 
        <listitem>
222
 
          <para>
223
 
            Secret OpenPGP key for GnuTLS authentication
224
 
          </para>
225
 
        </listitem>
226
 
      </varlistentry>
227
 
      
228
 
      <varlistentry>
229
 
        <term><option>--priority=<replaceable
230
 
        >STRING</replaceable></option></term>
231
 
        <listitem>
232
 
          <para>
233
 
            GnuTLS priority
234
 
          </para>
235
 
        </listitem>
236
 
      </varlistentry>
237
 
 
238
 
      <varlistentry>
239
 
        <term><option>--dh-bits=<replaceable
240
 
        >BITS</replaceable></option></term>
241
 
        <listitem>
242
 
          <para>
243
 
            DH bits to use in gnutls communication
244
 
          </para>
245
 
        </listitem>
246
 
      </varlistentry>
247
 
      
248
 
      <varlistentry>
249
 
        <term><option>--debug</option></term>
 
148
      </varlistentry>      
 
149
 
 
150
      <varlistentry>
 
151
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
 
152
        SECKEY</replaceable></literal></term>
 
153
        <listitem>
 
154
          <para>
 
155
            Secret openpgp key for gnutls authentication
 
156
          </para>
 
157
        </listitem>
 
158
      </varlistentry>            
 
159
      
 
160
      <varlistentry>
 
161
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
 
162
        </literal></term>
 
163
        <listitem>
 
164
          <para>
 
165
            GNUTLS priority
 
166
          </para>
 
167
        </listitem>
 
168
      </varlistentry>            
 
169
 
 
170
      <varlistentry>
 
171
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
 
172
        </literal></term>
 
173
        <listitem>
 
174
          <para>
 
175
            dh-bits to use in gnutls communication
 
176
          </para>
 
177
        </listitem>
 
178
      </varlistentry>      
 
179
      
 
180
      <varlistentry>
 
181
        <term><literal>--debug</literal></term>
250
182
        <listitem>
251
183
          <para>
252
184
            Debug mode
255
187
      </varlistentry>
256
188
      
257
189
      <varlistentry>
258
 
        <term><option>--help</option></term>
259
 
        <term><option>-?</option></term>
 
190
        <term><literal>-?</literal>, <literal>--help</literal></term>
260
191
        <listitem>
261
192
          <para>
262
193
            Gives a help message
265
196
      </varlistentry>
266
197
      
267
198
      <varlistentry>
268
 
        <term><option>--usage</option></term>
 
199
        <term><literal>--usage</literal></term>
269
200
        <listitem>
270
201
          <para>
271
202
            Gives a short usage message
274
205
      </varlistentry>
275
206
 
276
207
      <varlistentry>
277
 
        <term><option>--version</option></term>
278
 
        <term><option>-V</option></term>
 
208
        <term><literal>-V</literal>, <literal>--version</literal></term>
279
209
        <listitem>
280
210
          <para>
281
211
            Prints the program version
282
212
          </para>
283
213
        </listitem>
284
 
      </varlistentry>
 
214
      </varlistentry>            
285
215
    </variablelist>
286
216
  </refsect1>
287
 
 
288
 
  <refsect1 id="exit_status">
289
 
    <title>EXIT STATUS</title>
290
 
    <para>
291
 
    </para>
292
 
  </refsect1>
293
 
 
294
 
  <refsect1 id="environment">
295
 
    <title>ENVIRONMENT</title>
296
 
    <para>
297
 
    </para>
298
 
  </refsect1>
299
 
 
300
 
  <refsect1 id="file">
301
 
    <title>FILES</title>
302
 
    <para>
303
 
    </para>
304
 
  </refsect1>
305
 
  
306
 
  <refsect1 id="bugs">
307
 
    <title>BUGS</title>
308
 
    <para>
309
 
    </para>
310
 
  </refsect1>
311
 
 
312
 
  <refsect1 id="example">
313
 
    <title>EXAMPLE</title>
314
 
    <para>
315
 
    </para>
316
 
  </refsect1>
317
 
 
318
 
  <refsect1 id="security">
319
 
    <title>SECURITY</title>
320
 
    <para>
321
 
    </para>
322
 
  </refsect1>
323
 
 
324
 
  <refsect1 id="see_also">
325
 
    <title>SEE ALSO</title>
326
 
    <para>
327
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
328
 
      <manvolnum>8</manvolnum></citerefentry>,
329
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
330
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
331
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
332
 
      <manvolnum>8mandos</manvolnum></citerefentry>
333
 
    </para>
334
 
    <itemizedlist>
335
 
      <listitem><para>
336
 
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
337
 
      </para></listitem>
338
 
      
339
 
      <listitem><para>
340
 
        <ulink url="http://www.avahi.org/">Avahi</ulink>
341
 
      </para></listitem>
342
 
      
343
 
      <listitem><para>
344
 
        <ulink
345
 
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
346
 
      </para></listitem>
347
 
      
348
 
      <listitem><para>
349
 
        <ulink
350
 
        url="http://www.gnupg.org/related_software/gpgme/">
351
 
        GPGME</ulink>
352
 
      </para></listitem>
353
 
      
354
 
      <listitem><para>
355
 
        <citation>RFC 4880: <citetitle>OpenPGP Message
356
 
        Format</citetitle></citation>
357
 
      </para></listitem>
358
 
      
359
 
      <listitem><para>
360
 
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
361
 
        Transport Layer Security</citetitle></citation>
362
 
      </para></listitem>
363
 
      
364
 
      <listitem><para>
365
 
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
366
 
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
367
 
        Unicast Addresses</citation>
368
 
      </para></listitem>
369
 
    </itemizedlist>
370
 
  </refsect1>
371
 
 
372
217
</refentry>
373
 
<!-- Local Variables: -->
374
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
375
 
<!-- time-stamp-end: "[\"']>" -->
376
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
377
 
<!-- End: -->