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 "plymouth">
5
<!ENTITY TIMESTAMP "2015-07-20">
5
<!ENTITY TIMESTAMP "2019-07-27">
6
6
<!ENTITY % common SYSTEM "../common.ent">
59
63
<command>&COMMANDNAME;</command>
65
<option>--prompt <replaceable>PROMPT</replaceable></option>
67
<arg><option>--debug</option></arg>
70
<command>&COMMANDNAME;</command>
72
<arg choice="plain"><option>--help</option></arg>
73
<arg choice="plain"><option>-?</option></arg>
77
<command>&COMMANDNAME;</command>
78
<arg choice="plain"><option>--usage</option></arg>
81
<command>&COMMANDNAME;</command>
83
<arg choice="plain"><option>--version</option></arg>
84
<arg choice="plain"><option>-V</option></arg>
98
124
<refsect1 id="options">
99
125
<title>OPTIONS</title>
101
This program takes no options.
127
This program is commonly not invoked from the command line; it
128
is normally started by the <application>Mandos</application>
129
plugin runner, see <citerefentry><refentrytitle
130
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
131
</citerefentry>. Any command line options this program accepts
132
are therefore normally provided by the plugin runner, and not
138
<term><option>--prompt=<replaceable
139
>PROMPT</replaceable></option></term>
142
The password prompt. Note that using this option will
143
make this program ignore the <envar>cryptsource</envar>
144
and <envar>crypttarget</envar> environment variables.
150
<term><option>--debug</option></term>
153
Enable debug mode. This will enable a lot of output to
154
standard error about what the program is doing. The
155
program will still perform all other functions normally.
161
<term><option>--help</option></term>
162
<term><option>-?</option></term>
165
Gives a help message about options and their meanings.
171
<term><option>--usage</option></term>
174
Gives a short usage message.
180
<term><option>--version</option></term>
181
<term><option>-V</option></term>
184
Prints the program version.
105
191
<refsect1 id="exit_status">
121
207
<term><envar>crypttarget</envar></term>
124
If set, these environment variables will be assumed to
210
If set, and if the <option>--prompt</option> option is not
211
used, these environment variables will be assumed to
125
212
contain the source device name and the target device
126
213
mapper name, respectively, and will be shown as part of
130
217
These variables will normally be inherited from
131
218
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
132
<manvolnum>8mandos</manvolnum></citerefentry>, which will
133
normally have inherited them from
134
<filename>/scripts/local-top/cryptroot</filename> in the
135
initial <acronym>RAM</acronym> disk environment, which will
136
have set them from parsing kernel arguments and
137
<filename>/conf/conf.d/cryptroot</filename> (also in the
138
initial RAM disk environment), which in turn will have been
139
created when the initial RAM disk image was created by
141
>/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
142
extracting the information of the root file system from
143
<filename >/etc/crypttab</filename>.
219
<manvolnum>8mandos</manvolnum></citerefentry>, which might
220
have in turn inherited them from its calling process.
146
223
This behavior is meant to exactly mirror the behavior of
147
<command>askpass</command>, the default password prompter.
224
<command>askpass</command>, the default password prompter
225
from initramfs-tools.
268
355
<citerefentry><refentrytitle>intro</refentrytitle>
269
356
<manvolnum>8mandos</manvolnum></citerefentry>,
270
<citerefentry><refentrytitle>crypttab</refentrytitle>
271
<manvolnum>5</manvolnum></citerefentry>,
272
357
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
273
358
<manvolnum>8mandos</manvolnum></citerefentry>,
274
359
<citerefentry><refentrytitle>proc</refentrytitle>
added
removed
plugins.d/plymouth.xml
