/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: 2022-04-23 21:24:26 UTC
  • mto: This revision was merged to the branch mainline in revision 406.
  • Revision ID: teddy@recompile.se-20220423212426-b30ysw54gtpacvny
Server: Fix minor style issue

* mandos: Consistently use double quotes instead of single quotes.

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 "2015-07-20">
 
5
<!ENTITY TIMESTAMP "2019-07-27">
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>
42
46
      <holder>Teddy Hogeborn</holder>
43
47
      <holder>Björn Påhlsson</holder>
44
48
    </copyright>
65
69
        >PREFIX</replaceable></arg>
66
70
      </group>
67
71
      <sbr/>
 
72
      <arg choice="opt">
 
73
        <option>--prompt <replaceable>PROMPT</replaceable></option>
 
74
      </arg>
68
75
      <arg choice="opt"><option>--debug</option></arg>
69
76
    </cmdsynopsis>
70
77
    <cmdsynopsis>
106
113
      wrapper, although actual use of that function is not guaranteed
107
114
      or implied.
108
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>
109
125
  </refsect1>
110
126
  
111
127
  <refsect1 id="options">
134
150
      </varlistentry>
135
151
      
136
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>
137
165
        <term><option>--debug</option></term>
138
166
        <listitem>
139
167
          <para>
193
221
        <term><envar>CRYPTTAB_NAME</envar></term>
194
222
        <listitem>
195
223
          <para>
196
 
            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
197
226
            contain the source device name and the target device
198
227
            mapper name, respectively, and will be shown as part of
199
228
            the prompt.
201
230
        <para>
202
231
          These variables will normally be inherited from
203
232
          <citerefentry><refentrytitle>plugin-runner</refentrytitle>
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>.
 
233
          <manvolnum>8mandos</manvolnum></citerefentry>, which might
 
234
          have in turn inherited them from its calling process.
216
235
        </para>
217
236
        <para>
218
237
          This behavior is meant to exactly mirror the behavior of
219
 
          <command>askpass</command>, the default password prompter.
 
238
          <command>askpass</command>, the default password prompter
 
239
          from initramfs-tools.
220
240
        </para>
221
241
        </listitem>
222
242
      </varlistentry>
225
245
  
226
246
  <refsect1 id="bugs">
227
247
    <title>BUGS</title>
228
 
    <para>
229
 
      None are known at this time.
230
 
    </para>
 
248
    <xi:include href="../bugs.xml"/>
231
249
  </refsect1>
232
250
  
233
251
  <refsect1 id="example">
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>