/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-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

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-10-03">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-29">
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
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>
54
73
    <cmdsynopsis>
55
74
      <command>&COMMANDNAME;</command>
56
75
      <group choice="opt">
57
 
        <arg choice="plain"><option>--prefix <replaceable
 
76
        <arg choice="plain"><option>-p <replaceable
58
77
        >PREFIX</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-p </option><replaceable
 
78
        <arg choice="plain"><option>--prefix </option><replaceable
60
79
        >PREFIX</replaceable></arg>
61
80
      </group>
62
 
      <sbr/>
63
81
      <arg choice="opt"><option>--debug</option></arg>
64
82
    </cmdsynopsis>
65
83
    <cmdsynopsis>
66
84
      <command>&COMMANDNAME;</command>
67
85
      <group choice="req">
 
86
        <arg choice="plain"><option>-?</option></arg>
68
87
        <arg choice="plain"><option>--help</option></arg>
69
 
        <arg choice="plain"><option>-?</option></arg>
70
88
      </group>
71
89
    </cmdsynopsis>
72
90
    <cmdsynopsis>
76
94
    <cmdsynopsis>
77
95
      <command>&COMMANDNAME;</command>
78
96
      <group choice="req">
 
97
        <arg choice="plain"><option>-V</option></arg>
79
98
        <arg choice="plain"><option>--version</option></arg>
80
 
        <arg choice="plain"><option>-V</option></arg>
81
99
      </group>
82
 
    </cmdsynopsis>
 
100
    </cmdsynopsis>    
83
101
  </refsynopsisdiv>
84
102
  
85
103
  <refsect1 id="description">
86
104
    <title>DESCRIPTION</title>
87
105
    <para>
88
106
      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.
 
107
      password and output any given password to standard output.  This
 
108
      is not very useful on its own.  This program is really meant to
 
109
      run as a plugin in the <application>Mandos</application>
 
110
      client-side system, where it is used as a fallback and
 
111
      alternative to retriving passwords from a <application
 
112
      >Mandos</application> server.
97
113
    </para>
98
114
    <para>
99
115
      This program is little more than a <citerefentry><refentrytitle
117
133
    
118
134
    <variablelist>
119
135
      <varlistentry>
120
 
        <term><option>--prefix=<replaceable
121
 
        >PREFIX</replaceable></option></term>
122
 
        <term><option>-p
123
 
        <replaceable>PREFIX</replaceable></option></term>
 
136
        <term><option>-p</option> <replaceable>PREFIX</replaceable
 
137
        ></term>
 
138
        <term><option>--prefix=</option><replaceable
 
139
        >PREFIX</replaceable></term>
124
140
        <listitem>
125
141
          <para>
126
142
            Prefix string shown before the password prompt.
140
156
      </varlistentry>
141
157
      
142
158
      <varlistentry>
 
159
        <term><option>-?</option></term>
143
160
        <term><option>--help</option></term>
144
 
        <term><option>-?</option></term>
145
161
        <listitem>
146
162
          <para>
147
163
            Gives a help message about options and their meanings.
159
175
      </varlistentry>
160
176
      
161
177
      <varlistentry>
 
178
        <term><option>-V</option></term>
162
179
        <term><option>--version</option></term>
163
 
        <term><option>-V</option></term>
164
180
        <listitem>
165
181
          <para>
166
182
            Prints the program version.
167
183
          </para>
168
184
        </listitem>
169
 
      </varlistentry>
 
185
      </varlistentry>            
170
186
    </variablelist>
171
187
  </refsect1>
172
188
  
184
200
    <title>ENVIRONMENT</title>
185
201
    <variablelist>
186
202
      <varlistentry>
187
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
188
 
        <term><envar>CRYPTTAB_NAME</envar></term>
 
203
        <term><envar>cryptsource</envar></term>
 
204
        <term><envar>crypttarget</envar></term>
189
205
        <listitem>
190
206
          <para>
191
207
            If set, these environment variables will be assumed to
199
215
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
200
216
          normally have inherited them from
201
217
          <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
 
218
          initial RAM disk environment, which will have set them from
 
219
          parsing kernel arguments and
204
220
          <filename>/conf/conf.d/cryptroot</filename> (also in the
205
221
          initial RAM disk environment), which in turn will have been
206
222
          created when the initial RAM disk image was created by
223
239
    <para>
224
240
      None are known at this time.
225
241
    </para>
226
 
  </refsect1>
 
242
  </refsect1>  
227
243
  
228
244
  <refsect1 id="example">
229
245
    <title>EXAMPLE</title>
245
261
      <para>
246
262
        Show a prefix before the prompt; in this case, a host name.
247
263
        It might be useful to be reminded of which host needs a
248
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
264
        password, in case of KVM switches, etc.
249
265
      </para>
250
266
      <para>
251
267
 
275
291
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
276
292
      </citerefentry>, and will, when run standalone, outside, in a
277
293
      normal environment, immediately output on its standard output
278
 
      any presumably secret password it just received.  Therefore,
 
294
      any presumably secret password it just recieved.  Therefore,
279
295
      when running this program standalone (which should never
280
296
      normally be done), take care not to type in any real secret
281
297
      password by force of habit, since it would then immediately be
293
309
  <refsect1 id="see_also">
294
310
    <title>SEE ALSO</title>
295
311
    <para>
296
 
      <citerefentry><refentrytitle>intro</refentrytitle>
297
 
      <manvolnum>8mandos</manvolnum></citerefentry>
298
312
      <citerefentry><refentrytitle>crypttab</refentrytitle>
299
313
      <manvolnum>5</manvolnum></citerefentry>
300
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
314
      <citerefentry><refentrytitle>password-request</refentrytitle>
301
315
      <manvolnum>8mandos</manvolnum></citerefentry>
302
316
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
303
317
      <manvolnum>8mandos</manvolnum></citerefentry>,