/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-09-01 08:29:23 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901082923-i2liq6t7warmu9xe
* mandos.xml: Enclose "RAM" with <acronym>.
* overview.xml: - '' -

* plugin-runner.xml (DESCRIPTION): Improved wording.
  (PURPOSE): New section.
  (OPTIONS): Improved wording.
  (OVERVIEW, PLUGINS): New section.
  (FALLBACK): New empty placeholder section.

* plugins.d/password-prompt.xml: Enclose "RAM" with <acronym>.

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