/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-31 07:32:05 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831073205-9hggg03i1iird264
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
* mandos.xml (SYNOPSIS): - '' -
* plugins.d/password-prompt.xml (SYNOPSIS): - '' -
* plugins.d/password-request.xml (SYNOPSIS): - '' -

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