/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-18 03:25:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818032501-2cl874fi3uvsqn1b
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
                         tags.  Also show the "-h" option.
  (OPTIONS): Note that failure to obey the "--interface" option is not
             considered critical.
  (ENVIRONMENT): New section to document the use of PATH by /bin/sh.
  (FILES): Added "/bin/sh".
  (BUGS): Add five bugs from the TODO file.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).
  (SERVER, CLIENTS): Added "id" attribute.
  (CLIENT): Document the security implications of one of the five
            bugs added to the BUGS section.

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