/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 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:
1
 
<?xml version='1.0' encoding='UTF-8'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY COMMANDNAME "password-request">
 
6
<!ENTITY TIMESTAMP "2008-08-31">
8
7
]>
9
8
 
10
9
<refentry>
11
10
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
13
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
 
11
    <title>Mandos Manual</title>
 
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
13
    <productname>Mandos</productname>
15
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
16
16
    <authorgroup>
17
17
      <author>
18
18
        <firstname>Björn</firstname>
31
31
    </authorgroup>
32
32
    <copyright>
33
33
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
35
36
    </copyright>
36
37
    <legalnotice>
37
38
      <para>
73
74
  <refsynopsisdiv>
74
75
    <cmdsynopsis>
75
76
      <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>    
 
77
      <group>
 
78
        <arg choice="plain"><option>--connect
 
79
        <replaceable>IPADDR</replaceable><literal>:</literal
 
80
        ><replaceable>PORT</replaceable></option></arg>
 
81
        <arg choice="plain"><option>-c
 
82
        <replaceable>IPADDR</replaceable><literal>:</literal
 
83
        ><replaceable>PORT</replaceable></option></arg>
 
84
      </group>
 
85
      <sbr/>
 
86
      <group>
 
87
        <arg choice="plain"><option>--keydir
 
88
        <replaceable>DIRECTORY</replaceable></option></arg>
 
89
        <arg choice="plain"><option>-d
 
90
        <replaceable>DIRECTORY</replaceable></option></arg>
 
91
      </group>
 
92
      <sbr/>
 
93
      <group>
 
94
        <arg choice="plain"><option>--interface
 
95
        <replaceable>NAME</replaceable></option></arg>
 
96
        <arg choice="plain"><option>-i
 
97
        <replaceable>NAME</replaceable></option></arg>
 
98
      </group>
 
99
      <sbr/>
 
100
      <group>
 
101
        <arg choice="plain"><option>--pubkey
 
102
        <replaceable>FILE</replaceable></option></arg>
 
103
        <arg choice="plain"><option>-p
 
104
        <replaceable>FILE</replaceable></option></arg>
 
105
      </group>
 
106
      <sbr/>
 
107
      <group>
 
108
        <arg choice="plain"><option>--seckey
 
109
        <replaceable>FILE</replaceable></option></arg>
 
110
        <arg choice="plain"><option>-s
 
111
        <replaceable>FILE</replaceable></option></arg>
 
112
      </group>
 
113
      <sbr/>
 
114
      <arg>
 
115
        <option>--priority <replaceable>STRING</replaceable></option>
 
116
      </arg>
 
117
      <sbr/>
 
118
      <arg>
 
119
        <option>--dh-bits <replaceable>BITS</replaceable></option>
 
120
      </arg>
 
121
      <sbr/>
 
122
      <arg>
 
123
        <option>--debug</option>
 
124
      </arg>
 
125
    </cmdsynopsis>
 
126
    <cmdsynopsis>
 
127
      <command>&COMMANDNAME;</command>
 
128
      <group choice="req">
 
129
        <arg choice="plain"><option>--help</option></arg>
 
130
        <arg choice="plain"><option>-?</option></arg>
 
131
      </group>
 
132
    </cmdsynopsis>
 
133
    <cmdsynopsis>
 
134
      <command>&COMMANDNAME;</command>
 
135
      <arg choice="plain"><option>--usage</option></arg>
 
136
    </cmdsynopsis>
 
137
    <cmdsynopsis>
 
138
      <command>&COMMANDNAME;</command>
 
139
      <group choice="req">
 
140
        <arg choice="plain"><option>--version</option></arg>
 
141
        <arg choice="plain"><option>-V</option></arg>
 
142
      </group>
 
143
    </cmdsynopsis>
97
144
  </refsynopsisdiv>
98
145
 
99
146
  <refsect1 id="description">
105
152
      passwords given is automaticly decrypted and passed to
106
153
      cryptsetup.
107
154
    </para>
108
 
  </refsect1>  
 
155
  </refsect1>
