/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 10:27:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831102733-2u083dacxul80ynp
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
                               <literal>.  Split <term> tags into one
                               for each option.  Moved long options
                               before short.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2016-03-05">
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>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
34
      <holder>Teddy Hogeborn</holder>
44
35
      <holder>Björn Påhlsson</holder>
45
36
    </copyright>
46
 
    <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>
47
60
  </refentryinfo>
48
61
  
49
62
  <refmeta>
92
105
    <title>DESCRIPTION</title>
93
106
    <para>
94
107
      All <command>&COMMANDNAME;</command> does is prompt for a
95
 
      password and output any given password to standard output.
96
 
    </para>
97
 
    <para>
98
 
      This program is not very useful on its own.  This program is
99
 
      really meant to run as a plugin in the <application
100
 
      >Mandos</application> client-side system, where it is used as a
101
 
      fallback and alternative to retrieving passwords from a
102
 
      <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.
103
114
    </para>
104
115
    <para>
105
116
      This program is little more than a <citerefentry><refentrytitle
123
134
    
124
135
    <variablelist>
125
136
      <varlistentry>
126
 
        <term><option>--prefix=<replaceable
127
 
        >PREFIX</replaceable></option></term>
128
 
        <term><option>-p
129
 
        <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>
130
141
        <listitem>
131
142
          <para>
132
143
            Prefix string shown before the password prompt.
146
157
      </varlistentry>
147
158
      
148
159
      <varlistentry>
 
160
        <term><option>-?</option></term>
149
161
        <term><option>--help</option></term>
150
 
        <term><option>-?</option></term>
151
162
        <listitem>
152
163
          <para>
153
164
            Gives a help message about options and their meanings.
165
176
      </varlistentry>
166
177
      
167
178
      <varlistentry>
 
179
        <term><option>-V</option></term>
168
180
        <term><option>--version</option></term>
169
 
        <term><option>-V</option></term>
170
181
        <listitem>
171
182
          <para>
172
183
            Prints the program version.
190
201
    <title>ENVIRONMENT</title>
191
202
    <variablelist>
192
203
      <varlistentry>
193
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
194
 
        <term><envar>CRYPTTAB_NAME</envar></term>
 
204
        <term><envar>cryptsource</envar></term>
 
205
        <term><envar>crypttarget</envar></term>
195
206
        <listitem>
196
207
          <para>
197
208
            If set, these environment variables will be assumed to
205
216
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
206
217
          normally have inherited them from
207
218
          <filename>/scripts/local-top/cryptroot</filename> in the
208
 
          initial <acronym>RAM</acronym> disk environment, which will
209
 
          have set them from parsing kernel arguments and
 
219
          initial RAM disk environment, which will have set them from
 
220
          parsing kernel arguments and
210
221
          <filename>/conf/conf.d/cryptroot</filename> (also in the
211
222
          initial RAM disk environment), which in turn will have been
212
223
          created when the initial RAM disk image was created by
226
237
  
227
238
  <refsect1 id="bugs">
228
239
    <title>BUGS</title>
229
 
    <xi:include href="../bugs.xml"/>
 
240
    <para>
 
241
      None are known at this time.
 
242
    </para>
230
243
  </refsect1>
231
244
  
232
245
  <refsect1 id="example">
249
262
      <para>
250
263
        Show a prefix before the prompt; in this case, a host name.
251
264
        It might be useful to be reminded of which host needs a
252
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
265
        password, in case of KVM switches, etc.
253
266
      </para>
254
267
      <para>
255
268
 
279
292
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
280
293
      </citerefentry>, and will, when run standalone, outside, in a
281
294
      normal environment, immediately output on its standard output
282
 
      any presumably secret password it just received.  Therefore,
 
295
      any presumably secret password it just recieved.  Therefore,
283
296
      when running this program standalone (which should never
284
297
      normally be done), take care not to type in any real secret
285
298
      password by force of habit, since it would then immediately be
297
310
  <refsect1 id="see_also">
298
311
    <title>SEE ALSO</title>
299
312
    <para>
300
 
      <citerefentry><refentrytitle>intro</refentrytitle>
301
 
      <manvolnum>8mandos</manvolnum></citerefentry>
302
313
      <citerefentry><refentrytitle>crypttab</refentrytitle>
303
314
      <manvolnum>5</manvolnum></citerefentry>
304
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
315
      <citerefentry><refentrytitle>password-request</refentrytitle>
305
316
      <manvolnum>8mandos</manvolnum></citerefentry>
306
317
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
307
318
      <manvolnum>8mandos</manvolnum></citerefentry>,