/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

* network-hooks.d/wireless: Read from config file, so don't run "env".

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