/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 07:32:05 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831073205-9hggg03i1iird264
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
* mandos.xml (SYNOPSIS): - '' -
* plugins.d/password-prompt.xml (SYNOPSIS): - '' -
* plugins.d/password-request.xml (SYNOPSIS): - '' -

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