/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 17:16:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830171633-rjyuhsemikw6lg2w
* mandos-keygen.xml (SYNOPSIS): Fixed tags.  Unify short and long
                                options.
* plugins.d/password-request.xml (SYNOPSIS): - '' -

* mandos-clients.conf.xml: Removed extra white space.
* plugin-runner.xml: - '' -
* plugins.d/password-prompt.xml: - '' -
* mandos-keygen.xml: - '' -
* plugins.d/password-request.xml: - '' -

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 "2016-02-28">
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
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>
60
73
    <cmdsynopsis>
61
74
      <command>&COMMANDNAME;</command>
62
75
      <group choice="opt">
63
 
        <arg choice="plain"><option>--prefix <replaceable
 
76
        <arg choice="plain"><option>-p <replaceable
64
77
        >PREFIX</replaceable></option></arg>
65
 
        <arg choice="plain"><option>-p </option><replaceable
 
78
        <arg choice="plain"><option>--prefix </option><replaceable
66
79
        >PREFIX</replaceable></arg>
67
80
      </group>
68
 
      <sbr/>
69
81
      <arg choice="opt"><option>--debug</option></arg>
70
82
    </cmdsynopsis>
71
83
    <cmdsynopsis>
72
84
      <command>&COMMANDNAME;</command>
73
85
      <group choice="req">
 
86
        <arg choice="plain"><option>-?</option></arg>
74
87
        <arg choice="plain"><option>--help</option></arg>
75
 
        <arg choice="plain"><option>-?</option></arg>
76
88
      </group>
77
89
    </cmdsynopsis>
78
90
    <cmdsynopsis>
82
94
    <cmdsynopsis>
83
95
      <command>&COMMANDNAME;</command>
84
96
      <group choice="req">
 
97
        <arg choice="plain"><option>-V</option></arg>
85
98
        <arg choice="plain"><option>--version</option></arg>
86
 
        <arg choice="plain"><option>-V</option></arg>
87
99
      </group>
88
100
    </cmdsynopsis>
89
101
  </refsynopsisdiv>
92
104
    <title>DESCRIPTION</title>
93
105
    <para>
94
106
      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.
 
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.
103
113
    </para>
104
114
    <para>
105
115
      This program is little more than a <citerefentry><refentrytitle
123
133
    
124
134
    <variablelist>
125
135
      <varlistentry>
126
 
        <term><option>--prefix=<replaceable
127
 
        >PREFIX</replaceable></option></term>
128
 
        <term><option>-p
129
 
        <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>
130
140
        <listitem>
131
141
          <para>
132
142
            Prefix string shown before the password prompt.
146
156
      </varlistentry>
147
157
      
148
158
      <varlistentry>
 
159
        <term><option>-?</option></term>
149
160
        <term><option>--help</option></term>
150
 
        <term><option>-?</option></term>
151
161
        <listitem>
152
162
          <para>
153
163
            Gives a help message about options and their meanings.
165
175
      </varlistentry>
166
176
      
167
177
      <varlistentry>
 
178
        <term><option>-V</option></term>
168
179
        <term><option>--version</option></term>
169
 
        <term><option>-V</option></term>
170
180
        <listitem>
171
181
          <para>
172
182
            Prints the program version.
190
200
    <title>ENVIRONMENT</title>
191
201
    <variablelist>
192
202
      <varlistentry>
193
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
194
 
        <term><envar>CRYPTTAB_NAME</envar></term>
 
203
        <term><envar>cryptsource</envar></term>
 
204
        <term><envar>crypttarget</envar></term>
195
205
        <listitem>
196
206
          <para>
197
207
            If set, these environment variables will be assumed to
205
215
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
206
216
          normally have inherited them from
207
217
          <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
 
218
          initial RAM disk environment, which will have set them from
 
219
          parsing kernel arguments and
210
220
          <filename>/conf/conf.d/cryptroot</filename> (also in the
211
221
          initial RAM disk environment), which in turn will have been
212
222
          created when the initial RAM disk image was created by
251
261
      <para>
252
262
        Show a prefix before the prompt; in this case, a host name.
253
263
        It might be useful to be reminded of which host needs a
254
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
264
        password, in case of KVM switches, etc.
255
265
      </para>
256
266
      <para>
257
267
 
281
291
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
282
292
      </citerefentry>, and will, when run standalone, outside, in a
283
293
      normal environment, immediately output on its standard output
284
 
      any presumably secret password it just received.  Therefore,
 
294
      any presumably secret password it just recieved.  Therefore,
285
295
      when running this program standalone (which should never
286
296
      normally be done), take care not to type in any real secret
287
297
      password by force of habit, since it would then immediately be
299
309
  <refsect1 id="see_also">
300
310
    <title>SEE ALSO</title>
301
311
    <para>
302
 
      <citerefentry><refentrytitle>intro</refentrytitle>
303
 
      <manvolnum>8mandos</manvolnum></citerefentry>
304
312
      <citerefentry><refentrytitle>crypttab</refentrytitle>
305
313
      <manvolnum>5</manvolnum></citerefentry>
306
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
314
      <citerefentry><refentrytitle>password-request</refentrytitle>
307
315
      <manvolnum>8mandos</manvolnum></citerefentry>
308
316
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
309
317
      <manvolnum>8mandos</manvolnum></citerefentry>,