/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: 2010-10-13 06:12:52 UTC
  • Revision ID: teddy@fukt.bsnet.se-20101013061252-3a918xedja5caya8
* debian/mandos-client.lintian-overrides: Added plugins.d/plymouth.

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 "2009-10-30">
 
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>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </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>
 
39
    <xi:include href="../legalnotice.xml"/>
60
40
  </refentryinfo>
61
41
  
62
42
  <refmeta>
105
85
    <title>DESCRIPTION</title>
106
86
    <para>
107
87
      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.
 
88
      password and output any given password to standard output.
 
89
    </para>
 
90
    <para>
 
91
      This program is not very useful on its own.  This program is
 
92
      really meant to run as a plugin in the <application
 
93
      >Mandos</application> client-side system, where it is used as a
 
94
      fallback and alternative to retrieving passwords from a
 
95
      <application >Mandos</application> server.
114
96
    </para>
115
97
    <para>
116
98
      This program is little more than a <citerefentry><refentrytitle
134
116
    
135
117
    <variablelist>
136
118
      <varlistentry>
137
 
        <term><option>-p</option> <replaceable>PREFIX</replaceable
138
 
        ></term>
139
 
        <term><option>--prefix=</option><replaceable
140
 
        >PREFIX</replaceable></term>
 
119
        <term><option>--prefix=<replaceable
 
120
        >PREFIX</replaceable></option></term>
 
121
        <term><option>-p
 
122
        <replaceable>PREFIX</replaceable></option></term>
141
123
        <listitem>
142
124
          <para>
143
125
            Prefix string shown before the password prompt.
157
139
      </varlistentry>
158
140
      
159
141
      <varlistentry>
 
142
        <term><option>--help</option></term>
160
143
        <term><option>-?</option></term>
161
 
        <term><option>--help</option></term>
162
144
        <listitem>
163
145
          <para>
164
146
            Gives a help message about options and their meanings.
176
158
      </varlistentry>
177
159
      
178
160
      <varlistentry>
 
161
        <term><option>--version</option></term>
179
162
        <term><option>-V</option></term>
180
 
        <term><option>--version</option></term>
181
163
        <listitem>
182
164
          <para>
183
165
            Prints the program version.
201
183
    <title>ENVIRONMENT</title>
202
184
    <variablelist>
203
185
      <varlistentry>
204
 
        <term><envar>cryptsource</envar></term>
205
 
        <term><envar>crypttarget</envar></term>
 
186
        <term><envar>CRYPTTAB_SOURCE</envar></term>
 
187
        <term><envar>CRYPTTAB_NAME</envar></term>
206
188
        <listitem>
207
189
          <para>
208
190
            If set, these environment variables will be assumed to
216
198
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
217
199
          normally have inherited them from
218
200
          <filename>/scripts/local-top/cryptroot</filename> in the
219
 
          initial RAM disk environment, which will have set them from
220
 
          parsing kernel arguments and
 
201
          initial <acronym>RAM</acronym> disk environment, which will
 
202
          have set them from parsing kernel arguments and
221
203
          <filename>/conf/conf.d/cryptroot</filename> (also in the
222
204
          initial RAM disk environment), which in turn will have been
223
205
          created when the initial RAM disk image was created by
262
244
      <para>
263
245
        Show a prefix before the prompt; in this case, a host name.
264
246
        It might be useful to be reminded of which host needs a
265
 
        password, in case of KVM switches, etc.
 
247
        password, in case of <acronym>KVM</acronym> switches, etc.
266
248
      </para>
267
249
      <para>
268
250
 
292
274
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
293
275
      </citerefentry>, and will, when run standalone, outside, in a
294
276
      normal environment, immediately output on its standard output
295
 
      any presumably secret password it just recieved.  Therefore,
 
277
      any presumably secret password it just received.  Therefore,
296
278
      when running this program standalone (which should never
297
279
      normally be done), take care not to type in any real secret
298
280
      password by force of habit, since it would then immediately be
312
294
    <para>
313
295
      <citerefentry><refentrytitle>crypttab</refentrytitle>
314
296
      <manvolnum>5</manvolnum></citerefentry>
315
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
297
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
316
298
      <manvolnum>8mandos</manvolnum></citerefentry>
317
299
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
318
300
      <manvolnum>8mandos</manvolnum></citerefentry>,