/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
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "password-prompt">
6
 
<!ENTITY TIMESTAMP "2008-09-04">
 
6
<!ENTITY TIMESTAMP "2008-08-31">
7
7
]>
8
8
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
10
10
  <refentryinfo>
11
11
    <title>Mandos Manual</title>
12
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
34
34
      <holder>Teddy Hogeborn</holder>
35
35
      <holder>Björn Påhlsson</holder>
36
36
    </copyright>
37
 
    <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>
38
60
  </refentryinfo>
39
61
  
40
62
  <refmeta>
87
109
      is not very useful on its own.  This program is really meant to
88
110
      run as a plugin in the <application>Mandos</application>
89
111
      client-side system, where it is used as a fallback and
90
 
      alternative to retrieving passwords from a <application
 
112
      alternative to retriving passwords from a <application
91
113
      >Mandos</application> server.
92
114
    </para>
93
115
    <para>
112
134
    
113
135
    <variablelist>
114
136
      <varlistentry>
115
 
        <term><option>--prefix=<replaceable
116
 
        >PREFIX</replaceable></option></term>
117
 
        <term><option>-p
118
 
        <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>
119
141
        <listitem>
120
142
          <para>
121
143
            Prefix string shown before the password prompt.
135
157
      </varlistentry>
136
158
      
137
159
      <varlistentry>
 
160
        <term><option>-?</option></term>
138
161
        <term><option>--help</option></term>
139
 
        <term><option>-?</option></term>
140
162
        <listitem>
141
163
          <para>
142
164
            Gives a help message about options and their meanings.
154
176
      </varlistentry>
155
177
      
156
178
      <varlistentry>
 
179
        <term><option>-V</option></term>
157
180
        <term><option>--version</option></term>
158
 
        <term><option>-V</option></term>
159
181
        <listitem>
160
182
          <para>
161
183
            Prints the program version.
194
216
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
195
217
          normally have inherited them from
196
218
          <filename>/scripts/local-top/cryptroot</filename> in the
197
 
          initial <acronym>RAM</acronym> disk environment, which will
198
 
          have set them from parsing kernel arguments and
 
219
          initial RAM disk environment, which will have set them from
 
220
          parsing kernel arguments and
199
221
          <filename>/conf/conf.d/cryptroot</filename> (also in the
200
222
          initial RAM disk environment), which in turn will have been
201
223
          created when the initial RAM disk image was created by
240
262
      <para>
241
263
        Show a prefix before the prompt; in this case, a host name.
242
264
        It might be useful to be reminded of which host needs a
243
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
265
        password, in case of KVM switches, etc.
244
266
      </para>
245
267
      <para>
246
268
 
270
292
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
271
293
      </citerefentry>, and will, when run standalone, outside, in a
272
294
      normal environment, immediately output on its standard output
273
 
      any presumably secret password it just received.  Therefore,
 
295
      any presumably secret password it just recieved.  Therefore,
274
296
      when running this program standalone (which should never
275
297
      normally be done), take care not to type in any real secret
276
298
      password by force of habit, since it would then immediately be