/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/plymouth.xml

  • Committer: Teddy Hogeborn
  • Date: 2024-09-16 21:01:52 UTC
  • mto: This revision was merged to the branch mainline in revision 412.
  • Revision ID: teddy@recompile.se-20240916210152-0xbv4b15jyho9ydk
Override lintian experimental tag "executable-in-usr-lib"

Lintian reports executable files in /usr/lib, since binaries which are
executed internally are supposed to be stored in /usr/libexec.  But
the executables we store in /usr/lib are all files to be copied into
the initial RAM disk image, and are never executed from their storage
location in /usr/lib.  Except one; the Dracut module-setup.sh file.
But that file seems to be required to be executable; the
module-setup.sh file of every other Dracut module is also an
executable file.

* debian/mandos-client.lintian-overrides: Override experimental tag
  "executable-in-usr-lib" about files which are not actually executed
  from this location, and only exist to be copied to the initial RAM
  disk image.  Also the Dracut module-setup.sh file, which merely
  follows the pattern of all other Dracut module-setup.sh files from
  other Dracut modules.

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 "2012-01-01">
 
5
<!ENTITY TIMESTAMP "2019-07-27">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
34
34
      <year>2010</year>
35
35
      <year>2011</year>
36
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>
37
44
      <holder>Teddy Hogeborn</holder>
38
45
      <holder>Björn Påhlsson</holder>
39
46
    </copyright>
54
61
  <refsynopsisdiv>
55
62
    <cmdsynopsis>
56
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>
57
86
    </cmdsynopsis>
58
87
  </refsynopsisdiv>
59
88
  
95
124
  <refsect1 id="options">
96
125
    <title>OPTIONS</title>
97
126
    <para>
98
 
      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.
99
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>
100
189
  </refsect1>
101
190
  
102
191
  <refsect1 id="exit_status">
118
207
        <term><envar>crypttarget</envar></term>
119
208
        <listitem>
120
209
          <para>
121
 
            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
122
212
            contain the source device name and the target device
123
213
            mapper name, respectively, and will be shown as part of
124
214
            the prompt.
126
216
        <para>
127
217
          These variables will normally be inherited from
128
218
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
129
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
130
 
          normally have inherited them from
131
 
          <filename>/scripts/local-top/cryptroot</filename> in the
132
 
          initial <acronym>RAM</acronym> disk environment, which will
133
 
          have set them from parsing kernel arguments and
134
 
          <filename>/conf/conf.d/cryptroot</filename> (also in the
135
 
          initial RAM disk environment), which in turn will have been
136
 
          created when the initial RAM disk image was created by
137
 
          <filename
138
 
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
139
 
          extracting the information of the root file system from
140
 
          <filename >/etc/crypttab</filename>.
 
219
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
 
220
          have in turn inherited them from its calling process.
141
221
        </para>
142
222
        <para>
143
223
          This behavior is meant to exactly mirror the behavior of
144
 
          <command>askpass</command>, the default password prompter.
 
224
          <command>askpass</command>, the default password prompter
 
225
          from initramfs-tools.
145
226
        </para>
146
227
        </listitem>
147
228
      </varlistentry>
201
282
      daemon and starting a new one is ugly, but necessary as long as
202
283
      it does not support aborting a password request.
203
284
    </para>
 
285
    <xi:include href="../bugs.xml"/>
204
286
  </refsect1>
205
287
  
206
288
  <refsect1 id="example">
213
295
    </para>
214
296
    <informalexample>
215
297
      <para>
216
 
        This program takes no options.
 
298
        Normal invocation needs no options:
217
299
      </para>
218
300
      <para>
219
301
        <userinput>&COMMANDNAME;</userinput>
220
302
      </para>
221
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>
222
312
  </refsect1>
223
313
  
224
314
  <refsect1 id="security">
264
354
    <para>
265
355
      <citerefentry><refentrytitle>intro</refentrytitle>
266
356
      <manvolnum>8mandos</manvolnum></citerefentry>,
267
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
268
 
      <manvolnum>5</manvolnum></citerefentry>,
269
357
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
270
358
      <manvolnum>8mandos</manvolnum></citerefentry>,
271
359
      <citerefentry><refentrytitle>proc</refentrytitle>