/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
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "password-prompt">
6
 
<!ENTITY TIMESTAMP "2008-09-06">
 
6
<!ENTITY TIMESTAMP "2008-08-30">
7
7
]>
8
8
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
10
10
  <refentryinfo>
11
11
    <title>Mandos Manual</title>
12
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
34
34
      <holder>Teddy Hogeborn</holder>
35
35
      <holder>Björn Påhlsson</holder>
36
36
    </copyright>
37
 
    <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>
38
60
  </refentryinfo>
39
61
  
40
62
  <refmeta>
51
73
    <cmdsynopsis>
52
74
      <command>&COMMANDNAME;</command>
53
75
      <group choice="opt">
54
 
        <arg choice="plain"><option>--prefix <replaceable
 
76
        <arg choice="plain"><option>-p <replaceable
55
77
        >PREFIX</replaceable></option></arg>
56
 
        <arg choice="plain"><option>-p </option><replaceable
 
78
        <arg choice="plain"><option>--prefix </option><replaceable
57
79
        >PREFIX</replaceable></arg>
58
80
      </group>
59
 
      <sbr/>
60
81
      <arg choice="opt"><option>--debug</option></arg>
61
82
    </cmdsynopsis>
62
83
    <cmdsynopsis>
63
84
      <command>&COMMANDNAME;</command>
64
85
      <group choice="req">
 
86
        <arg choice="plain"><option>-?</option></arg>
65
87
        <arg choice="plain"><option>--help</option></arg>
66
 
        <arg choice="plain"><option>-?</option></arg>
67
88
      </group>
68
89
    </cmdsynopsis>
69
90
    <cmdsynopsis>
73
94
    <cmdsynopsis>
74
95
      <command>&COMMANDNAME;</command>
75
96
      <group choice="req">
 
97
        <arg choice="plain"><option>-V</option></arg>
76
98
        <arg choice="plain"><option>--version</option></arg>
77
 
        <arg choice="plain"><option>-V</option></arg>
78
99
      </group>
79
100
    </cmdsynopsis>
80
101
  </refsynopsisdiv>
87
108
      is not very useful on its own.  This program is really meant to
88
109
      run as a plugin in the <application>Mandos</application>
89
110
      client-side system, where it is used as a fallback and
90
 
      alternative to retrieving passwords from a <application
 
111
      alternative to retriving passwords from a <application
91
112
      >Mandos</application> server.
92
113
    </para>
93
114
    <para>
112
133
    
113
134
    <variablelist>
114
135
      <varlistentry>
115
 
        <term><option>--prefix=<replaceable
116
 
        >PREFIX</replaceable></option></term>
117
 
        <term><option>-p
118
 
        <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>
119
140
        <listitem>
120
141
          <para>
121
142
            Prefix string shown before the password prompt.
135
156
      </varlistentry>
136
157
      
137
158
      <varlistentry>
 
159
        <term><option>-?</option></term>
138
160
        <term><option>--help</option></term>
139
 
        <term><option>-?</option></term>
140
161
        <listitem>
141
162
          <para>
142
163
            Gives a help message about options and their meanings.
154
175
      </varlistentry>
155
176
      
156
177
      <varlistentry>
 
178
        <term><option>-V</option></term>
157
179
        <term><option>--version</option></term>
158
 
        <term><option>-V</option></term>
159
180
        <listitem>
160
181
          <para>
161
182
            Prints the program version.
194
215
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
195
216
          normally have inherited them from
196
217
          <filename>/scripts/local-top/cryptroot</filename> in the
197
 
          initial <acronym>RAM</acronym> disk environment, which will
198
 
          have set them from parsing kernel arguments and
 
218
          initial RAM disk environment, which will have set them from
 
219
          parsing kernel arguments and
199
220
          <filename>/conf/conf.d/cryptroot</filename> (also in the
200
221
          initial RAM disk environment), which in turn will have been
201
222
          created when the initial RAM disk image was created by
240
261
      <para>
241
262
        Show a prefix before the prompt; in this case, a host name.
242
263
        It might be useful to be reminded of which host needs a
243
 
        password, in case of <acronym>KVM</acronym> switches, etc.
 
264
        password, in case of KVM switches, etc.
244
265
      </para>
245
266
      <para>
246
267
 
270
291
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
271
292
      </citerefentry>, and will, when run standalone, outside, in a
272
293
      normal environment, immediately output on its standard output
273
 
      any presumably secret password it just received.  Therefore,
 
294
      any presumably secret password it just recieved.  Therefore,
274
295
      when running this program standalone (which should never
275
296
      normally be done), take care not to type in any real secret
276
297
      password by force of habit, since it would then immediately be
290
311
    <para>
291
312
      <citerefentry><refentrytitle>crypttab</refentrytitle>
292
313
      <manvolnum>5</manvolnum></citerefentry>
293
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
314
      <citerefentry><refentrytitle>password-request</refentrytitle>
294
315
      <manvolnum>8mandos</manvolnum></citerefentry>
295
316
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
296
317
      <manvolnum>8mandos</manvolnum></citerefentry>,