/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/plymouth.xml

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/plymouth.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 "plymouth">
5
 
<!ENTITY TIMESTAMP "2019-07-27">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
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>2010</year>
35
 
      <year>2011</year>
36
 
      <year>2012</year>
37
 
      <year>2013</year>
38
 
      <year>2014</year>
39
 
      <year>2015</year>
40
 
      <year>2016</year>
41
 
      <year>2017</year>
42
 
      <year>2018</year>
43
 
      <year>2019</year>
44
35
      <holder>Teddy Hogeborn</holder>
45
36
      <holder>Björn Påhlsson</holder>
46
37
    </copyright>
61
52
  <refsynopsisdiv>
62
53
    <cmdsynopsis>
63
54
      <command>&COMMANDNAME;</command>
64
 
      <arg choice="opt">
65
 
        <option>--prompt <replaceable>PROMPT</replaceable></option>
66
 
      </arg>
67
 
      <arg><option>--debug</option></arg>
68
 
    </cmdsynopsis>
69
 
    <cmdsynopsis>
70
 
      <command>&COMMANDNAME;</command>
71
 
      <group choice="req">
72
 
        <arg choice="plain"><option>--help</option></arg>
73
 
        <arg choice="plain"><option>-?</option></arg>
74
 
      </group>
75
 
    </cmdsynopsis>
76
 
    <cmdsynopsis>
77
 
      <command>&COMMANDNAME;</command>
78
 
      <arg choice="plain"><option>--usage</option></arg>
79
 
    </cmdsynopsis>
80
 
    <cmdsynopsis>
81
 
      <command>&COMMANDNAME;</command>
82
 
      <group choice="req">
83
 
        <arg choice="plain"><option>--version</option></arg>
84
 
        <arg choice="plain"><option>-V</option></arg>
85
 
      </group>
86
55
    </cmdsynopsis>
87
56
  </refsynopsisdiv>
88
57
  
124
93
  <refsect1 id="options">
125
94
    <title>OPTIONS</title>
126
95
    <para>
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
133
 
      directly.
 
96
      This program takes no options.
134
97
    </para>
135
 
    
136
 
    <variablelist>
137
 
      <varlistentry>
138
 
        <term><option>--prompt=<replaceable
139
 
        >PROMPT</replaceable></option></term>
140
 
        <listitem>
141
 
          <para>
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.
145
 
          </para>
146
 
        </listitem>
147
 
      </varlistentry>
148
 
      
149
 
      <varlistentry>
150
 
        <term><option>--debug</option></term>
151
 
        <listitem>
152
 
          <para>
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.
156
 
          </para>
157
 
        </listitem>
158
 
      </varlistentry>
159
 
      
160
 
      <varlistentry>
161
 
        <term><option>--help</option></term>
162
 
        <term><option>-?</option></term>
163
 
        <listitem>
164
 
          <para>
165
 
            Gives a help message about options and their meanings.
166
 
          </para>
167
 
        </listitem>
168
 
      </varlistentry>
169
 
      
170
 
      <varlistentry>
171
 
        <term><option>--usage</option></term>
172
 
        <listitem>
173
 
          <para>
174
 
            Gives a short usage message.
175
 
          </para>
176
 
        </listitem>
177
 
      </varlistentry>
178
 
      
179
 
      <varlistentry>
180
 
        <term><option>--version</option></term>
181
 
        <term><option>-V</option></term>
182
 
        <listitem>
183
 
          <para>
184
 
            Prints the program version.
185
 
          </para>
186
 
        </listitem>
187
 
      </varlistentry>
188
 
    </variablelist>
189
98
  </refsect1>
190
99
  
191
100
  <refsect1 id="exit_status">
207
116
        <term><envar>crypttarget</envar></term>
208
117
        <listitem>
209
118
          <para>
210
 
            If set, and if the <option>--prompt</option> option is not
211
 
            used, these environment variables will be assumed to
 
119
            If set, these environment variables will be assumed to
212
120
            contain the source device name and the target device
213
121
            mapper name, respectively, and will be shown as part of
214
122
            the prompt.
216
124
        <para>
217
125
          These variables will normally be inherited from
218
126
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
219
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
220
 
          have in turn inherited them from its calling process.
 
127
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
 
128
          normally have inherited them from
 
129
          <filename>/scripts/local-top/cryptroot</filename> in the
 
130
          initial <acronym>RAM</acronym> disk environment, which will
 
131
          have set them from parsing kernel arguments and
 
132
          <filename>/conf/conf.d/cryptroot</filename> (also in the
 
133
          initial RAM disk environment), which in turn will have been
 
134
          created when the initial RAM disk image was created by
 
135
          <filename
 
136
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
 
137
          extracting the information of the root file system from
 
138
          <filename >/etc/crypttab</filename>.
221
139
        </para>
222
140
        <para>
223
141
          This behavior is meant to exactly mirror the behavior of
224
 
          <command>askpass</command>, the default password prompter
225
 
          from initramfs-tools.
 
142
          <command>askpass</command>, the default password prompter.
226
143
        </para>
227
144
        </listitem>
228
145
      </varlistentry>
243
160
        </listitem>
244
161
      </varlistentry>
245
162
      <varlistentry>
246
 
        <term><filename class="directory">/proc</filename></term>
 
163
        <term><filename>/proc</filename></term>
247
164
        <listitem>
248
165
          <para>
249
166
            To find the running <citerefentry><refentrytitle
282
199
      daemon and starting a new one is ugly, but necessary as long as
283
200
      it does not support aborting a password request.
284
201
    </para>
285
 
    <xi:include href="../bugs.xml"/>
286
202
  </refsect1>
287
203
  
288
204
  <refsect1 id="example">
295
211
    </para>
296
212
    <informalexample>
297
213
      <para>
298
 
        Normal invocation needs no options:
 
214
        This program takes no options.
299
215
      </para>
300
216
      <para>
301
217
        <userinput>&COMMANDNAME;</userinput>
302
218
      </para>
303
219
    </informalexample>
304
 
    <informalexample>
305
 
      <para>
306
 
        Show a different prompt.
307
 
      </para>
308
 
      <para>
309
 
        <userinput>&COMMANDNAME; --prompt=Password</userinput>
310
 
      </para>
311
 
    </informalexample>
312
220
  </refsect1>
313
221
  
314
222
  <refsect1 id="security">
352
260
  <refsect1 id="see_also">
353
261
    <title>SEE ALSO</title>
354
262
    <para>
355
 
      <citerefentry><refentrytitle>intro</refentrytitle>
356
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
263
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
264
      <manvolnum>5</manvolnum></citerefentry>,
357
265
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
358
266
      <manvolnum>8mandos</manvolnum></citerefentry>,
359
267
      <citerefentry><refentrytitle>proc</refentrytitle>