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 "2019-07-27">
5
<!ENTITY TIMESTAMP "2019-02-10">
6
6
<!ENTITY % common SYSTEM "../common.ent">
63
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>
124
102
<refsect1 id="options">
125
103
<title>OPTIONS</title>
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
105
This program takes no options.
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.
191
109
<refsect1 id="exit_status">
207
125
<term><envar>crypttarget</envar></term>
210
If set, and if the <option>--prompt</option> option is not
211
used, these environment variables will be assumed to
128
If set, these environment variables will be assumed to
212
129
contain the source device name and the target device
213
130
mapper name, respectively, and will be shown as part of
217
134
These variables will normally be inherited from
218
135
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
219
<manvolnum>8mandos</manvolnum></citerefentry>, which might
220
have in turn inherited them from its calling process.
136
<manvolnum>8mandos</manvolnum></citerefentry>, which will
137
normally have inherited them from
138
<filename>/scripts/local-top/cryptroot</filename> in the
139
initial <acronym>RAM</acronym> disk environment, which will
140
have set them from parsing kernel arguments and
141
<filename>/conf/conf.d/cryptroot</filename> (also in the
142
initial RAM disk environment), which in turn will have been
143
created when the initial RAM disk image was created by
145
>/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
146
extracting the information of the root file system from
147
<filename >/etc/crypttab</filename>.
223
150
This behavior is meant to exactly mirror the behavior of
224
<command>askpass</command>, the default password prompter
225
from initramfs-tools.
151
<command>askpass</command>, the default password prompter.
355
273
<citerefentry><refentrytitle>intro</refentrytitle>
356
274
<manvolnum>8mandos</manvolnum></citerefentry>,
275
<citerefentry><refentrytitle>crypttab</refentrytitle>
276
<manvolnum>5</manvolnum></citerefentry>,
357
277
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
358
278
<manvolnum>8mandos</manvolnum></citerefentry>,
359
279
<citerefentry><refentrytitle>proc</refentrytitle>
added
removed
plugins.d/plymouth.xml
