/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: 2024-09-08 00:08:15 UTC
  • Revision ID: teddy@recompile.se-20240908000815-x3gr5xion3kyyoio
Improve documentation

* mandos.conf.xml (DESCRIPTION): Remove the unnecessary word "simple".
* plugin-runner.xml (PLUGINS): Remove the unnecessary word "simply",
  and add the "executable" qualifier to the description of plugins.
* mandos-client.xml (DESCRIPTION, OPTIONS): Do not refer to
  "plugin-runner"; instead refer to the section "OVERVIEW".
  (OVERVIEW): Don't only describe plugin-runner; also describe
  how password-agent can start mandos-client.
  (EXAMPLE): Do not refer to "plugin-runner"; instead refer to the
  section "OVERVIEW".
  (SEE ALSO): Replace reference to "password-prompt" with
  "password-agent".

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