/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-09-30 20:12:00 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930201200-3zkcd1op8pg2gw1s
Tags: version-1-0, version-1.0
* debian/changelog: Initial release closes ITP bug.

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-29">
 
5
<!ENTITY TIMESTAMP "2008-09-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>
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
 
    </cmdsynopsis>    
 
80
    </cmdsynopsis>
101
81
  </refsynopsisdiv>
102
82
  
103
83
  <refsect1 id="description">
108
88
      is not very useful on its own.  This program is really meant to
109
89
      run as a plugin in the <application>Mandos</application>
110
90
      client-side system, where it is used as a fallback and
111
 
      alternative to retriving passwords from a <application
 
91
      alternative to retrieving passwords from a <application
112
92
      >Mandos</application> server.
113
93
    </para>
114
94
    <para>
133
113
    
134
114
    <variablelist>
135
115
      <varlistentry>
136
 
        <term><option>-p</option> <replaceable>PREFIX</replaceable
137
 
        ></term>
138
 
        <term><option>--prefix=</option><replaceable
139
 
        >PREFIX</replaceable></term>
 
116
        <term><option>--prefix=<replaceable
 
117
        >PREFIX</replaceable></option></term>
 
118
        <term><option>-p
 
119
        <replaceable>PREFIX</replaceable></option></term>
140
120
        <listitem>
141
121
          <para>
142
122
            Prefix string shown before the password prompt.
156
136
      </varlistentry>
157
137
      
158
138
      <varlistentry>
 
139
        <term><option>--help</option></term>
159
140
        <term><option>-?</option></term>
160
 
        <term><option>--help</option></term>
161
141
        <listitem>
162
142
          <para>
163
143
            Gives a help message about options and their meanings.
175
155
      </varlistentry>
176
156
      
177
157
      <varlistentry>
 
158
        <term><option>--version</option></term>
178
159
        <term><option>-V</option></term>
179
 
        <term><option>--version</option></term>
180
160
        <listitem>
181
161
          <para>
182
162
            Prints the program version.
183
163
          </para>
184
164
        </listitem>
185
 
      </varlistentry>            
 
165
      </varlistentry>
186
166
    </variablelist>
187
167
  </refsect1>
188
168
  
215
195
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
216
196
          normally have inherited them from
217
197
          <filename>/scripts/local-top/cryptroot</filename> in the
218
 
          initial RAM disk environment, which will have set them from
219
 
          parsing kernel arguments and
 
198
          initial <acronym>RAM</acronym> disk environment, which will
 
199
          have set them from parsing kernel arguments and
220
200
          <filename>/conf/conf.d/cryptroot</filename> (also in the
221
201
          initial RAM disk environment), which in turn will have been
222
202
          created when the initial RAM disk image was created by
239
219
    <para>
240
220
      None are known at this time.
241
221
    </para>
242
 
  </refsect1>  
 
222
  </refsect1>
243
223
  
244
224
  <refsect1 id="example">
245
225
    <title>EXAMPLE</title>
261
241
      <para>
262
242
        Show a prefix before the prompt; in this case, a host name.
263
243
        It might be useful to be reminded of which host needs a
264
 
        password, in case of KVM switches, etc.
 
244
        password, in case of <acronym>KVM</acronym> switches, etc.
265
245
      </para>
266
246
      <para>
267
247
 
291
271
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
292
272
      </citerefentry>, and will, when run standalone, outside, in a
293
273
      normal environment, immediately output on its standard output
294
 
      any presumably secret password it just recieved.  Therefore,
 
274
      any presumably secret password it just received.  Therefore,
295
275
      when running this program standalone (which should never
296
276
      normally be done), take care not to type in any real secret
297
277
      password by force of habit, since it would then immediately be
311
291
    <para>
312
292
      <citerefentry><refentrytitle>crypttab</refentrytitle>
313
293
      <manvolnum>5</manvolnum></citerefentry>
314
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
294
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
315
295
      <manvolnum>8mandos</manvolnum></citerefentry>
316
296
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
317
297
      <manvolnum>8mandos</manvolnum></citerefentry>,