109
156
  
110
157
  <refsect1 id="options">
111
158
    <title>OPTIONS</title>
116
163
 
117
164
    <variablelist>
118
165
      <varlistentry>
119
 
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
120
 
        IP</replaceable></literal></term>
 
166
        <term><option>--connect=<replaceable
 
167
        >IPADDR</replaceable><literal>:</literal><replaceable
 
168
        >PORT</replaceable></option></term>
 
169
        <term><option>-c
 
170
        <replaceable>IPADDR</replaceable><literal>:</literal
 
171
        ><replaceable>PORT</replaceable></option></term>
121
172
        <listitem>
122
173
          <para>
123
174
            Connect directly to a specified mandos server
126
177
      </varlistentry>
127
178
 
128
179
      <varlistentry>
129
 
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
130
 
        KEYDIR</replaceable></literal></term>
 
180
        <term><option>--keydir=<replaceable
 
181
        >DIRECTORY</replaceable></option></term>
 
182
        <term><option>-d
 
183
        <replaceable>DIRECTORY</replaceable></option></term>
131
184
        <listitem>
132
185
          <para>
133
186
            Directory where the openpgp keyring is
134
187
          </para>
135
188
        </listitem>
136
 
      </varlistentry>      
 
189
      </varlistentry>
137
190
 
138
191
      <varlistentry>
139
 
        <term><literal>-i</literal>, <literal>--interface=
140
 
        <replaceable>INTERFACE</replaceable></literal></term>
 
192
        <term><option>--interface=
 
193
        <replaceable>NAME</replaceable></option></term>
 
194
        <term><option>-i
 
195
        <replaceable>NAME</replaceable></option></term>
141
196
        <listitem>
142
197
          <para>
143
 
            Interface that Avahi will conntect through
 
198
            Interface that Avahi will connect through
144
199
          </para>
145
200
        </listitem>
146
 
      </varlistentry>      
 
201
      </varlistentry>
147
202
 
148
203
      <varlistentry>
149
 
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
150
 
        PUBKEY</replaceable></literal></term>
 
204
        <term><option>--pubkey=<replaceable
 
205
        >FILE</replaceable></option></term>
 
206
        <term><option>-p
 
207
        <replaceable>FILE</replaceable></option></term>
151
208
        <listitem>
152
209
          <para>
153
210
            Public openpgp key for gnutls authentication
154
211
          </para>
155
212
        </listitem>
156
 
      </varlistentry>      
157
 
 
158
 
      <varlistentry>
159
 
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
160
 
        SECKEY</replaceable></literal></term>
161
 
        <listitem>
162
 
          <para>
163
 
            Secret openpgp key for gnutls authentication
164
 
          </para>
165
 
        </listitem>
166
 
      </varlistentry>            
167
 
      
168
 
      <varlistentry>
169
 
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
170
 
        </literal></term>
171
 
        <listitem>
172
 
          <para>
173
 
            GNUTLS priority
174
 
          </para>
175
 
        </listitem>
176
 
      </varlistentry>            
177
 
 
178
 
      <varlistentry>
179
 
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
180
 
        </literal></term>
181
 
        <listitem>
182
 
          <para>
183
 
            dh-bits to use in gnutls communication
184
 
          </para>
185
 
        </listitem>
186
 
      </varlistentry>      
187
 
      
188
 
      <varlistentry>
189
 
        <term><literal>--debug</literal></term>
 
213
      </varlistentry>
 
214
 
 
215
      <varlistentry>
 
216
        <term><option>--seckey=<replaceable
 
217
        >FILE</replaceable></option></term>
 
218
        <term><option>-s
 
219
        <replaceable>FILE</replaceable></option></term>
 
220
        <listitem>
 
221
          <para>
 
222
            Secret OpenPGP key for GnuTLS authentication
 
223
          </para>
 
224
        </listitem>
 
225
      </varlistentry>
 
226
      
 
227
      <varlistentry>
 
228
        <term><option>--priority=<replaceable
 
229
        >STRING</replaceable></option></term>
 
