/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

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
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
<!ENTITY TIMESTAMP "2008-08-29">
9
9
]>
10
10
 
11
11
<refentry>
12
12
  <refentryinfo>
13
13
    <title>Mandos Manual</title>
14
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
15
15
    <productname>Mandos</productname>
16
16
    <productnumber>&VERSION;</productnumber>
17
17
    <date>&TIMESTAMP;</date>
33
33
    </authorgroup>
34
34
    <copyright>
35
35
      <year>2008</year>
36
 
      <holder>Teddy Hogeborn</holder>
37
 
      <holder>Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
38
37
    </copyright>
39
38
    <legalnotice>
40
39
      <para>
76
75
  <refsynopsisdiv>
77
76
    <cmdsynopsis>
78
77
      <command>&COMMANDNAME;</command>
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>
 
78
      <arg choice='opt'>--connect<arg choice='plain'>IP</arg></arg>
 
79
      <arg choice='opt'>--keydir<arg choice='plain'>KEYDIR</arg></arg>
 
80
      <arg choice='opt'>--interface<arg choice='plain'>INTERFACE</arg></arg>
 
81
      <arg choice='opt'>--pubkey<arg choice='plain'>PUBKEY</arg></arg>
 
82
      <arg choice='opt'>--seckey<arg choice='plain'>SECKEY</arg></arg>
 
83
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
 
84
      <arg choice='opt'>--dh-bits<arg choice='plain'>BITS</arg></arg>      
 
85
      <arg choice='opt'>--debug</arg>
 
86
    </cmdsynopsis>
 
87
    <cmdsynopsis>
 
88
      <command>&COMMANDNAME;</command>
 
89
      <arg choice='plain'>--help</arg>
 
90
    </cmdsynopsis>
 
91
    <cmdsynopsis>
 
92
      <command>&COMMANDNAME;</command>
 
93
      <arg choice='plain'>--usage</arg>
 
94
    </cmdsynopsis>
 
95
    <cmdsynopsis>
 
96
      <command>&COMMANDNAME;</command>
 
97
      <arg choice='plain'>--version</arg>
 
98
    </cmdsynopsis>    
146
99
  </refsynopsisdiv>
147
100
 
148
101
  <refsect1 id="description">
154
107
      passwords given is automaticly decrypted and passed to
155
108
      cryptsetup.
156
109
    </para>
157
 
  </refsect1>
 
110
  </refsect1>  
158
111
  
159
112
  <refsect1 id="options">
160
113
    <title>OPTIONS</title>
165
118
 
166
119
    <variablelist>
167
120
      <varlistentry>
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
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
122
        IP</replaceable></literal></term>
174
123
        <listitem>
175
124
          <para>
176
125
            Connect directly to a specified mandos server
179
128
      </varlistentry>
180
129
 
181
130
      <varlistentry>
182
 
        <term><option>--keydir=<replaceable
183
 
        >DIRECTORY</replaceable></option></term>
184
 
        <term><option>-d
185
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
131
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
132
        KEYDIR</replaceable></literal></term>
186
133
        <listitem>
187
134
          <para>
188
135
            Directory where the openpgp keyring is
189
136
          </para>
190
137
        </listitem>
191
 
      </varlistentry>
 
138
      </varlistentry>      
192
139
 
193
140
      <varlistentry>
194
 
        <term><option>--interface=
195
 
        <replaceable>NAME</replaceable></option></term>
196
 
        <term><option>-i
197
 
        <replaceable>NAME</replaceable></option></term>
 
141
        <term><literal>-i</literal>, <literal>--interface=
 
142
        <replaceable>INTERFACE</replaceable></literal></term>
198
143
        <listitem>
199
144
          <para>
200
 
            Interface that Avahi will connect through
 
145
            Interface that Avahi will conntect through
201
146
          </para>
202
147
        </listitem>
203
 
      </varlistentry>
 
148
      </varlistentry>      
204
149
 
205
150
      <varlistentry>
206
 
        <term><option>--pubkey=<replaceable
207
 
        >FILE</replaceable></option></term>
208
 
        <term><option>-p
209
 
        <replaceable>FILE</replaceable></option></term>
 
151
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
152
        PUBKEY</replaceable></literal></term>
210
153
        <listitem>
211
154
          <para>
212
155
            Public openpgp key for gnutls authentication
213
156
          </para>
214
157
        </listitem>
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>
 
158
      </varlistentry>      
 
159
 
 
160
      <varlistentry>
 
161
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
 
162
        SECKEY</replaceable></literal></term>
 
163
        <listitem>
 
164
          <para>
 
165
            Secret openpgp key for gnutls authentication
 
166
          </para>
 
167
        </listitem>
 
168
      </varlistentry>            
 
169
      
 
170
      <varlistentry>
 
171
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
 
172
        </literal></term>
 
173
        <listitem>
 
174
          <para>
 
175
            GNUTLS priority
 
176
          </para>
 
177
        </listitem>
 
178
      </varlistentry>            
 
179
 
 
180
      <varlistentry>
 
181
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
 
182
        </literal></term>
 
183
        <listitem>
 
184
          <para>
 
185
            dh-bits to use in gnutls communication
 
186
          </para>
 
187
        </listitem>
 
188
      </varlistentry>      
 
189
      
 
190
      <varlistentry>
 
191
        <term><literal>--debug</literal></term>
251
192
        <listitem>
252
193
          <para>
253
194
            Debug mode
256
197
      </varlistentry>
257
198
      
258
199
      <varlistentry>
259
 
        <term><option>--help</option></term>
260
 
        <term><option>-?</option></term>
 
200
        <term><literal>-?</literal>, <literal>--help</literal></term>
261
201
        <listitem>
262
202
          <para>
263
203
            Gives a help message
266
206
      </varlistentry>
267
207
      
268
208
      <varlistentry>
269
 
        <term><option>--usage</option></term>
 
209
        <term><literal>--usage</literal></term>
270
210
        <listitem>
271
211
          <para>
272
212
            Gives a short usage message
275
215
      </varlistentry>
276
216
 
277
217
      <varlistentry>
278
 
        <term><option>--version</option></term>
279
 
        <term><option>-V</option></term>
 
218
        <term><literal>-V</literal>, <literal>--version</literal></term>
280
219
        <listitem>
281
220
          <para>
282
221
            Prints the program version
283
222
          </para>
284
223
        </listitem>
285
 
      </varlistentry>
 
224
      </varlistentry>            
286
225
    </variablelist>
287
226
  </refsect1>
288
227
 
296
235
    <title>ENVIRONMENT</title>
297
236
    <para>
298
237
    </para>
299
 
  </refsect1>
 
238
  </refsect1>  
300
239
 
301
240
  <refsect1 id="file">
302
241
    <title>FILES</title>
303
242
    <para>
304
243
    </para>
305
 
  </refsect1>
 
244
  </refsect1>  
306
245
  
307
246
  <refsect1 id="bugs">
308
247
    <title>BUGS</title>
309
248
    <para>
310
249
    </para>
311
 
  </refsect1>
 
250
  </refsect1>  
312
251
 
313
252
  <refsect1 id="example">
314
253
    <title>EXAMPLE</title>