/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: 2016-06-21 19:47:08 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 344.
  • Revision ID: teddy@recompile.se-20160621194708-bmsd15fu32llgb4s
Fix typo in README.Debian for mandos-client package.

* debian/mandos.README.Debian: Replace "it it" with "it is", and make
  lintian warning tag "spelling-error-in-readme-debian" go away.

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