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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 14:00:36 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831140036-5bruinjq267s5f8p
* mandos-clients.conf.xml: Changed all single quotes to double quotes
                           for consistency.
* mandos.conf.xml: - '' -
* plugin-runner.xml: - '' -
* 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'?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<?xml-stylesheet type="text/xsl"
3
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
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
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
 
13
    <title>Mandos Manual</title>
 
14
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
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>
108
 
  </refsect1>  
 
157
  </refsect1>
109
158
  
110
159
  <refsect1 id="options">
111
160
    <title>OPTIONS</title>
116
165
 
117
166
    <variablelist>
118
167
      <varlistentry>
119
 
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
120
 
        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>
121
174
        <listitem>
122
175
          <para>
123
176
            Connect directly to a specified mandos server
126
179
      </varlistentry>
127
180
 
128
181
      <varlistentry>
129
 
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
130
 
        KEYDIR</replaceable></literal></term>
 
182
        <term><option>--keydir=<replaceable
 
183
        >DIRECTORY</replaceable></option></term>
 
184
        <term><option>-d
 
185
        <replaceable>DIRECTORY</replaceable></option></term>
131
186
        <listitem>
132
187
          <para>
133
188
            Directory where the openpgp keyring is
134
189
          </para>
135
190
        </listitem>
136
 
      </varlistentry>      
 
191
      </varlistentry>
137
192
 
138
193
      <varlistentry>
139
 
        <term><literal>-i</literal>, <literal>--interface=
140
 
        <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>
141
198
        <listitem>
142
199
          <para>
143
 
            Interface that Avahi will conntect through
 
200
            Interface that Avahi will connect through
144
201
          </para>
145
202
        </listitem>
146
 
      </varlistentry>      
 
203
      </varlistentry>
147
204
 
148
205
      <varlistentry>
149
 
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
150
 
        PUBKEY</replaceable></literal></term>
 
206
        <term><option>--pubkey=<replaceable
 
207
        >FILE</replaceable></option></term>
 
208
        <term><option>-p
 
209
        <replaceable>FILE</replaceable></option></term>
151
210
        <listitem>
152
211
          <para>
153
212
            Public openpgp key for gnutls authentication
154
213
          </para>
155
214
        </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>
 
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>
190
251
        <listitem>
191
252
          <para>
192
253
            Debug mode
195
256
      </varlistentry>
196
257
      
197
258
      <varlistentry>
198
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
259
        <term><option>--help</option></term>
 
260
        <term><option>-?</option></term>
199
261
        <listitem>
200
262
          <para>
201
263
            Gives a help message
204
266
      </varlistentry>
205
267
      
206
268
      <varlistentry>
207
 
        <term><literal>--usage</literal></term>
 
269
        <term><option>--usage</option></term>
208
270
        <listitem>
209
271
          <para>
210
272
            Gives a short usage message
213
275
      </varlistentry>
214
276
 
215
277
      <varlistentry>
216
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
278
        <term><option>--version</option></term>
 
279
        <term><option>-V</option></term>
217
280
        <listitem>
218
281
          <para>
219
282
            Prints the program version
220
283
          </para>
221
284
        </listitem>
222
 
      </varlistentry>            
 
285
      </varlistentry>
223
286
    </variablelist>
224
287
  </refsect1>
225
288
 
233
296
    <title>ENVIRONMENT</title>
234
297
    <para>
235
298
    </para>
236
 
  </refsect1>  
 
299
  </refsect1>
237
300
 
238
301
  <refsect1 id="file">
239
302
    <title>FILES</title>
240
303
    <para>
241
304
    </para>
242
 
  </refsect1>  
 
305
  </refsect1>
243
306
  
244
307
  <refsect1 id="bugs">
245
308
    <title>BUGS</title>
246
309
    <para>
247
310
    </para>
248
 
  </refsect1>  
 
311
  </refsect1>
249
312
 
250
313
  <refsect1 id="example">
251
314
    <title>EXAMPLE</title>
261
324
 
262
325
  <refsect1 id="see_also">
263
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>
264
335
    <itemizedlist>
265
336
      <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
337
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
282
338
      </para></listitem>
283
339
      
315
371
  </refsect1>
316
372
 
317
373
</refentry>
 
374
<!-- Local Variables: -->
 
375
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
376
<!-- time-stamp-end: "[\"']>" -->
 
377
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
378
<!-- End: -->