/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 13:55:04 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831135504-2ka1cccglsghslxy
* plugin-runner.xml (/refentry/refentryinfo/copyright): Split
                                                        copyright
                                                        holders.
* plugins.d/password-request.xml (/refentry/refentryinfo/copyright):
                                 Split copyright holders.

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