/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/password-prompt.xml

  • Committer: teddy at recompile
  • Date: 2020-07-04 13:39:36 UTC
  • mfrom: (237.4.132 release)
  • Revision ID: teddy@recompile.se-20200704133936-lfk4sy1d48m53iqu
Merge from release branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-prompt.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 "password-prompt">
5
 
<!ENTITY TIMESTAMP "2012-01-01">
 
5
<!ENTITY TIMESTAMP "2019-07-27">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2010</year>
36
37
      <year>2011</year>
37
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
38
46
      <holder>Teddy Hogeborn</holder>
39
47
      <holder>Björn Påhlsson</holder>
40
48
    </copyright>
61
69
        >PREFIX</replaceable></arg>
62
70
      </group>
63
71
      <sbr/>
 
72
      <arg choice="opt">
 
73
        <option>--prompt <replaceable>PROMPT</replaceable></option>
 
74
      </arg>
64
75
      <arg choice="opt"><option>--debug</option></arg>
65
76
    </cmdsynopsis>
66
77
    <cmdsynopsis>
102
113
      wrapper, although actual use of that function is not guaranteed
103
114
      or implied.
104
115
    </para>
 
116
    <para>
 
117
      This program tries to detect if a Plymouth daemon
 
118
      (<citerefentry><refentrytitle
 
119
      >plymouthd</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
 
120
      is running, by looking for a
 
121
      <filename>/run/plymouth/pid</filename> file or a process named
 
122
      <quote><literal>plymouthd</literal></quote>.  If it is detected,
 
123
      this process will immediately exit without doing anything.
 
124
    </para>
105
125
  </refsect1>
106
126
  
107
127
  <refsect1 id="options">
130
150
      </varlistentry>
131
151
      
132
152
      <varlistentry>
 
153
        <term><option>--prompt=<replaceable
 
154
        >PROMPT</replaceable></option></term>
 
155
        <listitem>
 
156
          <para>
 
157
            The password prompt.  Using this option will make this
 
158
            program ignore the <envar>CRYPTTAB_SOURCE</envar> and
 
159
            <envar>CRYPTTAB_NAME</envar> environment variables.
 
160
          </para>
 
161
        </listitem>
 
162
      </varlistentry>
 
163
      
 
164
      <varlistentry>
133
165
        <term><option>--debug</option></term>
134
166
        <listitem>
135
167
          <para>
189
221
        <term><envar>CRYPTTAB_NAME</envar></term>
190
222
        <listitem>
191
223
          <para>
192
 
            If set, these environment variables will be assumed to
 
224
            If set, and if the <option>--prompt</option> option is not
 
225
            used, these environment variables will be assumed to
193
226
            contain the source device name and the target device
194
227
            mapper name, respectively, and will be shown as part of
195
228
            the prompt.
197
230
        <para>
198
231
          These variables will normally be inherited from
199
232
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
200
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
201
 
          normally have inherited them from
202
 
          <filename>/scripts/local-top/cryptroot</filename> in the
203
 
          initial <acronym>RAM</acronym> disk environment, which will
204
 
          have set them from parsing kernel arguments and
205
 
          <filename>/conf/conf.d/cryptroot</filename> (also in the
206
 
          initial RAM disk environment), which in turn will have been
207
 
          created when the initial RAM disk image was created by
208
 
          <filename
209
 
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
210
 
          extracting the information of the root file system from
211
 
          <filename >/etc/crypttab</filename>.
 
233
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
 
234
          have in turn inherited them from its calling process.
212
235
        </para>
213
236
        <para>
214
237
          This behavior is meant to exactly mirror the behavior of
215
 
          <command>askpass</command>, the default password prompter.
 
238
          <command>askpass</command>, the default password prompter
 
239
          from initramfs-tools.
216
240
        </para>
217
241
        </listitem>
218
242
      </varlistentry>
221
245
  
222
246
  <refsect1 id="bugs">
223
247
    <title>BUGS</title>
224
 
    <para>
225
 
      None are known at this time.
226
 
    </para>
 
248
    <xi:include href="../bugs.xml"/>
227
249
  </refsect1>
228
250
  
229
251
  <refsect1 id="example">
295
317
    <title>SEE ALSO</title>
296
318
    <para>
297
319
      <citerefentry><refentrytitle>intro</refentrytitle>
298
 
      <manvolnum>8mandos</manvolnum></citerefentry>
299
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
300
 
      <manvolnum>5</manvolnum></citerefentry>
 
320
      <manvolnum>8mandos</manvolnum></citerefentry>,
301
321
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
302
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
322
      <manvolnum>8mandos</manvolnum></citerefentry>,
303
323
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
304
324
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
325
      <citerefentry><refentrytitle>plymouthd</refentrytitle>
 
326
      <manvolnum>8</manvolnum></citerefentry>
305
327
    </para>
306
328
  </refsect1>
307
329
</refentry>