/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-09-02 10:27:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902102708-j5k6ec3lcgkaeipv
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
                     changed short option for "--env-for" to "-E".
                     added new options "--enable" ("-e") and
                     "--config-file".
  (ENVIRONMENT): Added text.
  (FILES): Changed id to "files".  Improved wording and add more text.

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'?>
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">
8
 
<!ENTITY TIMESTAMP "2008-08-29">
 
6
<!ENTITY TIMESTAMP "2008-08-31">
9
7
]>
10
8
 
11
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
10
  <refentryinfo>
13
11
    <title>Mandos Manual</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
15
13
    <productname>Mandos</productname>
16
14
    <productnumber>&VERSION;</productnumber>
17
15
    <date>&TIMESTAMP;</date>
33
31
    </authorgroup>
34
32
    <copyright>
35
33
      <year>2008</year>
36
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
37
36
    </copyright>
38
 
    <legalnotice>
39
 
      <para>
40
 
        This manual page is free software: you can redistribute it
41
 
        and/or modify it under the terms of the GNU General Public
42
 
        License as published by the Free Software Foundation,
43
 
        either version 3 of the License, or (at your option) any
44
 
        later version.
45
 
      </para>
46
 
 
47
 
      <para>
48
 
        This manual page is distributed in the hope that it will
49
 
        be useful, but WITHOUT ANY WARRANTY; without even the
50
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
51
 
        PARTICULAR PURPOSE.  See the GNU General Public License
52
 
        for more details.
53
 
      </para>
54
 
 
55
 
      <para>
56
 
        You should have received a copy of the GNU General Public
57
 
        License along with this program; If not, see
58
 
        <ulink url="http://www.gnu.org/licenses/"/>.
59
 
      </para>
60
 
    </legalnotice>
 
37
    <xi:include href="../legalnotice.xml"/>
61
38
  </refentryinfo>
62
39
 
63
40
  <refmeta>
75
52
  <refsynopsisdiv>
76
53
    <cmdsynopsis>
77
54
      <command>&COMMANDNAME;</command>
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>    
 
55
      <group>
 
56
        <arg choice="plain"><option>--connect
 
57
        <replaceable>IPADDR</replaceable><literal>:</literal
 
58
        ><replaceable>PORT</replaceable></option></arg>
 
59
        <arg choice="plain"><option>-c
 
60
        <replaceable>IPADDR</replaceable><literal>:</literal
 
61
        ><replaceable>PORT</replaceable></option></arg>
 
62
      </group>
 
63
      <sbr/>
 
64
      <group>
 
65
        <arg choice="plain"><option>--keydir
 
66
        <replaceable>DIRECTORY</replaceable></option></arg>
 
67
        <arg choice="plain"><option>-d
 
68
        <replaceable>DIRECTORY</replaceable></option></arg>
 
69
      </group>
 
70
      <sbr/>
 
71
      <group>
 
72
        <arg choice="plain"><option>--interface
 
73
        <replaceable>NAME</replaceable></option></arg>
 
74
        <arg choice="plain"><option>-i
 
75
        <replaceable>NAME</replaceable></option></arg>
 
76
      </group>
 
77
      <sbr/>
 
78
      <group>
 
79
        <arg choice="plain"><option>--pubkey
 
80
        <replaceable>FILE</replaceable></option></arg>
 
81
        <arg choice="plain"><option>-p
 
82
        <replaceable>FILE</replaceable></option></arg>
 
83
      </group>
 
84
      <sbr/>
 
85
      <group>
 
86
        <arg choice="plain"><option>--seckey
 
87
        <replaceable>FILE</replaceable></option></arg>
 
88
        <arg choice="plain"><option>-s
 
89
        <replaceable>FILE</replaceable></option></arg>
 
90
      </group>
 
91
      <sbr/>
 
92
      <arg>
 
93
        <option>--priority <replaceable>STRING</replaceable></option>
 
94
      </arg>
 
95
      <sbr/>
 
