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 This file is part of systemd.
10 Copyright 2010 Lennart Poettering
13 <refentry id=
"systemd-tty-ask-password-agent"
14 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
17 <title>systemd-tty-ask-password-agent
</title>
18 <productname>systemd
</productname>
22 <contrib>Developer
</contrib>
23 <firstname>Lennart
</firstname>
24 <surname>Poettering
</surname>
25 <email>lennart@poettering.net
</email>
31 <refentrytitle>systemd-tty-ask-password-agent
</refentrytitle>
32 <manvolnum>1</manvolnum>
36 <refname>systemd-tty-ask-password-agent
</refname>
37 <refpurpose>List or process pending systemd password requests
</refpurpose>
42 <command>systemd-tty-ask-password-agent
</command>
43 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
44 <arg choice=
"opt" rep=
"repeat">VARIABLE=VALUE
</arg>
49 <title>Description
</title>
51 <para><command>systemd-tty-ask-password-agent
</command> is a
52 password agent that handles password requests of the system, for
53 example for hard disk encryption passwords or SSL certificate
54 passwords that need to be queried at boot-time or during
57 <para><command>systemd-tty-ask-password-agent
</command> implements
58 the
<ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password
59 Agents Specification
</ulink>, and is one of many possible response agents which
60 answer to queries formulated with
61 <citerefentry><refentrytitle>systemd-ask-password
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
66 <title>Options
</title>
68 <para>The following options are understood:
</para>
72 <term><option>--list
</option></term>
74 <listitem><para>Lists all currently pending system password requests.
</para></listitem>
78 <term><option>--query
</option></term>
80 <listitem><para>Process all currently pending system password
81 requests by querying the user on the calling
82 TTY.
</para></listitem>
86 <term><option>--watch
</option></term>
88 <listitem><para>Continuously process password
89 requests.
</para></listitem>
93 <term><option>--wall
</option></term>
95 <listitem><para>Forward password requests to
96 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
97 instead of querying the user on the calling
98 TTY.
</para></listitem>
102 <term><option>--plymouth
</option></term>
104 <listitem><para>Ask question with
105 <citerefentry project='die-net'
><refentrytitle>plymouth
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
106 instead of querying the user on the calling
107 TTY.
</para></listitem>
111 <term><option>--console
</option></term>
113 <listitem><para>Ask question on
114 <filename>/dev/console
</filename> instead of querying the user
115 on the calling TTY.
</para></listitem>
118 <xi:include href=
"standard-options.xml" xpointer=
"help" />
119 <xi:include href=
"standard-options.xml" xpointer=
"version" />
125 <title>Exit status
</title>
127 <para>On success,
0 is returned, a non-zero failure
128 code otherwise.
</para>
132 <title>See Also
</title>
134 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
135 <citerefentry><refentrytitle>systemctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
136 <citerefentry><refentrytitle>systemd-ask-password-console.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
137 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
138 <citerefentry project='die-net'
><refentrytitle>plymouth
</refentrytitle><manvolnum>8</manvolnum></citerefentry>