230
        <listitem>
 
231
          <para>
 
232
            GnuTLS priority
 
233
          </para>
 
234
        </listitem>
 
235
      </varlistentry>
 
236
 
 
237
      <varlistentry>
 
238
        <term><option>--dh-bits=<replaceable
 
239
        >BITS</replaceable></option></term>
 
240
        <listitem>
 
241
          <para>
 
242
            DH bits to use in gnutls communication
 
243
          </para>
 
244
        </listitem>
 
245
      </varlistentry>
 
246
      
 
247
      <varlistentry>
 
248
        <term><option>--debug</option></term>
190
249
        <listitem>
191
250
          <para>
192
251
            Debug mode
195
254
      </varlistentry>
196
255
      
197
256
      <varlistentry>
198
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
257
        <term><option>--help</option></term>
 
258
        <term><option>-?</option></term>
199
259
        <listitem>
200
260
          <para>
201
261
            Gives a help message
204
264
      </varlistentry>
205
265
      
206
266
      <varlistentry>
207
 
        <term><literal>--usage</literal></term>
 
267
        <term><option>--usage</option></term>
208
268
        <listitem>
209
269
          <para>
210
270
            Gives a short usage message
213
273
      </varlistentry>
214
274
 
215
275
      <varlistentry>
216
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
276
        <term><option>--version</option></term>
 
277
        <term><option>-V</option></term>
217
278
        <listitem>
218
279
          <para>
219
280
            Prints the program version
220
281
          </para>
221
282
        </listitem>
222
 
      </varlistentry>            
 
283
      </varlistentry>
223
284
    </variablelist>
224
285
  </refsect1>
225
286
 
229
290
    </para>
230
291
  </refsect1>
231
292
 
 
293
  <refsect1 id="environment">
 
294
    <title>ENVIRONMENT</title>
 
295
    <para>
 
296
    </para>
 
297
  </refsect1>
 
298
 
232
299
  <refsect1 id="file">
233
300
    <title>FILES</title>
234
301
    <para>
235
302
    </para>
236
 
  </refsect1>  
237
 
 
238
 
  <refsect1 id="notes">
239
 
    <title>NOTES</title>
240
 
    <para>
241
 
    </para>
242
303
  </refsect1>
243
304
  
244
305
  <refsect1 id="bugs">
245
306
    <title>BUGS</title>
246
307
    <para>
247
308
    </para>
248
 
  </refsect1>  
 
309
  </refsect1>
249
310
 
250
 
  <refsect1 id="examples">
251
 
    <title>EXAMPLES</title>
 
311
  <refsect1 id="example">
 
312
    <title>EXAMPLE</title>
252
313
    <para>
253
314
    </para>
254
315
  </refsect1>
261
322
 
262
323
  <refsect1 id="see_also">
263
324
    <title>SEE ALSO</title>
 
325
    <para>
 
326
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
327
      <manvolnum>8</manvolnum></citerefentry>,
 
328
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
329
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
330
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
331
      <manvolnum>8mandos</manvolnum></citerefentry>
 
332
    </para>
264
333
    <itemizedlist>
265
334
      <listitem><para>
266
 
        <citerefentry><refentrytitle>mandos</refentrytitle>
267
 
        <manvolnum>8</manvolnum></citerefentry>
268
 
      </para></listitem>
269
 
      
270
 
      <listitem><para>
271
 
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
272
 
        <manvolnum>8mandos</manvolnum></citerefentry>
273
 
      </para></listitem>
274
 
      
275
 
      <listitem><para>
276
 
        <citerefentry><refentrytitle>password-prompt</refentrytitle>
277
 
        <manvolnum>8mandos</manvolnum></citerefentry>
278
 
      </para></listitem>
279
 
      
280
 
      <listitem><para>
281
335
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
282
336
      </para></listitem>
283
337
      
315
369
  </refsect1>
316
370
 
317
371
</refentry>
 
372
<!-- Local Variables: -->
 
373
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
374
<!-- time-stamp-end: "[\"']>" -->
 
375
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
376
<!-- End: -->