/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 12:23:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831122333-qgppahxb4d4b0coc
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
                                            the ones in the SYNOPSIS.
                                            Split <term> tags into one
                                            for each option.  Use
                                            <option> tags instead of
                                            <literal>.  Moved long
                                            options before short.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
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
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
 
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>
73
75
  <refsynopsisdiv>
74
76
    <cmdsynopsis>
75
77
      <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>    
 
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>DIRECTORY</replaceable></option></arg>
 
90
        <arg choice="plain"><option>-d
 
91
        <replaceable>DIRECTORY</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>
 
144
    </cmdsynopsis>
97
145
  </refsynopsisdiv>
98
146
 
99
147
  <refsect1 id="description">
105
153
      passwords given is automaticly decrypted and passed to
106
154
      cryptsetup.
107
155
    </para>
108
 
  </refsect1>  
 
156
  </refsect1>
109
157
  
110
158
  <refsect1 id="options">
111
159
    <title>OPTIONS</title>
116
164
 
117
165
    <variablelist>
118
166
      <varlistentry>
119
 
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
120
 
        IP</replaceable></literal></term>
 
167
        <term><option>--connect=<replaceable
 
168
        >IPADDR</replaceable><literal>:</literal><replaceable
 
169
        >PORT</replaceable></option></term>
 
170
        <term><option>-c
 
171
        <replaceable>IPADDR</replaceable><literal>:</literal
 
172
        ><replaceable>PORT</replaceable></option></term>
121
173
        <listitem>
122
174
          <para>
123
175
            Connect directly to a specified mandos server
126
178
      </varlistentry>
127
179
 
128
180
      <varlistentry>
129
 
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
130
 
        KEYDIR</replaceable></literal></term>
 
181
        <term><option>--keydir=<replaceable
 
182
        >DIRECTORY</replaceable></option></term>
 
183
        <term><option>-d
 
184
        <replaceable>DIRECTORY</replaceable></option></term>
131
185
        <listitem>
132
186
          <para>
133
187
            Directory where the openpgp keyring is
134
188
          </para>
135
189
        </listitem>
136
 
      </varlistentry>      
 
190
      </varlistentry>
137
191
 
138
192
      <varlistentry>
139
 
        <term><literal>-i</literal>, <literal>--interface=
140
 
        <replaceable>INTERFACE</replaceable></literal></term>
 
193
        <term><option>--interface=
 
194
        <replaceable>NAME</replaceable></option></term>
 
195
        <term><option>-i
 
196
        <replaceable>NAME</replaceable></option></term>
141
197
        <listitem>
142
198
          <para>
143
 
            Interface that Avahi will conntect through
 
199
            Interface that Avahi will connect through
144
200
          </para>
145
201
        </listitem>
146
 
      </varlistentry>      
 
202
      </varlistentry>
147
203
 
148
204
      <varlistentry>
149
 
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
150
 
        PUBKEY</replaceable></literal></term>
 
205
        <term><option>--pubkey=<replaceable
 
206
        >FILE</replaceable></option></term>
 
207
        <term><option>-p
 
208
        <replaceable>FILE</replaceable></option></term>
151
209
        <listitem>
152
210
          <para>
153
211
            Public openpgp key for gnutls authentication
154
212
          </para>
155
213
        </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>
 
214
      </varlistentry>
 
215
 
 
216
      <varlistentry>
 
217
        <term><option>--seckey=<replaceable
 
218
        >FILE</replaceable></option></term>
 
219
        <term><option>-s
 
220
        <replaceable>FILE</replaceable></option></term>
 
221
        <listitem>
 
222
          <para>
 
223
            Secret OpenPGP key for GnuTLS authentication
 
224
          </para>
 
225
        </listitem>
 
226
      </varlistentry>
 
227
      
 
228
      <varlistentry>
 
229
        <term><option>--priority=<replaceable
 
230
        >STRING</replaceable></option></term>
 
231
        <listitem>
 
232
          <para>
 
233
            GnuTLS priority
 
234
          </para>
 
235
        </listitem>
 
236
      </varlistentry>
 
237
 
 
238
      <varlistentry>
 
239
        <term><option>--dh-bits=<replaceable
 
240
        >BITS</replaceable></option></term>
 
241
        <listitem>
 
242
          <para>
 
243
            DH bits to use in gnutls communication
 
244
          </para>
 
245
        </listitem>
 
246
      </varlistentry>
 
247
      
 
248
      <varlistentry>
 
249
        <term><option>--debug</option></term>
190
250
        <listitem>
191
251
          <para>
192
252
            Debug mode
195
255
      </varlistentry>
196
256
      
197
257
      <varlistentry>
198
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
258
        <term><option>--help</option></term>
 
259
        <term><option>-?</option></term>
199
260
        <listitem>
200
261
          <para>
201
262
            Gives a help message
204
265
      </varlistentry>
205
266
      
206
267
      <varlistentry>
207
 
        <term><literal>--usage</literal></term>
 
268
        <term><option>--usage</option></term>
208
269
        <listitem>
209
270
          <para>
210
271
            Gives a short usage message
213
274
      </varlistentry>
214
275
 
215
276
      <varlistentry>
216
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
277
        <term><option>--version</option></term>
 
278
        <term><option>-V</option></term>
217
279
        <listitem>
218
280
          <para>
219
281
            Prints the program version
220
282
          </para>
221
283
        </listitem>
222
 
      </varlistentry>            
 
284
      </varlistentry>
223
285
    </variablelist>
224
286
  </refsect1>
225
287
 
233
295
    <title>ENVIRONMENT</title>
234
296
    <para>
235
297
    </para>
236
 
  </refsect1>  
 
298
  </refsect1>
237
299
 
238
300
  <refsect1 id="file">
239
301
    <title>FILES</title>
240
302
    <para>
241
303
    </para>
242
 
  </refsect1>  
 
304
  </refsect1>
243
305
  
244
306
  <refsect1 id="bugs">
245
307
    <title>BUGS</title>
246
308
    <para>
247
309
    </para>
248
 
  </refsect1>  
 
310
  </refsect1>
249
311
 
250
312
  <refsect1 id="example">
251
313
    <title>EXAMPLE</title>
261
323
 
262
324
  <refsect1 id="see_also">
263
325
    <title>SEE ALSO</title>
 
326
    <para>
 
327
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
328
      <manvolnum>8</manvolnum></citerefentry>,
 
329
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
330
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
331
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
332
      <manvolnum>8mandos</manvolnum></citerefentry>
 
333
    </para>
264
334
    <itemizedlist>
265
335
      <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
336
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
282
337
      </para></listitem>
283
338
      
315
370
  </refsect1>
316
371
 
317
372
</refentry>
 
373
<!-- Local Variables: -->
 
374
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
375
<!-- time-stamp-end: "[\"']>" -->
 
376
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
377
<!-- End: -->