/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:49:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830194924-f4liqq8wxajlbshn
* plugin-runner.xml (NAME): Improved wording.
  (SYNOPSIS): Use <option> and <replaceable> tags.  Unify short and
              long options.  Add "--global-envs" and "--envs-for"
              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-09-30">
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>
88
108
      is not very useful on its own.  This program is really meant to
89
109
      run as a plugin in the <application>Mandos</application>
90
110
      client-side system, where it is used as a fallback and
91
 
      alternative to retrieving passwords from a <application
 
111
      alternative to retriving passwords from a <application
92
112
      >Mandos</application> server.
93
113
    </para>
94
114
    <para>
113
133
    
114
134
    <variablelist>
115
135
      <varlistentry>
116
 
        <term><option>--prefix=<replaceable
117
 
        >PREFIX</replaceable></option></term>
118
 
        <term><option>-p
119
 
        <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>
120
140
        <listitem>
121
141
          <para>
122
142
            Prefix string shown before the password prompt.
136
156
      </varlistentry>
137
157
      
138
158
      <varlistentry>
 
159
        <term><option>-?</option></term>
139
160
        <term><option>--help</option></term>
140
 
        <term><option>-?</option></term>
141
161
        <listitem>
142
162
          <para>
143
163
            Gives a help message about options and their meanings.
155
175
      </varlistentry>
156
176
      
157
177
      <varlistentry>
 
178
        <term><option>-V</option></term>
158
179
        <term><option>--version</option></term>
159
 
        <term><option>-V</option></term>
160
180
        <listitem>
161
181
          <para>
162
182
            Prints the program version.
195
215
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
196
216
          normally have inherited them from
197
217
          <filename>/scripts/local-top/cryptroot</filename> in the
198
 
          initial <acronym>RAM</acronym> disk environment, which will
199
 
          have set them from parsing kernel arguments and
 
218
          initial RAM disk environment, which will have set them from
 
219
          parsing kernel arguments and
200
220
          <filename>/conf/conf.d/cryptroot</filename> (also in the
201
221
          initial RAM disk environment), which in turn will have been
202
222
          created when the initial RAM disk image was created by
241
261
      <para>
242
262
        Show a prefix before the prompt; in this case, a host name.
243
263
        It might be useful to be reminded of which host needs a
244
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
264
        password, in case of KVM switches, etc.
245
265
      </para>
246
266
      <para>
247
267
 
271
291
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
272
292
      </citerefentry>, and will, when run standalone, outside, in a
273
293
      normal environment, immediately output on its standard output
274
 
      any presumably secret password it just received.  Therefore,
 
294
      any presumably secret password it just recieved.  Therefore,
275
295
      when running this program standalone (which should never
276
296
      normally be done), take care not to type in any real secret
277
297
      password by force of habit, since it would then immediately be
291
311
    <para>
292
312
      <citerefentry><refentrytitle>crypttab</refentrytitle>
293
313
      <manvolnum>5</manvolnum></citerefentry>
294
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
314
      <citerefentry><refentrytitle>password-request</refentrytitle>
295
315
      <manvolnum>8mandos</manvolnum></citerefentry>
296
316
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
297
317
      <manvolnum>8mandos</manvolnum></citerefentry>,