/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: Björn Påhlsson
  • Date: 2008-12-21 16:34:22 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 238.
  • Revision ID: belorn@braxen-20081221163422-nzolm1l1yed6ta9g
added a mandos list client program

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 "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>
105
84
    <title>DESCRIPTION</title>
106
85
    <para>
107
86
      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.
 
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.
114
95
    </para>
115
96
    <para>
116
97
      This program is little more than a <citerefentry><refentrytitle
134
115
    
135
116
    <variablelist>
136
117
      <varlistentry>
137
 
        <term><option>-p</option> <replaceable>PREFIX</replaceable
138
 
        ></term>
139
 
        <term><option>--prefix=</option><replaceable
140
 
        >PREFIX</replaceable></term>
 
118
        <term><option>--prefix=<replaceable
 
119
        >PREFIX</replaceable></option></term>
 
120
        <term><option>-p
 
121
        <replaceable>PREFIX</replaceable></option></term>
141
122
        <listitem>
142
123
          <para>
143
124
            Prefix string shown before the password prompt.
157
138
      </varlistentry>
158
139
      
159
140
      <varlistentry>
 
141
        <term><option>--help</option></term>
160
142
        <term><option>-?</option></term>
161
 
        <term><option>--help</option></term>
162
143
        <listitem>
163
144
          <para>
164
145
            Gives a help message about options and their meanings.
176
157
      </varlistentry>
177
158
      
178
159
      <varlistentry>
 
160
        <term><option>--version</option></term>
179
161
        <term><option>-V</option></term>
180
 
        <term><option>--version</option></term>
181
162
        <listitem>
182
163
          <para>
183
164
            Prints the program version.
216
197
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
217
198
          normally have inherited them from
218
199
          <filename>/scripts/local-top/cryptroot</filename> in the
219
 
          initial RAM disk environment, which will have set them from
220
 
          parsing kernel arguments and
 
200
          initial <acronym>RAM</acronym> disk environment, which will
 
201
          have set them from parsing kernel arguments and
221
202
          <filename>/conf/conf.d/cryptroot</filename> (also in the
222
203
          initial RAM disk environment), which in turn will have been
223
204
          created when the initial RAM disk image was created by
262
243
      <para>
263
244
        Show a prefix before the prompt; in this case, a host name.
264
245
        It might be useful to be reminded of which host needs a
265
 
        password, in case of KVM switches, etc.
 
246
        password, in case of <acronym>KVM</acronym> switches, etc.
266
247
      </para>
267
248
      <para>
268
249
 
292
273
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
293
274
      </citerefentry>, and will, when run standalone, outside, in a
294
275
      normal environment, immediately output on its standard output
295
 
      any presumably secret password it just recieved.  Therefore,
 
276
      any presumably secret password it just received.  Therefore,
296
277
      when running this program standalone (which should never
297
278
      normally be done), take care not to type in any real secret
298
279
      password by force of habit, since it would then immediately be
312
293
    <para>
313
294
      <citerefentry><refentrytitle>crypttab</refentrytitle>
314
295
      <manvolnum>5</manvolnum></citerefentry>
315
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
296
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
316
297
      <manvolnum>8mandos</manvolnum></citerefentry>
317
298
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
318
299
      <manvolnum>8mandos</manvolnum></citerefentry>,