/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

minor edits

Show diffs side-by-side

added added

removed removed

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