/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 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-29">
 
8
<!ENTITY TIMESTAMP "2008-08-31">
9
9
]>
10
10
 
11
11
<refentry>
75
75
  <refsynopsisdiv>
76
76
    <cmdsynopsis>
77
77
      <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>    
 
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>
99
145
  </refsynopsisdiv>
100
146
 
101
147
  <refsect1 id="description">
107
153
      passwords given is automaticly decrypted and passed to
108
154
      cryptsetup.
109
155
    </para>
110
 
  </refsect1>  
 
156
  </refsect1>
111
157
  
112
158
  <refsect1 id="options">
113
159
    <title>OPTIONS</title>
118
164
 
119
165
    <variablelist>
120
166
      <varlistentry>
121
 
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
122
 
        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>
123
173
        <listitem>
124
174
          <para>
125
175
            Connect directly to a specified mandos server
128
178
      </varlistentry>
129
179
 
130
180
      <varlistentry>
131
 
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
132
 
        KEYDIR</replaceable></literal></term>
 
181
        <term><option>--keydir=<replaceable
 
182
        >DIRECTORY</replaceable></option></term>
 
183
        <term><option>-d
 
184
        <replaceable>DIRECTORY</replaceable></option></term>
133
185
        <listitem>
134
186
          <para>
135
187
            Directory where the openpgp keyring is
136
188
          </para>
137
189
        </listitem>
138
 
      </varlistentry>      
 
190
      </varlistentry>
139
191
 
140
192
      <varlistentry>
141
 
        <term><literal>-i</literal>, <literal>--interface=
142
 
        <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>
143
197
        <listitem>
144
198
          <para>
145
 
            Interface that Avahi will conntect through
 
199
            Interface that Avahi will connect through
146
200
          </para>
147
201
        </listitem>
148
 
      </varlistentry>      
 
202
      </varlistentry>
149
203
 
150
204
      <varlistentry>
151
 
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
152
 
        PUBKEY</replaceable></literal></term>
 
205
        <term><option>--pubkey=<replaceable
 
206
        >FILE</replaceable></option></term>
 
207
        <term><option>-p
 
208
        <replaceable>FILE</replaceable></option></term>
153
209
        <listitem>
154
210
          <para>
155
211
            Public openpgp key for gnutls authentication
156
212
          </para>
157
213
        </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>
 
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>
192
250
        <listitem>
193
251
          <para>
194
252
            Debug mode
197
255
      </varlistentry>
198
256
      
199
257
      <varlistentry>
200
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
258
        <term><option>--help</option></term>
 
259
        <term><option>-?</option></term>
201
260
        <listitem>
202
261
          <para>
203
262
            Gives a help message
206
265
      </varlistentry>
207
266
      
208
267
      <varlistentry>
209
 
        <term><literal>--usage</literal></term>
 
268
        <term><option>--usage</option></term>
210
269
        <listitem>
211
270
          <para>
212
271
            Gives a short usage message
215
274
      </varlistentry>
216
275
 
217
276
      <varlistentry>
218
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
277
        <term><option>--version</option></term>
 
278
        <term><option>-V</option></term>
219
279
        <listitem>
220
280
          <para>
221
281
            Prints the program version
222
282
          </para>
223
283
        </listitem>
224
 
      </varlistentry>            
 
284
      </varlistentry>
225
285
    </variablelist>
226
286
  </refsect1>
227
287
 
235
295
    <title>ENVIRONMENT</title>
236
296
    <para>
237
297
    </para>
238
 
  </refsect1>  
 
298
  </refsect1>
239
299
 
240
300
  <refsect1 id="file">
241
301
    <title>FILES</title>
242
302
    <para>
243
303
    </para>
244
 
  </refsect1>  
 
304
  </refsect1>
245
305
  
246
306
  <refsect1 id="bugs">
247
307
    <title>BUGS</title>
248
308
    <para>
249
309
    </para>
250
 
  </refsect1>  
 
310
  </refsect1>
251
311
 
252
312
  <refsect1 id="example">
253
313
    <title>EXAMPLE</title>