/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/password-prompt.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-07-27 19:48:18 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190727194818-6z48vytqifrzz2dx
Debian package: Override the last lintian warning

* debian/source/lintian-overrides: New.

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