1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
6 <refentry id=
"systemd-tty-ask-password-agent"
7 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
10 <title>systemd-tty-ask-password-agent
</title>
11 <productname>systemd
</productname>
15 <refentrytitle>systemd-tty-ask-password-agent
</refentrytitle>
16 <manvolnum>1</manvolnum>
20 <refname>systemd-tty-ask-password-agent
</refname>
21 <refpurpose>List or process pending systemd password requests
</refpurpose>
26 <command>systemd-tty-ask-password-agent
</command>
27 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
28 <arg choice=
"opt" rep=
"repeat">VARIABLE=VALUE
</arg>
33 <title>Description
</title>
35 <para><command>systemd-tty-ask-password-agent
</command> is a
36 password agent that handles password requests of the system, for
37 example for hard disk encryption passwords or SSL certificate
38 passwords that need to be queried at boot-time or during
41 <para><command>systemd-tty-ask-password-agent
</command> implements
42 the
<ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password
43 Agents Specification
</ulink>, and is one of many possible response agents which
44 answer to queries formulated with
45 <citerefentry><refentrytitle>systemd-ask-password
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
50 <title>Options
</title>
52 <para>The following options are understood:
</para>
56 <term><option>--list
</option></term>
58 <listitem><para>Lists all currently pending system password requests.
</para></listitem>
62 <term><option>--query
</option></term>
64 <listitem><para>Process all currently pending system password
65 requests by querying the user on the calling
66 TTY.
</para></listitem>
70 <term><option>--watch
</option></term>
72 <listitem><para>Continuously process password
73 requests.
</para></listitem>
77 <term><option>--wall
</option></term>
79 <listitem><para>Forward password requests to
80 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
81 instead of querying the user on the calling
82 TTY.
</para></listitem>
86 <term><option>--plymouth
</option></term>
88 <listitem><para>Ask question with
89 <citerefentry project='die-net'
><refentrytitle>plymouth
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
90 instead of querying the user on the calling
91 TTY.
</para></listitem>
95 <term><option>--console
</option></term>
97 <listitem><para>Ask question on
98 <filename>/dev/console
</filename> instead of querying the user
99 on the calling TTY.
</para></listitem>
102 <xi:include href=
"standard-options.xml" xpointer=
"help" />
103 <xi:include href=
"standard-options.xml" xpointer=
"version" />
109 <title>Exit status
</title>
111 <para>On success,
0 is returned, a non-zero failure
112 code otherwise.
</para>
116 <title>See Also
</title>
118 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
119 <citerefentry><refentrytitle>systemctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
120 <citerefentry><refentrytitle>systemd-ask-password-console.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
121 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
122 <citerefentry project='die-net'
><refentrytitle>plymouth
</refentrytitle><manvolnum>8</manvolnum></citerefentry>