/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

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>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>
 
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>
133
181
            Directory where the openpgp keyring is
134
182
          </para>
135
183
        </listitem>
136
 
      </varlistentry>      
 
184
      </varlistentry>
137
185
 
138
186
      <varlistentry>
139
187
        <term><literal>-i</literal>, <literal>--interface=
143
191
            Interface that Avahi will conntect through
144
192
          </para>
145
193
        </listitem>
146
 
      </varlistentry>      
 
194
      </varlistentry>
147
195
 
148
196
      <varlistentry>
149
197
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
153
201
            Public openpgp key for gnutls authentication
154
202
          </para>
155
203
        </listitem>
156
 
      </varlistentry>      
 
204
      </varlistentry>
157
205
 
158
206
      <varlistentry>
159
207
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
163
211
            Secret openpgp key for gnutls authentication
164
212
          </para>
165
213
        </listitem>
166
 
      </varlistentry>            
 
214
      </varlistentry>
167
215
      
168
216
      <varlistentry>
169
217
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
173
221
            GNUTLS priority
174
222
          </para>
175
223
        </listitem>
176
 
      </varlistentry>            
 
224
      </varlistentry>
177
225
 
178
226
      <varlistentry>
179
227
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
183
231
            dh-bits to use in gnutls communication
184
232
          </para>
185
233
        </listitem>
186
 
      </varlistentry>      
 
234
      </varlistentry>
187
235
      
188
236
      <varlistentry>
189
237
        <term><literal>--debug</literal></term>
219
267
            Prints the program version
220
268
          </para>
221
269
        </listitem>
222
 
      </varlistentry>            
 
270
      </varlistentry>
223
271
    </variablelist>
224
272
  </refsect1>
225
273
 
233
281
    <title>ENVIRONMENT</title>
234
282
    <para>
235
283
    </para>
236
 
  </refsect1>  
 
284
  </refsect1>
237
285
 
238
286
  <refsect1 id="file">
239
287
    <title>FILES</title>
240
288
    <para>
241
289
    </para>
242
 
  </refsect1>  
 
290
  </refsect1>
243
291
  
244
292
  <refsect1 id="bugs">
245
293
    <title>BUGS</title>
246
294
    <para>
247
295
    </para>
248
 
  </refsect1>  
 
296
  </refsect1>
249
297
 
250
298
  <refsect1 id="example">
251
299
    <title>EXAMPLE</title>
261
309
 
262
310
  <refsect1 id="see_also">
263
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>
264
320
    <itemizedlist>
265
321
      <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
322
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
282
323
      </para></listitem>
283
324
      
315
356
  </refsect1>
316
357
 
317
358
</refentry>
 
359
<!-- Local Variables: -->
 
360
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
361
<!-- time-stamp-end: "[\"']>" -->
 
362
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
363
<!-- End: -->