/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: 2019-08-05 14:31:51 UTC
  • Revision ID: teddy@recompile.se-20190805143151-lt5d97wqif3t8250
Client: Debian package fix: Make uninstall when using dracut(8) work

Use the same logic to rebuild the initramfs image when uninstalling as
when installing the package.

* debian/mandos-client.postrm (update_initramfs): Use the same logic
  as the update_initramfs function in debian/mandos-client.postinst.

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 "2015-07-20">
 
5
<!ENTITY TIMESTAMP "2019-07-27">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
37
37
      <year>2013</year>
38
38
      <year>2014</year>
39
39
      <year>2015</year>
 
40
      <year>2016</year>
 
41
      <year>2017</year>
 
42
      <year>2018</year>
 
43
      <year>2019</year>
40
44
      <holder>Teddy Hogeborn</holder>
41
45
      <holder>Björn Påhlsson</holder>
42
46
    </copyright>
57
61
  <refsynopsisdiv>
58
62
    <cmdsynopsis>
59
63
      <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>
60
86
    </cmdsynopsis>
61
87
  </refsynopsisdiv>
62
88
  
98
124
  <refsect1 id="options">
99
125
    <title>OPTIONS</title>
100
126
    <para>
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
 
133
      directly.
102
134
    </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>
103
189
  </refsect1>
104
190
  
105
191
  <refsect1 id="exit_status">
121
207
        <term><envar>crypttarget</envar></term>
122
208
        <listitem>
123
209
          <para>
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
127
214
            the prompt.
129
216
        <para>
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
140
 
          <filename
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.
144
221
        </para>
145
222
        <para>
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.
148
226
        </para>
149
227
        </listitem>
150
228
      </varlistentry>
204
282
      daemon and starting a new one is ugly, but necessary as long as
205
283
      it does not support aborting a password request.
206
284
    </para>
 
285
    <xi:include href="../bugs.xml"/>
207
286
  </refsect1>
208
287
  
209
288
  <refsect1 id="example">
216
295
    </para>
217
296
    <informalexample>
218
297
      <para>
219
 
        This program takes no options.
 
298
        Normal invocation needs no options:
220
299
      </para>
221
300
      <para>
222
301
        <userinput>&COMMANDNAME;</userinput>
223
302
      </para>
224
303
    </informalexample>
 
304
    <informalexample>
 
305
      <para>
 
306
        Show a different prompt.
 
307
      </para>
 
308
      <para>
 
309
        <userinput>&COMMANDNAME; --prompt=Password</userinput>
 
310
      </para>
 
311
    </informalexample>
225
312
  </refsect1>
226
313
  
227
314
  <refsect1 id="security">
267
354
    <para>
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>