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