96
      <arg>
 
97
        <option>--dh-bits <replaceable>BITS</replaceable></option>
 
98
      </arg>
 
99
      <sbr/>
 
100
      <arg>
 
101
        <option>--debug</option>
 
102
      </arg>
 
103
    </cmdsynopsis>
 
104
    <cmdsynopsis>
 
105
      <command>&COMMANDNAME;</command>
 
106
      <group choice="req">
 
107
        <arg choice="plain"><option>--help</option></arg>
 
108
        <arg choice="plain"><option>-?</option></arg>
 
109
      </group>
 
110
    </cmdsynopsis>
 
111
    <cmdsynopsis>
 
112
      <command>&COMMANDNAME;</command>
 
113
      <arg choice="plain"><option>--usage</option></arg>
 
114
    </cmdsynopsis>
 
115
    <cmdsynopsis>
 
116
      <command>&COMMANDNAME;</command>
 
117
      <group choice="req">
 
118
        <arg choice="plain"><option>--version</option></arg>
 
119
        <arg choice="plain"><option>-V</option></arg>
 
120
      </group>
 
121
    </cmdsynopsis>
99
122
  </refsynopsisdiv>
100
123
 
101
124
  <refsect1 id="description">
107
130
      passwords given is automaticly decrypted and passed to
108
131
      cryptsetup.
109
132
    </para>
110
 
  </refsect1>  
 
133
  </refsect1>
111
134
  
112
135
  <refsect1 id="options">
113
136
    <title>OPTIONS</title>
118
141
 
119
142
    <variablelist>
120
143
      <varlistentry>
121
 
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
122
 
        IP</replaceable></literal></term>
 
144
        <term><option>--connect=<replaceable
 
145
        >IPADDR</replaceable><literal>:</literal><replaceable
 
146
        >PORT</replaceable></option></term>
 
147
        <term><option>-c
 
148
        <replaceable>IPADDR</replaceable><literal>:</literal
 
149
        ><replaceable>PORT</replaceable></option></term>
123
150
        <listitem>
124
151
          <para>
125
152
            Connect directly to a specified mandos server
128
155
      </varlistentry>
129
156
 
130
157
      <varlistentry>
131
 
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
132
 
        KEYDIR</replaceable></literal></term>
 
158
        <term><option>--keydir=<replaceable
 
159
        >DIRECTORY</replaceable></option></term>
 
160
        <term><option>-d
 
161
        <replaceable>DIRECTORY</replaceable></option></term>
133
162
        <listitem>
134
163
          <para>
135
164
            Directory where the openpgp keyring is
136
165
          </para>
137
166
        </listitem>
138
 
      </varlistentry>      
 
167
      </varlistentry>
139
168
 
140
169
      <varlistentry>
141
 
        <term><literal>-i</literal>, <literal>--interface=
142
 
        <replaceable>INTERFACE</replaceable></literal></term>
 
170
        <term><option>--interface=
 
171
        <replaceable>NAME</replaceable></option></term>
 
172
        <term><option>-i
 
173
        <replaceable>NAME</replaceable></option></term>
143
174
        <listitem>
144
175
          <para>
145
 
            Interface that Avahi will conntect through
 
176
            Interface that Avahi will connect through
146
177
          </para>
147
178
        </listitem>
148
 
      </varlistentry>      
 
179
      </varlistentry>
149
180
 
150
181
      <varlistentry>
151
 
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
152
 
        PUBKEY</replaceable></literal></term>
 
182
        <term><option>--pubkey=<replaceable
 
183
        >FILE</replaceable></option></term>
 
184
        <term><option>-p
 
185
        <replaceable>FILE</replaceable></option></term>
153
186
        <listitem>
154
187
          <para>
155
188
            Public openpgp key for gnutls authentication
156
189
          </para>
157
190
        </listitem>
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>
 
191
      </varlistentry>
 
192
 
 
193
      <varlistentry>
 
194
        <term><option>--seckey=<replaceable
 
