/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
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
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"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
6
8
<!ENTITY TIMESTAMP "2008-08-31">
7
9
]>
8
10
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
10
12
  <refentryinfo>
11
13
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
13
15
    <productname>Mandos</productname>
14
16
    <productnumber>&VERSION;</productnumber>
15
17
    <date>&TIMESTAMP;</date>
31
33
    </authorgroup>
32
34
    <copyright>
33
35
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
37
    </copyright>
37
 
    <xi:include href="../legalnotice.xml"/>
 
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>
38
61
  </refentryinfo>
39
62
 
40
63
  <refmeta>
63
86
      <sbr/>
64
87
      <group>
65
88
        <arg choice="plain"><option>--keydir
66
 
        <replaceable>DIRECTORY</replaceable></option></arg>
 
89
        <replaceable>KEYDIR</replaceable></option></arg>
67
90
        <arg choice="plain"><option>-d
68
 
        <replaceable>DIRECTORY</replaceable></option></arg>
 
91
        <replaceable>KEYDIR</replaceable></option></arg>
69
92
      </group>
70
93
      <sbr/>
71
94
      <group>
104
127
    <cmdsynopsis>
105
128
      <command>&COMMANDNAME;</command>
106
129
      <group choice="req">
107
 
        <arg choice="plain"><option>--help</option></arg>
108
 
        <arg choice="plain"><option>-?</option></arg>
 
130
        <arg choice='plain'><option>--help</option></arg>
 
131
        <arg choice='plain'><option>-?</option></arg>
109
132
      </group>
110
133
    </cmdsynopsis>
111
134
    <cmdsynopsis>
112
135
      <command>&COMMANDNAME;</command>
113
 
      <arg choice="plain"><option>--usage</option></arg>
 
136
      <arg choice='plain'><option>--usage</option></arg>
114
137
    </cmdsynopsis>
115
138
    <cmdsynopsis>
116
139
      <command>&COMMANDNAME;</command>
117
140
      <group choice="req">
118
 
        <arg choice="plain"><option>--version</option></arg>
119
 
        <arg choice="plain"><option>-V</option></arg>
 
141
        <arg choice='plain'><option>--version</option></arg>
 
142
        <arg choice='plain'><option>-V</option></arg>
120
143
      </group>
121
144
    </cmdsynopsis>
122
145
  </refsynopsisdiv>
141
164
 
142
165
    <variablelist>
143
166
      <varlistentry>
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>
 
167
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
168
        IP</replaceable></literal></term>
150
169
        <listitem>
151
170
          <para>
152
171
            Connect directly to a specified mandos server
155
174
      </varlistentry>
156
175
 
157
176
      <varlistentry>
158
 
        <term><option>--keydir=<replaceable
159
 
        >DIRECTORY</replaceable></option></term>
160
 
        <term><option>-d
161
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
177
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
178
        KEYDIR</replaceable></literal></term>
162
179
        <listitem>
163
180
          <para>
164
181
            Directory where the openpgp keyring is
167
184
      </varlistentry>
168
185
 
169
186
      <varlistentry>
170
 
        <term><option>--interface=
171
 
        <replaceable>NAME</replaceable></option></term>
172
 
        <term><option>-i
173
 
        <replaceable>NAME</replaceable></option></term>
 
187
        <term><literal>-i</literal>, <literal>--interface=
 
188
        <replaceable>INTERFACE</replaceable></literal></term>
174
189
        <listitem>
175
190
          <para>
176
 
            Interface that Avahi will connect through
 
191
            Interface that Avahi will conntect through
177
192
          </para>
178
193
        </listitem>
179
194
      </varlistentry>
180
195
 
181
196
      <varlistentry>
182
 
        <term><option>--pubkey=<replaceable
183
 
        >FILE</replaceable></option></term>
184
 
        <term><option>-p
185
 
        <replaceable>FILE</replaceable></option></term>
 
197
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
198
        PUBKEY</replaceable></literal></term>
186
199
        <listitem>
187
200
          <para>
188
201
            Public openpgp key for gnutls authentication
191
204
      </varlistentry>
192
205
 
193
206
      <varlistentry>
194
 
        <term><option>--seckey=<replaceable
195
 
        >FILE</replaceable></option></term>
196
 
        <term><option>-s
197
 
        <replaceable>FILE</replaceable></option></term>
 
207
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
 
208
        SECKEY</replaceable></literal></term>
198
209
        <listitem>
199
210
          <para>
200
 
            Secret OpenPGP key for GnuTLS authentication
 
211
            Secret openpgp key for gnutls authentication
201
212
          </para>
202
213
        </listitem>
203
214
      </varlistentry>
204
215
      
205
216
      <varlistentry>
206
 
        <term><option>--priority=<replaceable
207
 
        >STRING</replaceable></option></term>
 
217
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
 
218
        </literal></term>
208
219
        <listitem>
209
220
          <para>
210
 
            GnuTLS priority
 
221
            GNUTLS priority
211
222
          </para>
212
223
        </listitem>
213
224
      </varlistentry>
214
225
 
215
226
      <varlistentry>
216
 
        <term><option>--dh-bits=<replaceable
217
 
        >BITS</replaceable></option></term>
 
227
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
 
228
        </literal></term>
218
229
        <listitem>
219
230
          <para>
220
 
            DH bits to use in gnutls communication
 
231
            dh-bits to use in gnutls communication
221
232
          </para>
222
233
        </listitem>
223
234
      </varlistentry>
224
235
      
225
236
      <varlistentry>
226
 
        <term><option>--debug</option></term>
 
237
        <term><literal>--debug</literal></term>
227
238
        <listitem>
228
239
          <para>
229
240
            Debug mode
232
243
      </varlistentry>
233
244
      
234
245
      <varlistentry>
235
 
        <term><option>--help</option></term>
236
 
        <term><option>-?</option></term>
 
246
        <term><literal>-?</literal>, <literal>--help</literal></term>
237
247
        <listitem>
238
248
          <para>
239
249
            Gives a help message
242
252
      </varlistentry>
243
253
      
244
254
      <varlistentry>
245
 
        <term><option>--usage</option></term>
 
255
        <term><literal>--usage</literal></term>
246
256
        <listitem>
247
257
          <para>
248
258
            Gives a short usage message
251
261
      </varlistentry>
252
262
 
253
263
      <varlistentry>
254
 
        <term><option>--version</option></term>
255
 
        <term><option>-V</option></term>
 
264
        <term><literal>-V</literal>, <literal>--version</literal></term>
256
265
        <listitem>
257
266
          <para>
258
267
            Prints the program version