/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-03 12:31:22 UTC
  • Revision ID: teddy@recompile.se-20190803123122-90y9lyaf2qxxk73f
dracut-module/password-agent.c: Update #include comments

* dracut-module/password-agent.c: Update #include comments to add
  "ENOTDIR", "O_NOFOLLOW", "IN_MOVED_FROM", "IN_EXCL_UNLINK", and
  "IN_ONLYDIR".

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