/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 Hogeborn
  • Date: 2019-08-05 21:15:40 UTC
  • mfrom: (1152 trunk)
  • mto: This revision was merged to the branch mainline in revision 1153.
  • Revision ID: teddy@recompile.se-20190805211540-fy4da3hn8wr52qna
Merge from trunk

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 "password-prompt">
5
 
<!ENTITY TIMESTAMP "2011-10-03">
 
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>
 
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>
37
46
      <holder>Teddy Hogeborn</holder>
38
47
      <holder>Björn Påhlsson</holder>
39
48
    </copyright>
60
69
        >PREFIX</replaceable></arg>
61
70
      </group>
62
71
      <sbr/>
 
72
      <arg choice="opt">
 
73
        <option>--prompt <replaceable>PROMPT</replaceable></option>
 
74
      </arg>
63
75
      <arg choice="opt"><option>--debug</option></arg>
64
76
    </cmdsynopsis>
65
77
    <cmdsynopsis>
101
113
      wrapper, although actual use of that function is not guaranteed
102
114
      or implied.
103
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>
104
125
  </refsect1>
105
126
  
106
127
  <refsect1 id="options">
129
150
      </varlistentry>
130
151
      
131
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>
132
165
        <term><option>--debug</option></term>
133
166
        <listitem>
134
167
          <para>
188
221
        <term><envar>CRYPTTAB_NAME</envar></term>
189
222
        <listitem>
190
223
          <para>
191
 
            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
192
226
            contain the source device name and the target device
193
227
            mapper name, respectively, and will be shown as part of
194
228
            the prompt.
196
230
        <para>
197
231
          These variables will normally be inherited from
198
232
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
199
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
200
 
          normally have inherited them from
201
 
          <filename>/scripts/local-top/cryptroot</filename> in the
202
 
          initial <acronym>RAM</acronym> disk environment, which will
203
 
          have set them from parsing kernel arguments and
204
 
          <filename>/conf/conf.d/cryptroot</filename> (also in the
205
 
          initial RAM disk environment), which in turn will have been
206
 
          created when the initial RAM disk image was created by
207
 
          <filename
208
 
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
209
 
          extracting the information of the root file system from
210
 
          <filename >/etc/crypttab</filename>.
 
233
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
 
234
          have in turn inherited them from its calling process.
211
235
        </para>
212
236
        <para>
213
237
          This behavior is meant to exactly mirror the behavior of
214
 
          <command>askpass</command>, the default password prompter.
 
238
          <command>askpass</command>, the default password prompter
 
239
          from initramfs-tools.
215
240
        </para>
216
241
        </listitem>
217
242
      </varlistentry>
220
245
  
221
246
  <refsect1 id="bugs">
222
247
    <title>BUGS</title>
223
 
    <para>
224
 
      None are known at this time.
225
 
    </para>
 
248
    <xi:include href="../bugs.xml"/>
226
249
  </refsect1>
227
250
  
228
251
  <refsect1 id="example">
294
317
    <title>SEE ALSO</title>
295
318
    <para>
296
319
      <citerefentry><refentrytitle>intro</refentrytitle>
297
 
      <manvolnum>8mandos</manvolnum></citerefentry>
298
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
299
 
      <manvolnum>5</manvolnum></citerefentry>
 
320
      <manvolnum>8mandos</manvolnum></citerefentry>,
300
321
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
301
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
322
      <manvolnum>8mandos</manvolnum></citerefentry>,
302
323
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
303
324
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
325
      <citerefentry><refentrytitle>plymouthd</refentrytitle>
 
326
      <manvolnum>8</manvolnum></citerefentry>
304
327
    </para>
305
328
  </refsect1>
306
329
</refentry>