]>
Commit | Line | Data |
---|---|---|
663996b3 | 1 | <?xml version='1.0'?> <!--*-nxml-*--> |
bb4f798a | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
e735f4d4 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
a032b68d | 4 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
663996b3 | 5 | |
60f067b4 | 6 | <refentry id="systemd-tty-ask-password-agent" |
e735f4d4 MP |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
8 | ||
9 | <refentryinfo> | |
10 | <title>systemd-tty-ask-password-agent</title> | |
11 | <productname>systemd</productname> | |
e735f4d4 MP |
12 | </refentryinfo> |
13 | ||
14 | <refmeta> | |
15 | <refentrytitle>systemd-tty-ask-password-agent</refentrytitle> | |
16 | <manvolnum>1</manvolnum> | |
17 | </refmeta> | |
18 | ||
19 | <refnamediv> | |
20 | <refname>systemd-tty-ask-password-agent</refname> | |
21 | <refpurpose>List or process pending systemd password requests</refpurpose> | |
22 | </refnamediv> | |
23 | ||
24 | <refsynopsisdiv> | |
25 | <cmdsynopsis> | |
2897b343 MP |
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> | |
e735f4d4 MP |
29 | </cmdsynopsis> |
30 | </refsynopsisdiv> | |
31 | ||
32 | <refsect1> | |
33 | <title>Description</title> | |
34 | ||
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 | |
39 | runtime.</para> | |
40 | ||
41 | <para><command>systemd-tty-ask-password-agent</command> implements | |
a032b68d MB |
42 | the <ulink url="https://systemd.io/PASSWORD_AGENTS/">Password Agents |
43 | Specification</ulink>, and is one of many possible response agents which | |
2897b343 MP |
44 | answer to queries formulated with |
45 | <citerefentry><refentrytitle>systemd-ask-password</refentrytitle><manvolnum>1</manvolnum></citerefentry>. | |
46 | </para> | |
e735f4d4 MP |
47 | </refsect1> |
48 | ||
49 | <refsect1> | |
50 | <title>Options</title> | |
51 | ||
52 | <para>The following options are understood:</para> | |
53 | ||
54 | <variablelist> | |
55 | <varlistentry> | |
56 | <term><option>--list</option></term> | |
57 | ||
58 | <listitem><para>Lists all currently pending system password requests.</para></listitem> | |
59 | </varlistentry> | |
60 | ||
61 | <varlistentry> | |
62 | <term><option>--query</option></term> | |
63 | ||
64 | <listitem><para>Process all currently pending system password | |
65 | requests by querying the user on the calling | |
66 | TTY.</para></listitem> | |
67 | </varlistentry> | |
68 | ||
69 | <varlistentry> | |
70 | <term><option>--watch</option></term> | |
71 | ||
72 | <listitem><para>Continuously process password | |
73 | requests.</para></listitem> | |
74 | </varlistentry> | |
75 | ||
76 | <varlistentry> | |
77 | <term><option>--wall</option></term> | |
78 | ||
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> | |
83 | </varlistentry> | |
84 | ||
85 | <varlistentry> | |
86 | <term><option>--plymouth</option></term> | |
87 | ||
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> | |
92 | </varlistentry> | |
93 | ||
94 | <varlistentry> | |
8b3d4ff0 | 95 | <term><option>--console</option><optional>=<replaceable>DEVICE</replaceable></optional></term> |
e735f4d4 | 96 | |
8b3d4ff0 MB |
97 | <listitem><para>Ask question on TTY <replaceable>DEVICE</replaceable> instead of querying the user on |
98 | the calling TTY. If <replaceable>DEVICE</replaceable> is not specified, | |
99 | <filename>/dev/console</filename> will be used.</para></listitem> | |
e735f4d4 MP |
100 | </varlistentry> |
101 | ||
102 | <xi:include href="standard-options.xml" xpointer="help" /> | |
103 | <xi:include href="standard-options.xml" xpointer="version" /> | |
104 | </variablelist> | |
105 | ||
106 | </refsect1> | |
107 | ||
108 | <refsect1> | |
109 | <title>Exit status</title> | |
110 | ||
111 | <para>On success, 0 is returned, a non-zero failure | |
112 | code otherwise.</para> | |
113 | </refsect1> | |
114 | ||
115 | <refsect1> | |
116 | <title>See Also</title> | |
117 | <para> | |
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> | |
123 | </para> | |
124 | </refsect1> | |
663996b3 MS |
125 | |
126 | </refentry> |