/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-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 "2011-08-08">
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>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2011</year>
37
34
      <holder>Teddy Hogeborn</holder>
38
35
      <holder>Björn Påhlsson</holder>
39
36
    </copyright>
40
 
    <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>
41
60
  </refentryinfo>
42
61
  
43
62
  <refmeta>
86
105
    <title>DESCRIPTION</title>
87
106
    <para>
88
107
      All <command>&COMMANDNAME;</command> does is prompt for a
89
 
      password and output any given password to standard output.
90
 
    </para>
91
 
    <para>
92
 
      This program is not very useful on its own.  This program is
93
 
      really meant to run as a plugin in the <application
94
 
      >Mandos</application> client-side system, where it is used as a
95
 
      fallback and alternative to retrieving passwords from a
96
 
      <application >Mandos</application> server.
 
108
      password and output any given password to standard output.  This
 
109
      is not very useful on its own.  This program is really meant to
 
110
      run as a plugin in the <application>Mandos</application>
 
111
      client-side system, where it is used as a fallback and
 
112
      alternative to retriving passwords from a <application
 
113
      >Mandos</application> server.
97
114
    </para>
98
115
    <para>
99
116
      This program is little more than a <citerefentry><refentrytitle
117
134
    
118
135
    <variablelist>
119
136
      <varlistentry>
120
 
        <term><option>--prefix=<replaceable
121
 
        >PREFIX</replaceable></option></term>
122
 
        <term><option>-p
123
 
        <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>
124
141
        <listitem>
125
142
          <para>
126
143
            Prefix string shown before the password prompt.
140
157
      </varlistentry>
141
158
      
142
159
      <varlistentry>
 
160
        <term><option>-?</option></term>
143
161
        <term><option>--help</option></term>
144
 
        <term><option>-?</option></term>
145
162
        <listitem>
146
163
          <para>
147
164
            Gives a help message about options and their meanings.
159
176
      </varlistentry>
160
177
      
161
178
      <varlistentry>
 
179
        <term><option>-V</option></term>
162
180
        <term><option>--version</option></term>
163
 
        <term><option>-V</option></term>
164
181
        <listitem>
165
182
          <para>
166
183
            Prints the program version.
184
201
    <title>ENVIRONMENT</title>
185
202
    <variablelist>
186
203
      <varlistentry>
187
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
188
 
        <term><envar>CRYPTTAB_NAME</envar></term>
 
204
        <term><envar>cryptsource</envar></term>
 
205
        <term><envar>crypttarget</envar></term>
189
206
        <listitem>
190
207
          <para>
191
208
            If set, these environment variables will be assumed to
199
216
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
200
217
          normally have inherited them from
201
218
          <filename>/scripts/local-top/cryptroot</filename> in the
202
 
          initial <acronym>RAM</acronym> disk environment, which will
203
 
          have set them from parsing kernel arguments and
 
219
          initial RAM disk environment, which will have set them from
 
220
          parsing kernel arguments and
204
221
          <filename>/conf/conf.d/cryptroot</filename> (also in the
205
222
          initial RAM disk environment), which in turn will have been
206
223
          created when the initial RAM disk image was created by
245
262
      <para>
246
263
        Show a prefix before the prompt; in this case, a host name.
247
264
        It might be useful to be reminded of which host needs a
248
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
265
        password, in case of KVM switches, etc.
249
266
      </para>
250
267
      <para>
251
268
 
275
292
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
276
293
      </citerefentry>, and will, when run standalone, outside, in a
277
294
      normal environment, immediately output on its standard output
278
 
      any presumably secret password it just received.  Therefore,
 
295
      any presumably secret password it just recieved.  Therefore,
279
296
      when running this program standalone (which should never
280
297
      normally be done), take care not to type in any real secret
281
298
      password by force of habit, since it would then immediately be
293
310
  <refsect1 id="see_also">
294
311
    <title>SEE ALSO</title>
295
312
    <para>
296
 
      <citerefentry><refentrytitle>intro</refentrytitle>
297
 
      <manvolnum>8mandos</manvolnum></citerefentry>
298
313
      <citerefentry><refentrytitle>crypttab</refentrytitle>
299
314
      <manvolnum>5</manvolnum></citerefentry>
300
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
315
      <citerefentry><refentrytitle>password-request</refentrytitle>
301
316
      <manvolnum>8mandos</manvolnum></citerefentry>
302
317
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
303
318
      <manvolnum>8mandos</manvolnum></citerefentry>,