/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: Teddy Hogeborn
  • Date: 2008-08-29 16:53:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829165341-xzrp0xxxfrua5kzq
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
                         "--interface" options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2012-01-01">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-29">
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>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2011</year>
37
 
      <year>2012</year>
38
34
      <holder>Teddy Hogeborn</holder>
39
35
      <holder>Björn Påhlsson</holder>
40
36
    </copyright>
41
 
    <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>
42
60
  </refentryinfo>
43
61
  
44
62
  <refmeta>
55
73
    <cmdsynopsis>
56
74
      <command>&COMMANDNAME;</command>
57
75
      <group choice="opt">
58
 
        <arg choice="plain"><option>--prefix <replaceable
 
76
        <arg choice="plain"><option>-p <replaceable
59
77
        >PREFIX</replaceable></option></arg>
60
 
        <arg choice="plain"><option>-p </option><replaceable
 
78
        <arg choice="plain"><option>--prefix </option><replaceable
61
79
        >PREFIX</replaceable></arg>
62
80
      </group>
63
 
      <sbr/>
64
81
      <arg choice="opt"><option>--debug</option></arg>
65
82
    </cmdsynopsis>
66
83
    <cmdsynopsis>
67
84
      <command>&COMMANDNAME;</command>
68
85
      <group choice="req">
 
86
        <arg choice="plain"><option>-?</option></arg>
69
87
        <arg choice="plain"><option>--help</option></arg>
70
 
        <arg choice="plain"><option>-?</option></arg>
71
88
      </group>
72
89
    </cmdsynopsis>
73
90
    <cmdsynopsis>
77
94
    <cmdsynopsis>
78
95
      <command>&COMMANDNAME;</command>
79
96
      <group choice="req">
 
97
        <arg choice="plain"><option>-V</option></arg>
80
98
        <arg choice="plain"><option>--version</option></arg>
81
 
        <arg choice="plain"><option>-V</option></arg>
82
99
      </group>
83
 
    </cmdsynopsis>
 
100
    </cmdsynopsis>    
84
101
  </refsynopsisdiv>
85
102
  
86
103
  <refsect1 id="description">
87
104
    <title>DESCRIPTION</title>
88
105
    <para>
89
106
      All <command>&COMMANDNAME;</command> does is prompt for a
90
 
      password and output any given password to standard output.
91
 
    </para>
92
 
    <para>
93
 
      This program is not very useful on its own.  This program is
94
 
      really meant to run as a plugin in the <application
95
 
      >Mandos</application> client-side system, where it is used as a
96
 
      fallback and alternative to retrieving passwords from a
97
 
      <application >Mandos</application> server.
 
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.
98
113
    </para>
99
114
    <para>
100
115
      This program is little more than a <citerefentry><refentrytitle
118
133
    
119
134
    <variablelist>
120
135
      <varlistentry>
121
 
        <term><option>--prefix=<replaceable
122
 
        >PREFIX</replaceable></option></term>
123
 
        <term><option>-p
124
 
        <replaceable>PREFIX</replaceable></option></term>
 
136
        <term><option>-p</option> <replaceable>PREFIX</replaceable
 
137
        ></term>
 
138
        <term><option>--prefix=</option><replaceable
 
139
        >PREFIX</replaceable></term>
125
140
        <listitem>
126
141
          <para>
127
142
            Prefix string shown before the password prompt.
141
156
      </varlistentry>
142
157
      
143
158
      <varlistentry>
 
159
        <term><option>-?</option></term>
144
160
        <term><option>--help</option></term>
145
 
        <term><option>-?</option></term>
146
161
        <listitem>
147
162
          <para>
148
163
            Gives a help message about options and their meanings.
160
175
      </varlistentry>
161
176
      
162
177
      <varlistentry>
 
178
        <term><option>-V</option></term>
163
179
        <term><option>--version</option></term>
164
 
        <term><option>-V</option></term>
165
180
        <listitem>
166
181
          <para>
167
182
            Prints the program version.
168
183
          </para>
169
184
        </listitem>
170
 
      </varlistentry>
 
185
      </varlistentry>            
171
186
    </variablelist>
172
187
  </refsect1>
173
188
  
185
200
    <title>ENVIRONMENT</title>
186
201
    <variablelist>
187
202
      <varlistentry>
188
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
189
 
        <term><envar>CRYPTTAB_NAME</envar></term>
 
203
        <term><envar>cryptsource</envar></term>
 
204
        <term><envar>crypttarget</envar></term>
190
205
        <listitem>
191
206
          <para>
192
207
            If set, these environment variables will be assumed to
200
215
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
201
216
          normally have inherited them from
202
217
          <filename>/scripts/local-top/cryptroot</filename> in the
203
 
          initial <acronym>RAM</acronym> disk environment, which will
204
 
          have set them from parsing kernel arguments and
 
218
          initial RAM disk environment, which will have set them from
 
219
          parsing kernel arguments and
205
220
          <filename>/conf/conf.d/cryptroot</filename> (also in the
206
221
          initial RAM disk environment), which in turn will have been
207
222
          created when the initial RAM disk image was created by
224
239
    <para>
225
240
      None are known at this time.
226
241
    </para>
227
 
  </refsect1>
 
242
  </refsect1>  
228
243
  
229
244
  <refsect1 id="example">
230
245
    <title>EXAMPLE</title>
246
261
      <para>
247
262
        Show a prefix before the prompt; in this case, a host name.
248
263
        It might be useful to be reminded of which host needs a
249
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
264
        password, in case of KVM switches, etc.
250
265
      </para>
251
266
      <para>
252
267
 
276
291
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
277
292
      </citerefentry>, and will, when run standalone, outside, in a
278
293
      normal environment, immediately output on its standard output
279
 
      any presumably secret password it just received.  Therefore,
 
294
      any presumably secret password it just recieved.  Therefore,
280
295
      when running this program standalone (which should never
281
296
      normally be done), take care not to type in any real secret
282
297
      password by force of habit, since it would then immediately be
294
309
  <refsect1 id="see_also">
295
310
    <title>SEE ALSO</title>
296
311
    <para>
297
 
      <citerefentry><refentrytitle>intro</refentrytitle>
298
 
      <manvolnum>8mandos</manvolnum></citerefentry>
299
312
      <citerefentry><refentrytitle>crypttab</refentrytitle>
300
313
      <manvolnum>5</manvolnum></citerefentry>
301
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
314
      <citerefentry><refentrytitle>password-request</refentrytitle>
302
315
      <manvolnum>8mandos</manvolnum></citerefentry>
303
316
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
304
317
      <manvolnum>8mandos</manvolnum></citerefentry>,