1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 SPDX-License-Identifier: LGPL-2.1+
9 <refentry id=
"systemd-tty-ask-password-agent"
10 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
13 <title>systemd-tty-ask-password-agent
</title>
14 <productname>systemd
</productname>
18 <refentrytitle>systemd-tty-ask-password-agent
</refentrytitle>
19 <manvolnum>1</manvolnum>
23 <refname>systemd-tty-ask-password-agent
</refname>
24 <refpurpose>List or process pending systemd password requests
</refpurpose>
29 <command>systemd-tty-ask-password-agent
</command>
30 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
31 <arg choice=
"opt" rep=
"repeat">VARIABLE=VALUE
</arg>
36 <title>Description
</title>
38 <para><command>systemd-tty-ask-password-agent
</command> is a
39 password agent that handles password requests of the system, for
40 example for hard disk encryption passwords or SSL certificate
41 passwords that need to be queried at boot-time or during
44 <para><command>systemd-tty-ask-password-agent
</command> implements
45 the
<ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password
46 Agents Specification
</ulink>, and is one of many possible response agents which
47 answer to queries formulated with
48 <citerefentry><refentrytitle>systemd-ask-password
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
53 <title>Options
</title>
55 <para>The following options are understood:
</para>
59 <term><option>--list
</option></term>
61 <listitem><para>Lists all currently pending system password requests.
</para></listitem>
65 <term><option>--query
</option></term>
67 <listitem><para>Process all currently pending system password
68 requests by querying the user on the calling
69 TTY.
</para></listitem>
73 <term><option>--watch
</option></term>
75 <listitem><para>Continuously process password
76 requests.
</para></listitem>
80 <term><option>--wall
</option></term>
82 <listitem><para>Forward password requests to
83 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
84 instead of querying the user on the calling
85 TTY.
</para></listitem>
89 <term><option>--plymouth
</option></term>
91 <listitem><para>Ask question with
92 <citerefentry project='die-net'
><refentrytitle>plymouth
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
93 instead of querying the user on the calling
94 TTY.
</para></listitem>
98 <term><option>--console
</option></term>
100 <listitem><para>Ask question on
101 <filename>/dev/console
</filename> instead of querying the user
102 on the calling TTY.
</para></listitem>
105 <xi:include href=
"standard-options.xml" xpointer=
"help" />
106 <xi:include href=
"standard-options.xml" xpointer=
"version" />
112 <title>Exit status
</title>
114 <para>On success,
0 is returned, a non-zero failure
115 code otherwise.
</para>
119 <title>See Also
</title>
121 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
122 <citerefentry><refentrytitle>systemctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
123 <citerefentry><refentrytitle>systemd-ask-password-console.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
124 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
125 <citerefentry project='die-net'
><refentrytitle>plymouth
</refentrytitle><manvolnum>8</manvolnum></citerefentry>