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+
8 Copyright 2010 Lennart Poettering
11 <refentry id=
"systemd-tty-ask-password-agent"
12 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
15 <title>systemd-tty-ask-password-agent
</title>
16 <productname>systemd
</productname>
20 <contrib>Developer
</contrib>
21 <firstname>Lennart
</firstname>
22 <surname>Poettering
</surname>
23 <email>lennart@poettering.net
</email>
29 <refentrytitle>systemd-tty-ask-password-agent
</refentrytitle>
30 <manvolnum>1</manvolnum>
34 <refname>systemd-tty-ask-password-agent
</refname>
35 <refpurpose>List or process pending systemd password requests
</refpurpose>
40 <command>systemd-tty-ask-password-agent
</command>
41 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
42 <arg choice=
"opt" rep=
"repeat">VARIABLE=VALUE
</arg>
47 <title>Description
</title>
49 <para><command>systemd-tty-ask-password-agent
</command> is a
50 password agent that handles password requests of the system, for
51 example for hard disk encryption passwords or SSL certificate
52 passwords that need to be queried at boot-time or during
55 <para><command>systemd-tty-ask-password-agent
</command> implements
56 the
<ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password
57 Agents Specification
</ulink>, and is one of many possible response agents which
58 answer to queries formulated with
59 <citerefentry><refentrytitle>systemd-ask-password
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
64 <title>Options
</title>
66 <para>The following options are understood:
</para>
70 <term><option>--list
</option></term>
72 <listitem><para>Lists all currently pending system password requests.
</para></listitem>
76 <term><option>--query
</option></term>
78 <listitem><para>Process all currently pending system password
79 requests by querying the user on the calling
80 TTY.
</para></listitem>
84 <term><option>--watch
</option></term>
86 <listitem><para>Continuously process password
87 requests.
</para></listitem>
91 <term><option>--wall
</option></term>
93 <listitem><para>Forward password requests to
94 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
95 instead of querying the user on the calling
96 TTY.
</para></listitem>
100 <term><option>--plymouth
</option></term>
102 <listitem><para>Ask question with
103 <citerefentry project='die-net'
><refentrytitle>plymouth
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
104 instead of querying the user on the calling
105 TTY.
</para></listitem>
109 <term><option>--console
</option></term>
111 <listitem><para>Ask question on
112 <filename>/dev/console
</filename> instead of querying the user
113 on the calling TTY.
</para></listitem>
116 <xi:include href=
"standard-options.xml" xpointer=
"help" />
117 <xi:include href=
"standard-options.xml" xpointer=
"version" />
123 <title>Exit status
</title>
125 <para>On success,
0 is returned, a non-zero failure
126 code otherwise.
</para>
130 <title>See Also
</title>
132 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
133 <citerefentry><refentrytitle>systemctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
134 <citerefentry><refentrytitle>systemd-ask-password-console.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
135 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
136 <citerefentry project='die-net'
><refentrytitle>plymouth
</refentrytitle><manvolnum>8</manvolnum></citerefentry>