/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-10-04 01:55:56 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081004015556-hp0374bc62khen0z
* mandos-keygen.xml (FILES): Fixed id to be "files", not "file".
* mandos.xml (FILES): - '' -
  (CLIENTS, SERVER): Changed id attribute to lower case.  All
                     referrers changed.
* plugins.d/mandos-client.xml (FILES): Fixed id to be "files", not
                                       "file".

* plugins.d/password-prompt.xml (DESCRIPTION): Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.xml
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
4
<!ENTITY COMMANDNAME "password-prompt">
5
 
<!ENTITY TIMESTAMP "2019-07-27">
 
5
<!ENTITY TIMESTAMP "2008-10-04">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
35
      <holder>Teddy Hogeborn</holder>
47
36
      <holder>Björn Påhlsson</holder>
48
37
    </copyright>
69
58
        >PREFIX</replaceable></arg>
70
59
      </group>
71
60
      <sbr/>
72
 
      <arg choice="opt">
73
 
        <option>--prompt <replaceable>PROMPT</replaceable></option>
74
 
      </arg>
75
61
      <arg choice="opt"><option>--debug</option></arg>
76
62
    </cmdsynopsis>
77
63
    <cmdsynopsis>
113
99
      wrapper, although actual use of that function is not guaranteed
114
100
      or implied.
115
101
    </para>
116
 
    <para>
117
 
      This program tries to detect if a Plymouth daemon
118
 
      (<citerefentry><refentrytitle
119
 
      >plymouthd</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
120
 
      is running, by looking for a
121
 
      <filename>/run/plymouth/pid</filename> file or a process named
122
 
      <quote><literal>plymouthd</literal></quote>.  If it is detected,
123
 
      this process will immediately exit without doing anything.
124
 
    </para>
125
102
  </refsect1>
126
103
  
127
104
  <refsect1 id="options">
150
127
      </varlistentry>
151
128
      
152
129
      <varlistentry>
153
 
        <term><option>--prompt=<replaceable
154
 
        >PROMPT</replaceable></option></term>
155
 
        <listitem>
156
 
          <para>
157
 
            The password prompt.  Using this option will make this
158
 
            program ignore the <envar>CRYPTTAB_SOURCE</envar> and
159
 
            <envar>CRYPTTAB_NAME</envar> environment variables.
160
 
          </para>
161
 
        </listitem>
162
 
      </varlistentry>
163
 
      
164
 
      <varlistentry>
165
130
        <term><option>--debug</option></term>
166
131
        <listitem>
167
132
          <para>
217
182
    <title>ENVIRONMENT</title>
218
183
    <variablelist>
219
184
      <varlistentry>
220
 
        <term><envar>CRYPTTAB_SOURCE</envar></term>
221
 
        <term><envar>CRYPTTAB_NAME</envar></term>
 
185
        <term><envar>cryptsource</envar></term>
 
186
        <term><envar>crypttarget</envar></term>
222
187
        <listitem>
223
188
          <para>
224
 
            If set, and if the <option>--prompt</option> option is not
225
 
            used, these environment variables will be assumed to
 
189
            If set, these environment variables will be assumed to
226
190
            contain the source device name and the target device
227
191
            mapper name, respectively, and will be shown as part of
228
192
            the prompt.
230
194
        <para>
231
195
          These variables will normally be inherited from
232
196
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
233
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
234
 
          have in turn inherited them from its calling process.
 
197
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
 
198
          normally have inherited them from
 
199
          <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
 
202
          <filename>/conf/conf.d/cryptroot</filename> (also in the
 
203
          initial RAM disk environment), which in turn will have been
 
204
          created when the initial RAM disk image was created by
 
205
          <filename
 
206
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
 
207
          extracting the information of the root file system from
 
208
          <filename >/etc/crypttab</filename>.
235
209
        </para>
236
210
        <para>
237
211
          This behavior is meant to exactly mirror the behavior of
238
 
          <command>askpass</command>, the default password prompter
239
 
          from initramfs-tools.
 
212
          <command>askpass</command>, the default password prompter.
240
213
        </para>
241
214
        </listitem>
242
215
      </varlistentry>
245
218
  
246
219
  <refsect1 id="bugs">
247
220
    <title>BUGS</title>
248
 
    <xi:include href="../bugs.xml"/>
 
221
    <para>
 
222
      None are known at this time.
 
223
    </para>
249
224
  </refsect1>
250
225
  
251
226
  <refsect1 id="example">
316
291
  <refsect1 id="see_also">
317
292
    <title>SEE ALSO</title>
318
293
    <para>
319
 
      <citerefentry><refentrytitle>intro</refentrytitle>
320
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
294
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
295
      <manvolnum>5</manvolnum></citerefentry>
321
296
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
322
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
297
      <manvolnum>8mandos</manvolnum></citerefentry>
323
298
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
324
299
      <manvolnum>8mandos</manvolnum></citerefentry>,
325
 
      <citerefentry><refentrytitle>plymouthd</refentrytitle>
326
 
      <manvolnum>8</manvolnum></citerefentry>
327
300
    </para>
328
301
  </refsect1>
329
302
</refentry>