/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

merge

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-30">
 
5
<!ENTITY TIMESTAMP "2008-10-04">
 
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>
34
35
      <holder>Teddy Hogeborn</holder>
35
36
      <holder>Björn Påhlsson</holder>
36
37
    </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>
 
38
    <xi:include href="../legalnotice.xml"/>
60
39
  </refentryinfo>
61
40
  
62
41
  <refmeta>
73
52
    <cmdsynopsis>
74
53
      <command>&COMMANDNAME;</command>
75
54
      <group choice="opt">
76
 
        <arg choice="plain"><option>-p <replaceable
 
55
        <arg choice="plain"><option>--prefix <replaceable
77
56
        >PREFIX</replaceable></option></arg>
78
 
        <arg choice="plain"><option>--prefix </option><replaceable
 
57
        <arg choice="plain"><option>-p </option><replaceable
79
58
        >PREFIX</replaceable></arg>
80
59
      </group>
 
60
      <sbr/>
81
61
      <arg choice="opt"><option>--debug</option></arg>
82
62
    </cmdsynopsis>
83
63
    <cmdsynopsis>
84
64
      <command>&COMMANDNAME;</command>
85
65
      <group choice="req">
 
66
        <arg choice="plain"><option>--help</option></arg>
86
67
        <arg choice="plain"><option>-?</option></arg>
87
 
        <arg choice="plain"><option>--help</option></arg>
88
68
      </group>
89
69
    </cmdsynopsis>
90
70
    <cmdsynopsis>
94
74
    <cmdsynopsis>
95
75
      <command>&COMMANDNAME;</command>
96
76
      <group choice="req">
 
77
        <arg choice="plain"><option>--version</option></arg>
97
78
        <arg choice="plain"><option>-V</option></arg>
98
 
        <arg choice="plain"><option>--version</option></arg>
99
79
      </group>
100
80
    </cmdsynopsis>
101
81
  </refsynopsisdiv>
104
84
    <title>DESCRIPTION</title>
105
85
    <para>
106
86
      All <command>&COMMANDNAME;</command> does is prompt for a
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.
 
87
      password and output any given password to standard output.
 
88
    </para>
 
89
    <para>
 
90
      This program is not very useful on its own.  This program is
 
91
      really meant to run as a plugin in the <application
 
92
      >Mandos</application> client-side system, where it is used as a
 
93
      fallback and alternative to retrieving passwords from a
 
94
      <application >Mandos</application> server.
113
95
    </para>
114
96
    <para>
115
97
      This program is little more than a <citerefentry><refentrytitle
133
115
    
134
116
    <variablelist>
135
117
      <varlistentry>
136
 
        <term><option>-p</option> <replaceable>PREFIX</replaceable
137
 
        ></term>
138
 
        <term><option>--prefix=</option><replaceable
139
 
        >PREFIX</replaceable></term>
 
118
        <term><option>--prefix=<replaceable
 
119
        >PREFIX</replaceable></option></term>
 
120
        <term><option>-p
 
121
        <replaceable>PREFIX</replaceable></option></term>
140
122
        <listitem>
141
123
          <para>
142
124
            Prefix string shown before the password prompt.
156
138
      </varlistentry>
157
139
      
158
140
      <varlistentry>
 
141
        <term><option>--help</option></term>
159
142
        <term><option>-?</option></term>
160
 
        <term><option>--help</option></term>
161
143
        <listitem>
162
144
          <para>
163
145
            Gives a help message about options and their meanings.
175
157
      </varlistentry>
176
158
      
177
159
      <varlistentry>
 
160
        <term><option>--version</option></term>
178
161
        <term><option>-V</option></term>
179
 
        <term><option>--version</option></term>
180
162
        <listitem>
181
163
          <para>
182
164
            Prints the program version.
215
197
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
216
198
          normally have inherited them from
217
199
          <filename>/scripts/local-top/cryptroot</filename> in the
218
 
          initial RAM disk environment, which will have set them from
219
 
          parsing kernel arguments and
 
200
          initial <acronym>RAM</acronym> disk environment, which will
 
201
          have set them from parsing kernel arguments and
220
202
          <filename>/conf/conf.d/cryptroot</filename> (also in the
221
203
          initial RAM disk environment), which in turn will have been
222
204
          created when the initial RAM disk image was created by
261
243
      <para>
262
244
        Show a prefix before the prompt; in this case, a host name.
263
245
        It might be useful to be reminded of which host needs a
264
 
        password, in case of KVM switches, etc.
 
246
        password, in case of <acronym>KVM</acronym> switches, etc.
265
247
      </para>
266
248
      <para>
267
249
 
291
273
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
292
274
      </citerefentry>, and will, when run standalone, outside, in a
293
275
      normal environment, immediately output on its standard output
294
 
      any presumably secret password it just recieved.  Therefore,
 
276
      any presumably secret password it just received.  Therefore,
295
277
      when running this program standalone (which should never
296
278
      normally be done), take care not to type in any real secret
297
279
      password by force of habit, since it would then immediately be
311
293
    <para>
312
294
      <citerefentry><refentrytitle>crypttab</refentrytitle>
313
295
      <manvolnum>5</manvolnum></citerefentry>
314
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
296
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
315
297
      <manvolnum>8mandos</manvolnum></citerefentry>
316
298
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
317
299
      <manvolnum>8mandos</manvolnum></citerefentry>,