/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-30 19:05:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830190515-l7e6vu81yyw5kcku
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags.  Unify
                         short and long options.

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