195
        >FILE</replaceable></option></term>
 
196
        <term><option>-s
 
197
        <replaceable>FILE</replaceable></option></term>
 
198
        <listitem>
 
199
          <para>
 
200
            Secret OpenPGP key for GnuTLS authentication
 
201
          </para>
 
202
        </listitem>
 
203
      </varlistentry>
 
204
      
 
205
      <varlistentry>
 
206
        <term><option>--priority=<replaceable
 
207
        >STRING</replaceable></option></term>
 
208
        <listitem>
 
209
          <para>
 
210
            GnuTLS priority
 
211
          </para>
 
212
        </listitem>
 
213
      </varlistentry>
 
214
 
 
215
      <varlistentry>
 
216
        <term><option>--dh-bits=<replaceable
 
217
        >BITS</replaceable></option></term>
 
218
        <listitem>
 
219
          <para>
 
220
            DH bits to use in gnutls communication
 
221
          </para>
 
222
        </listitem>
 
223
      </varlistentry>
 
224
      
 
225
      <varlistentry>
 
226
        <term><option>--debug</option></term>
192
227
        <listitem>
193
228
          <para>
194
229
            Debug mode
197
232
      </varlistentry>
198
233
      
199
234
      <varlistentry>
200
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
235
        <term><option>--help</option></term>
 
236
        <term><option>-?</option></term>
201
237
        <listitem>
202
238
          <para>
203
239
            Gives a help message
206
242
      </varlistentry>
207
243
      
208
244
      <varlistentry>
209
 
        <term><literal>--usage</literal></term>
 
245
        <term><option>--usage</option></term>
210
246
        <listitem>
211
247
          <para>
212
248
            Gives a short usage message
215
251
      </varlistentry>
216
252
 
217
253
      <varlistentry>
218
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
254
        <term><option>--version</option></term>
 
255
        <term><option>-V</option></term>
219
256
        <listitem>
220
257
          <para>
221
258
            Prints the program version
222
259
          </para>
223
260
        </listitem>
224
 
      </varlistentry>            
 
261
      </varlistentry>
225
262
    </variablelist>
226
263
  </refsect1>
227
264
 
235
272
    <title>ENVIRONMENT</title>
236
273
    <para>
237
274
    </para>
238
 
  </refsect1>  
 
275
  </refsect1>
239
276
 
240
277
  <refsect1 id="file">
241
278
    <title>FILES</title>
242
279
    <para>
243
280
    </para>
244
 
  </refsect1>  
 
281
  </refsect1>
245
282
  
246
283
  <refsect1 id="bugs">
247
284
    <title>BUGS</title>
248
285
    <para>
249
286
    </para>
250
 
  </refsect1>  
 
287
  </refsect1>
251
288
 
252
289
  <refsect1 id="example">
253
290
    <title>EXAMPLE</title>
263
300
 
264
301
  <refsect1 id="see_also">
265
302
    <title>SEE ALSO</title>
 
303
    <para>
 
304
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
305
      <manvolnum>8</manvolnum></citerefentry>,
 
306
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
307
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
308
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
309
      <manvolnum>8mandos</manvolnum></citerefentry>
 
310
    </para>
266
311
    <itemizedlist>
267
312
      <listitem><para>
268
 
        <citerefentry><refentrytitle>mandos</refentrytitle>
269
 
        <manvolnum>8</manvolnum></citerefentry>
270
 
      </para></listitem>
271
 
      
272
 
      <listitem><para>
273
 
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
274
 
        <manvolnum>8mandos</manvolnum></citerefentry>
275
 
      </para></listitem>
276
 
      
277
 
      <listitem><para>
278
 
        <citerefentry><refentrytitle>password-prompt</refentrytitle>
279
 
        <manvolnum>8mandos</manvolnum></citerefentry>
280
 
      </para></listitem>
281
 
      
282
 
      <listitem><para>
283
313
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
284
314
      </para></listitem>
285
315