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 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id="systemd-tty-ask-password-agent"
25 xmlns:xi="http://www.w3.org/2001/XInclude">
28 <title>systemd-tty-ask-password-agent</title>
29 <productname>systemd</productname>
33 <contrib>Developer</contrib>
34 <firstname>Lennart</firstname>
35 <surname>Poettering</surname>
36 <email>lennart@poettering.net</email>
42 <refentrytitle>systemd-tty-ask-password-agent</refentrytitle>
43 <manvolnum>1</manvolnum>
47 <refname>systemd-tty-ask-password-agent</refname>
48 <refpurpose>List or process pending systemd password requests</refpurpose>
53 <command>systemd-tty-ask-password-agent <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg></command>
58 <title>Description</title>
60 <para><command>systemd-tty-ask-password-agent</command> is a
61 password agent that handles password requests of the system, for
62 example for hard disk encryption passwords or SSL certificate
63 passwords that need to be queried at boot-time or during
66 <para><command>systemd-tty-ask-password-agent</command> implements
67 the <ulink url="http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password
68 Agents Specification</ulink>.</para>
73 <title>Options</title>
75 <para>The following options are understood:</para>
79 <term><option>--list</option></term>
81 <listitem><para>Lists all currently pending system password requests.</para></listitem>
85 <term><option>--query</option></term>
87 <listitem><para>Process all currently pending system password
88 requests by querying the user on the calling
89 TTY.</para></listitem>
93 <term><option>--watch</option></term>
95 <listitem><para>Continuously process password
96 requests.</para></listitem>
100 <term><option>--wall</option></term>
102 <listitem><para>Forward password requests to
103 <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
104 instead of querying the user on the calling
105 TTY.</para></listitem>
109 <term><option>--plymouth</option></term>
111 <listitem><para>Ask question with
112 <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
113 instead of querying the user on the calling
114 TTY.</para></listitem>
118 <term><option>--console</option></term>
120 <listitem><para>Ask question on
121 <filename>/dev/console</filename> instead of querying the user
122 on the calling TTY. </para></listitem>
125 <xi:include href="standard-options.xml" xpointer="help" />
126 <xi:include href="standard-options.xml" xpointer="version" />
132 <title>Exit status</title>
134 <para>On success, 0 is returned, a non-zero failure
135 code otherwise.</para>
139 <title>See Also</title>
141 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
142 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
143 <citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
144 <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
145 <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>