/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/password-prompt.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-prompt.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "password-prompt">
5
 
<!ENTITY TIMESTAMP "2008-09-30">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-31">
8
7
]>
9
8
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
11
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
35
34
      <holder>Teddy Hogeborn</holder>
36
35
      <holder>Björn Påhlsson</holder>
37
36
    </copyright>
38
 
    <xi:include href="../legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
      
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
      
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
39
60
  </refentryinfo>
40
61
  
41
62
  <refmeta>
88
109
      is not very useful on its own.  This program is really meant to
89
110
      run as a plugin in the <application>Mandos</application>
90
111
      client-side system, where it is used as a fallback and
91
 
      alternative to retrieving passwords from a <application
 
112
      alternative to retriving passwords from a <application
92
113
      >Mandos</application> server.
93
114
    </para>
94
115
    <para>
113
134
    
114
135
    <variablelist>
115
136
      <varlistentry>
116
 
        <term><option>--prefix=<replaceable
117
 
        >PREFIX</replaceable></option></term>
118
 
        <term><option>-p
119
 
        <replaceable>PREFIX</replaceable></option></term>
 
137
        <term><option>-p</option> <replaceable>PREFIX</replaceable
 
138
        ></term>
 
139
        <term><option>--prefix=</option><replaceable
 
140
        >PREFIX</replaceable></term>
120
141
        <listitem>
121
142
          <para>
122
143
            Prefix string shown before the password prompt.
136
157
      </varlistentry>
137
158
      
138
159
      <varlistentry>
 
160
        <term><option>-?</option></term>
139
161
        <term><option>--help</option></term>
140
 
        <term><option>-?</option></term>
141
162
        <listitem>
142
163
          <para>
143
164
            Gives a help message about options and their meanings.
155
176
      </varlistentry>
156
177
      
157
178
      <varlistentry>
 
179
        <term><option>-V</option></term>
158
180
        <term><option>--version</option></term>
159
 
        <term><option>-V</option></term>
160
181
        <listitem>
161
182
          <para>
162
183
            Prints the program version.
195
216
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
196
217
          normally have inherited them from
197
218
          <filename>/scripts/local-top/cryptroot</filename> in the
198
 
          initial <acronym>RAM</acronym> disk environment, which will
199
 
          have set them from parsing kernel arguments and
 
219
          initial RAM disk environment, which will have set them from
 
220
          parsing kernel arguments and
200
221
          <filename>/conf/conf.d/cryptroot</filename> (also in the
201
222
          initial RAM disk environment), which in turn will have been
202
223
          created when the initial RAM disk image was created by
241
262
      <para>
242
263
        Show a prefix before the prompt; in this case, a host name.
243
264
        It might be useful to be reminded of which host needs a
244
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
265
        password, in case of KVM switches, etc.
245
266
      </para>
246
267
      <para>
247
268
 
271
292
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
272
293
      </citerefentry>, and will, when run standalone, outside, in a
273
294
      normal environment, immediately output on its standard output
274
 
      any presumably secret password it just received.  Therefore,
 
295
      any presumably secret password it just recieved.  Therefore,
275
296
      when running this program standalone (which should never
276
297
      normally be done), take care not to type in any real secret
277
298
      password by force of habit, since it would then immediately be
291
312
    <para>
292
313
      <citerefentry><refentrytitle>crypttab</refentrytitle>
293
314
      <manvolnum>5</manvolnum></citerefentry>
294
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
315
      <citerefentry><refentrytitle>password-request</refentrytitle>
295
316
      <manvolnum>8mandos</manvolnum></citerefentry>
296
317
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
297
318
      <manvolnum>8mandos</manvolnum></citerefentry>,