/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-30 19:49:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830194924-f4liqq8wxajlbshn
* plugin-runner.xml (NAME): Improved wording.
  (SYNOPSIS): Use <option> and <replaceable> tags.  Unify short and
              long options.  Add "--global-envs" and "--envs-for"
              options.

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 "2019-02-10">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-30">
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
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
34
      <holder>Teddy Hogeborn</holder>
47
35
      <holder>Björn Påhlsson</holder>
48
36
    </copyright>
49
 
    <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>
50
60
  </refentryinfo>
51
61
  
52
62
  <refmeta>
63
73
    <cmdsynopsis>
64
74
      <command>&COMMANDNAME;</command>
65
75
      <group choice="opt">
66
 
        <arg choice="plain"><option>--prefix <replaceable
 
76
        <arg choice="plain"><option>-p <replaceable
67
77
        >PREFIX</replaceable></option></arg>
68
 
        <arg choice="plain"><option>-p </option><replaceable
 
78
        <arg choice="plain"><option>--prefix </option><replaceable
69
79
        >PREFIX</replaceable></arg>
70
80
      </group>
71
 
      <sbr/>
72
81
      <arg choice="opt"><option>--debug</option></arg>
73
82
    </cmdsynopsis>
74
83
    <cmdsynopsis>
75
84
      <command>&COMMANDNAME;</command>
76
85
      <group choice="req">
 
86
        <arg choice="plain"><option>-?</option></arg>
77
87
        <arg choice="plain"><option>--help</option></arg>
78
 
        <arg choice="plain"><option>-?</option></arg>
79
88
      </group>
80
89
    </cmdsynopsis>
81
90
    <cmdsynopsis>
85
94
    <cmdsynopsis>
86
95
      <command>&COMMANDNAME;</command>
87
96
      <group choice="req">
 
97
        <arg choice="plain"><option>-V</option></arg>
88
98
        <arg choice="plain"><option>--version</option></arg>
89
 
        <arg choice="plain"><option>-V</option></arg>
90
99
      </group>
91
100
    </cmdsynopsis>
92
101
  </refsynopsisdiv>
95
104
    <title>DESCRIPTION</title>
96
105
    <para>
97
106
      All <command>&COMMANDNAME;</command> does is prompt for a
98
 
      password and output any given password to standard output.
99
 
    </para>
100
 
    <para>
101
 
      This program is not very useful on its own.  This program is
102
 
      really meant to run as a plugin in the <application
103
 
      >Mandos</application> client-side system, where it is used as a
104
 
      fallback and alternative to retrieving passwords from a
105
 
      <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.
106
113
    </para>
107
114
    <para>
108
115
      This program is little more than a <citerefentry><refentrytitle
126
133
    
127
134
    <variablelist>
128
135
      <varlistentry>
129
 
        <term><option>--prefix=<replaceable
130
 
        >PREFIX</replaceable></option></term>
131
 
        <term><option>-p
132
 
        <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>
133
140
        <listitem>
134
141
          <para>
135
142
            Prefix string shown before the password prompt.
149
156
      </varlistentry>
150
157
      
151
158
      <varlistentry>
 
159
        <term><option>-?</option></term>
152
160
        <term><option>--help</option></term>
153
 
        <term><option>-?</option></term>
154
161
        <listitem>
155
162
          <para>
156
163
            Gives a help message about options and their meanings.
168
175
      </varlistentry>
169
176
      
170
177
      <varlistentry>
 
178
        <term><option>-V</option></term>
171
179
        <term><option>--version</option></term>
172
 
        <term><option>-V</option></term>
173
180
        <listitem>
174
181
          <para>
175
182
            Prints the program version.
193
200
    <title>ENVIRONMENT</title>
194
201
    <variablelist>
195
202
      <varlistentry>
196
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
197
 
        <term><envar>CRYPTTAB_NAME</envar></term>
 
203
        <term><envar>cryptsource</envar></term>
 
204
        <term><envar>crypttarget</envar></term>
198
205
        <listitem>
199
206
          <para>
200
207
            If set, these environment variables will be assumed to
208
215
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
209
216
          normally have inherited them from
210
217
          <filename>/scripts/local-top/cryptroot</filename> in the
211
 
          initial <acronym>RAM</acronym> disk environment, which will
212
 
          have set them from parsing kernel arguments and
 
218
          initial RAM disk environment, which will have set them from
 
219
          parsing kernel arguments and
213
220
          <filename>/conf/conf.d/cryptroot</filename> (also in the
214
221
          initial RAM disk environment), which in turn will have been
215
222
          created when the initial RAM disk image was created by
229
236
  
230
237
  <refsect1 id="bugs">
231
238
    <title>BUGS</title>
232
 
    <xi:include href="../bugs.xml"/>
 
239
    <para>
 
240
      None are known at this time.
 
241
    </para>
233
242
  </refsect1>
234
243
  
235
244
  <refsect1 id="example">
252
261
      <para>
253
262
        Show a prefix before the prompt; in this case, a host name.
254
263
        It might be useful to be reminded of which host needs a
255
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
264
        password, in case of KVM switches, etc.
256
265
      </para>
257
266
      <para>
258
267
 
282
291
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
283
292
      </citerefentry>, and will, when run standalone, outside, in a
284
293
      normal environment, immediately output on its standard output
285
 
      any presumably secret password it just received.  Therefore,
 
294
      any presumably secret password it just recieved.  Therefore,
286
295
      when running this program standalone (which should never
287
296
      normally be done), take care not to type in any real secret
288
297
      password by force of habit, since it would then immediately be
300
309
  <refsect1 id="see_also">
301
310
    <title>SEE ALSO</title>
302
311
    <para>
303
 
      <citerefentry><refentrytitle>intro</refentrytitle>
304
 
      <manvolnum>8mandos</manvolnum></citerefentry>
305
312
      <citerefentry><refentrytitle>crypttab</refentrytitle>
306
313
      <manvolnum>5</manvolnum></citerefentry>
307
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
314
      <citerefentry><refentrytitle>password-request</refentrytitle>
308
315
      <manvolnum>8mandos</manvolnum></citerefentry>
309
316
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
310
317
      <manvolnum>8mandos</manvolnum></citerefentry>,