/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: 2016-03-05 21:42:56 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 335.
  • Revision ID: teddy@recompile.se-20160305214256-79progf0wfkd9068
Add bug reporting information to manual pages

* bugs.xml: New file.
* intro.xml (BUGS): New section; include "bugs.xml".
* mandos-clients.conf.xml (BUGS): Include "bugs.xml".
* mandos-ctl.xml (BUGS): Uncommented; include "bugs.xml".
* mandos-keygen.xml (BUGS): - '' -
* mandos-monitor.xml (BUGS): Include "bugs.xml".
* mandos.conf.xml (BUGS): - '' -
* mandos.xml (BUGS): - '' -
* plugin-runner.xml (BUGS): - '' -
* plugins.d/askpass-fifo.xml (BUGS): New section; include
                                     "../bugs.xml".
* plugins.d/mandos-client.xml (BUGS): Uncommented; include
                                     "../bugs.xml".
* plugins.d/password-prompt.xml (BUGS): Include "../bugs.xml".
* plugins.d/plymouth.xml (BUGS): - '' -
* plugins.d/splashy.xml (BUGS): - '' -
* plugins.d/usplash.xml (BUGS): - '' -

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">
5
4
<!ENTITY COMMANDNAME "password-prompt">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
5
<!ENTITY TIMESTAMP "2016-03-05">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <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>
34
43
      <holder>Teddy Hogeborn</holder>
35
44
      <holder>Björn Påhlsson</holder>
36
45
    </copyright>
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>
 
46
    <xi:include href="../legalnotice.xml"/>
60
47
  </refentryinfo>
61
48
  
62
49
  <refmeta>
105
92
    <title>DESCRIPTION</title>
106
93
    <para>
107
94
      All <command>&COMMANDNAME;</command> does is prompt for a
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.
 
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.
114
103
    </para>
115
104
    <para>
116
105
      This program is little more than a <citerefentry><refentrytitle
134
123
    
135
124
    <variablelist>
136
125
      <varlistentry>
137
 
        <term><option>-p</option> <replaceable>PREFIX</replaceable
138
 
        ></term>
139
 
        <term><option>--prefix=</option><replaceable
140
 
        >PREFIX</replaceable></term>
 
126
        <term><option>--prefix=<replaceable
 
127
        >PREFIX</replaceable></option></term>
 
128
        <term><option>-p
 
129
        <replaceable>PREFIX</replaceable></option></term>
141
130
        <listitem>
142
131
          <para>
143
132
            Prefix string shown before the password prompt.
157
146
      </varlistentry>
158
147
      
159
148
      <varlistentry>
 
149
        <term><option>--help</option></term>
160
150
        <term><option>-?</option></term>
161
 
        <term><option>--help</option></term>
162
151
        <listitem>
163
152
          <para>
164
153
            Gives a help message about options and their meanings.
176
165
      </varlistentry>
177
166
      
178
167
      <varlistentry>
 
168
        <term><option>--version</option></term>
179
169
        <term><option>-V</option></term>
180
 
        <term><option>--version</option></term>
181
170
        <listitem>
182
171
          <para>
183
172
            Prints the program version.
201
190
    <title>ENVIRONMENT</title>
202
191
    <variablelist>
203
192
      <varlistentry>
204
 
        <term><envar>cryptsource</envar></term>
205
 
        <term><envar>crypttarget</envar></term>
 
193
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
194
        <term><envar>CRYPTTAB_NAME</envar></term>
206
195
        <listitem>
207
196
          <para>
208
197
            If set, these environment variables will be assumed to
216
205
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
217
206
          normally have inherited them from
218
207
          <filename>/scripts/local-top/cryptroot</filename> in the
219
 
          initial RAM disk environment, which will have set them from
220
 
          parsing kernel arguments and
 
208
          initial <acronym>RAM</acronym> disk environment, which will
 
209
          have set them from parsing kernel arguments and
221
210
          <filename>/conf/conf.d/cryptroot</filename> (also in the
222
211
          initial RAM disk environment), which in turn will have been
223
212
          created when the initial RAM disk image was created by
237
226
  
238
227
  <refsect1 id="bugs">
239
228
    <title>BUGS</title>
240
 
    <para>
241
 
      None are known at this time.
242
 
    </para>
 
229
    <xi:include href="../bugs.xml"/>
243
230
  </refsect1>
244
231
  
245
232
  <refsect1 id="example">
262
249
      <para>
263
250
        Show a prefix before the prompt; in this case, a host name.
264
251
        It might be useful to be reminded of which host needs a
265
 
        password, in case of KVM switches, etc.
 
252
        password, in case of <acronym>KVM</acronym> switches, etc.
266
253
      </para>
267
254
      <para>
268
255
 
292
279
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
293
280
      </citerefentry>, and will, when run standalone, outside, in a
294
281
      normal environment, immediately output on its standard output
295
 
      any presumably secret password it just recieved.  Therefore,
 
282
      any presumably secret password it just received.  Therefore,
296
283
      when running this program standalone (which should never
297
284
      normally be done), take care not to type in any real secret
298
285
      password by force of habit, since it would then immediately be
310
297
  <refsect1 id="see_also">
311
298
    <title>SEE ALSO</title>
312
299
    <para>
 
300
      <citerefentry><refentrytitle>intro</refentrytitle>
 
301
      <manvolnum>8mandos</manvolnum></citerefentry>
313
302
      <citerefentry><refentrytitle>crypttab</refentrytitle>
314
303
      <manvolnum>5</manvolnum></citerefentry>
315
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
304
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
316
305
      <manvolnum>8mandos</manvolnum></citerefentry>
317
306
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
318
307
      <manvolnum>8mandos</manvolnum></citerefentry>,