/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

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
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
8
<!ENTITY TIMESTAMP "2008-08-29">
7
9
]>
8
10
 
9
11
<refentry>
10
12
  <refentryinfo>
11
13
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
13
15
    <productname>Mandos</productname>
14
16
    <productnumber>&VERSION;</productnumber>
15
17
    <date>&TIMESTAMP;</date>
31
33
    </authorgroup>
32
34
    <copyright>
33
35
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
37
    </copyright>
37
38
    <legalnotice>
38
39
      <para>
74
75
  <refsynopsisdiv>
75
76
    <cmdsynopsis>
76
77
      <command>&COMMANDNAME;</command>
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>
 
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>    
144
99
  </refsynopsisdiv>
145
100
 
146
101
  <refsect1 id="description">
152
107
      passwords given is automaticly decrypted and passed to
153
108
      cryptsetup.
154
109
    </para>
155
 
  </refsect1>
 
110
  </refsect1>  
156
111
  
157
112
  <refsect1 id="options">
158
113
    <title>OPTIONS</title>
163
118
 
164
119
    <variablelist>
165
120
      <varlistentry>
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
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
122
        IP</replaceable></literal></term>
172
123
        <listitem>
173
124
          <para>
174
125
            Connect directly to a specified mandos server
177
128
      </varlistentry>
178
129
 
179
130
      <varlistentry>
180
 
        <term><option>--keydir=<replaceable
181
 
        >DIRECTORY</replaceable></option></term>
182
 
        <term><option>-d
183
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
131
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
132
        KEYDIR</replaceable></literal></term>
184
133
        <listitem>
185
134
          <para>
186
135
            Directory where the openpgp keyring is
187
136
          </para>
188
137
        </listitem>
189
 
      </varlistentry>
 
138
      </varlistentry>      
190
139
 
191
140
      <varlistentry>
192
 
        <term><option>--interface=
193
 
        <replaceable>NAME</replaceable></option></term>
194
 
        <term><option>-i
195
 
        <replaceable>NAME</replaceable></option></term>
 
141
        <term><literal>-i</literal>, <literal>--interface=
 
142
        <replaceable>INTERFACE</replaceable></literal></term>
196
143
        <listitem>
197
144
          <para>
198
 
            Interface that Avahi will connect through
 
145
            Interface that Avahi will conntect through
199
146
          </para>
200
147
        </listitem>
201
 
      </varlistentry>
 
148
      </varlistentry>      
202
149
 
203
150
      <varlistentry>
204
 
        <term><option>--pubkey=<replaceable
205
 
        >FILE</replaceable></option></term>
206
 
        <term><option>-p
207
 
        <replaceable>FILE</replaceable></option></term>
 
151
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
152
        PUBKEY</replaceable></literal></term>
208
153
        <listitem>
209
154
          <para>
210
155
            Public openpgp key for gnutls authentication
211
156
          </para>
212
157
        </listitem>
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>
 
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>
249
192
        <listitem>
250
193
          <para>
251
194
            Debug mode
254
197
      </varlistentry>
255
198
      
256
199
      <varlistentry>
257
 
        <term><option>--help</option></term>
258
 
        <term><option>-?</option></term>
 
200
        <term><literal>-?</literal>, <literal>--help</literal></term>
259
201
        <listitem>
260
202
          <para>
261
203
            Gives a help message
264
206
      </varlistentry>
265
207
      
266
208
      <varlistentry>
267
 
        <term><option>--usage</option></term>
 
209
        <term><literal>--usage</literal></term>
268
210
        <listitem>
269
211
          <para>
270
212
            Gives a short usage message
273
215
      </varlistentry>
274
216
 
275
217
      <varlistentry>
276
 
        <term><option>--version</option></term>
277
 
        <term><option>-V</option></term>
 
218
        <term><literal>-V</literal>, <literal>--version</literal></term>
278
219
        <listitem>
279
220
          <para>
280
221
            Prints the program version
281
222
          </para>
282
223
        </listitem>
283
 
      </varlistentry>
 
224
      </varlistentry>            
284
225
    </variablelist>
285
226
  </refsect1>
286
227
 
294
235
    <title>ENVIRONMENT</title>
295
236
    <para>
296
237
    </para>
297
 
  </refsect1>
 
238
  </refsect1>  
298
239
 
299
240
  <refsect1 id="file">
300
241
    <title>FILES</title>
301
242
    <para>
302
243
    </para>
303
 
  </refsect1>
 
244
  </refsect1>  
304
245
  
305
246
  <refsect1 id="bugs">
306
247
    <title>BUGS</title>
307
248
    <para>
308
249
    </para>
309
 
  </refsect1>
 
250
  </refsect1>  
310
251
 
311
252
  <refsect1 id="example">
312
253
    <title>EXAMPLE</title>