/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

  • Committer: Teddy Hogeborn
  • Date: 2018-08-19 16:15:46 UTC
  • Revision ID: teddy@recompile.se-20180819161546-v3ho1t3d8jbp1gny
Update Debian package standard-version to "4.2.0"

* debian/control (Standards-Version): Update to "4.2.0".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2018-02-08">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
40
40
      <year>2016</year>
41
41
      <year>2017</year>
42
42
      <year>2018</year>
43
 
      <year>2019</year>
44
43
      <holder>Teddy Hogeborn</holder>
45
44
      <holder>Björn Påhlsson</holder>
46
45
    </copyright>
61
60
  <refsynopsisdiv>
62
61
    <cmdsynopsis>
63
62
      <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
63
    </cmdsynopsis>
87
64
  </refsynopsisdiv>
88
65
  
124
101
  <refsect1 id="options">
125
102
    <title>OPTIONS</title>
126
103
    <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.
 
104
      This program takes no options.
134
105
    </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
106
  </refsect1>
190
107
  
191
108
  <refsect1 id="exit_status">
207
124
        <term><envar>crypttarget</envar></term>
208
125
        <listitem>
209
126
          <para>
210
 
            If set, and if the <option>--prompt</option> option is not
211
 
            used, these environment variables will be assumed to
 
127
            If set, these environment variables will be assumed to
212
128
            contain the source device name and the target device
213
129
            mapper name, respectively, and will be shown as part of
214
130
            the prompt.
216
132
        <para>
217
133
          These variables will normally be inherited from
218
134
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
219
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
220
 
          have in turn inherited them from its calling process.
 
135
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
 
136
          normally have inherited them from
 
137
          <filename>/scripts/local-top/cryptroot</filename> in the
 
138
          initial <acronym>RAM</acronym> disk environment, which will
 
139
          have set them from parsing kernel arguments and
 
140
          <filename>/conf/conf.d/cryptroot</filename> (also in the
 
141
          initial RAM disk environment), which in turn will have been
 
142
          created when the initial RAM disk image was created by
 
143
          <filename
 
144
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
 
145
          extracting the information of the root file system from
 
146
          <filename >/etc/crypttab</filename>.
221
147
        </para>
222
148
        <para>
223
149
          This behavior is meant to exactly mirror the behavior of
224
 
          <command>askpass</command>, the default password prompter
225
 
          from initramfs-tools.
 
150
          <command>askpass</command>, the default password prompter.
226
151
        </para>
227
152
        </listitem>
228
153
      </varlistentry>
295
220
    </para>
296
221
    <informalexample>
297
222
      <para>
298
 
        Normal invocation needs no options:
 
223
        This program takes no options.
299
224
      </para>
300
225
      <para>
301
226
        <userinput>&COMMANDNAME;</userinput>
302
227
      </para>
303
228
    </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
229
  </refsect1>
313
230
  
314
231
  <refsect1 id="security">
354
271
    <para>
355
272
      <citerefentry><refentrytitle>intro</refentrytitle>
356
273
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
274
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
275
      <manvolnum>5</manvolnum></citerefentry>,
357
276
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
358
277
      <manvolnum>8mandos</manvolnum></citerefentry>,
359
278
      <citerefentry><refentrytitle>proc</refentrytitle>