/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-09-26 05:04:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080926050415-20l2y561cgyaq97i
* .bzrignore: Added "plugins/splashy", "plugins/usplash", and a couple
              of intermediate files in "debian/po".

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