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