/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: 2021-02-03 00:12:25 UTC
  • Revision ID: teddy@recompile.se-20210203001225-n8x1w4wwnf3qy5pv
Fix #include headers

Update all #include's and comments to reflect order of use in source
code.

* dracut-module/password-agent.c: Update #include headers.
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

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 "2018-02-08">
 
5
<!ENTITY TIMESTAMP "2019-07-27">
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>
43
44
      <holder>Teddy Hogeborn</holder>
44
45
      <holder>Björn Påhlsson</holder>
45
46
    </copyright>
60
61
  <refsynopsisdiv>
61
62
    <cmdsynopsis>
62
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>
63
86
    </cmdsynopsis>
64
87
  </refsynopsisdiv>
65
88
  
101
124
  <refsect1 id="options">
102
125
    <title>OPTIONS</title>
103
126
    <para>
104
 
      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.
105
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>
106
189
  </refsect1>
107
190
  
108
191
  <refsect1 id="exit_status">
124
207
        <term><envar>crypttarget</envar></term>
125
208
        <listitem>
126
209
          <para>
127
 
            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
128
212
            contain the source device name and the target device
129
213
            mapper name, respectively, and will be shown as part of
130
214
            the prompt.
132
216
        <para>
133
217
          These variables will normally be inherited from
134
218
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
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>.
 
219
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
 
220
          have in turn inherited them from its calling process.
147
221
        </para>
148
222
        <para>
149
223
          This behavior is meant to exactly mirror the behavior of
150
 
          <command>askpass</command>, the default password prompter.
 
224
          <command>askpass</command>, the default password prompter
 
225
          from initramfs-tools.
151
226
        </para>
152
227
        </listitem>
153
228
      </varlistentry>
220
295
    </para>
221
296
    <informalexample>
222
297
      <para>
223
 
        This program takes no options.
 
298
        Normal invocation needs no options:
224
299
      </para>
225
300
      <para>
226
301
        <userinput>&COMMANDNAME;</userinput>
227
302
      </para>
228
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>
229
312
  </refsect1>
230
313
  
231
314
  <refsect1 id="security">
271
354
    <para>
272
355
      <citerefentry><refentrytitle>intro</refentrytitle>
273
356
      <manvolnum>8mandos</manvolnum></citerefentry>,
274
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
275
 
      <manvolnum>5</manvolnum></citerefentry>,
276
357
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
277
358
      <manvolnum>8mandos</manvolnum></citerefentry>,
278
359
      <citerefentry><refentrytitle>proc</refentrytitle>