/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: 2015-10-04 13:44:03 UTC
  • Revision ID: teddy@recompile.se-20151004134403-jn72bwgbw3aocllk
* initramfs-tools-hook: Don't try to chmod symlinks.

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 "2019-07-27">
 
5
<!ENTITY TIMESTAMP "2015-07-20">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
39
39
      <year>2013</year>
40
40
      <year>2014</year>
41
41
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
42
      <holder>Teddy Hogeborn</holder>
47
43
      <holder>Björn Påhlsson</holder>
48
44
    </copyright>
69
65
        >PREFIX</replaceable></arg>
70
66
      </group>
71
67
      <sbr/>
72
 
      <arg choice="opt">
73
 
        <option>--prompt <replaceable>PROMPT</replaceable></option>
74
 
      </arg>
75
68
      <arg choice="opt"><option>--debug</option></arg>
76
69
    </cmdsynopsis>
77
70
    <cmdsynopsis>
113
106
      wrapper, although actual use of that function is not guaranteed
114
107
      or implied.
115
108
    </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>
125
109
  </refsect1>
126
110
  
127
111
  <refsect1 id="options">
150
134
      </varlistentry>
151
135
      
152
136
      <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>
165
137
        <term><option>--debug</option></term>
166
138
        <listitem>
167
139
          <para>
221
193
        <term><envar>CRYPTTAB_NAME</envar></term>
222
194
        <listitem>
223
195
          <para>
224
 
            If set, and if the <option>--prompt</option> option is not
225
 
            used, these environment variables will be assumed to
 
196
            If set, these environment variables will be assumed to
226
197
            contain the source device name and the target device
227
198
            mapper name, respectively, and will be shown as part of
228
199
            the prompt.
230
201
        <para>
231
202
          These variables will normally be inherited from
232
203
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
233
 
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
234
 
          have in turn inherited them from its calling process.
 
204
          <manvolnum>8mandos</manvolnum></citerefentry>, which will
 
205
          normally have inherited them from
 
206
          <filename>/scripts/local-top/cryptroot</filename> in the
 
207
          initial <acronym>RAM</acronym> disk environment, which will
 
208
          have set them from parsing kernel arguments and
 
209
          <filename>/conf/conf.d/cryptroot</filename> (also in the
 
210
          initial RAM disk environment), which in turn will have been
 
211
          created when the initial RAM disk image was created by
 
212
          <filename
 
213
          >/usr/share/initramfs-tools/hooks/cryptroot</filename>, by
 
214
          extracting the information of the root file system from
 
215
          <filename >/etc/crypttab</filename>.
235
216
        </para>
236
217
        <para>
237
218
          This behavior is meant to exactly mirror the behavior of
238
 
          <command>askpass</command>, the default password prompter
239
 
          from initramfs-tools.
 
219
          <command>askpass</command>, the default password prompter.
240
220
        </para>
241
221
        </listitem>
242
222
      </varlistentry>
245
225
  
246
226
  <refsect1 id="bugs">
247
227
    <title>BUGS</title>
248
 
    <xi:include href="../bugs.xml"/>
 
228
    <para>
 
229
      None are known at this time.
 
230
    </para>
249
231
  </refsect1>
250
232
  
251
233
  <refsect1 id="example">
317
299
    <title>SEE ALSO</title>
318
300
    <para>
319
301
      <citerefentry><refentrytitle>intro</refentrytitle>
320
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
302
      <manvolnum>8mandos</manvolnum></citerefentry>
 
303
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
304
      <manvolnum>5</manvolnum></citerefentry>
321
305
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
322
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
306
      <manvolnum>8mandos</manvolnum></citerefentry>
323
307
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
324
308
      <manvolnum>8mandos</manvolnum></citerefentry>,
325
 
      <citerefentry><refentrytitle>plymouthd</refentrytitle>
326
 
      <manvolnum>8</manvolnum></citerefentry>
327
309
    </para>
328
310
  </refsect1>
329
311
</refentry>