]>
Commit | Line | Data |
---|---|---|
c52f663b | 1 | <?xml version='1.0'?> <!--*-nxml-*--> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
eea10b26 | 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> |
db9ecf05 | 4 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
c52f663b | 5 | |
dfdebb1b | 6 | <refentry id="systemd-tty-ask-password-agent" |
798d3a52 ZJS |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
8 | ||
9 | <refentryinfo> | |
10 | <title>systemd-tty-ask-password-agent</title> | |
11 | <productname>systemd</productname> | |
798d3a52 ZJS |
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> | |
c65aafbb ZJS |
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> | |
798d3a52 ZJS |
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 | |
f856778b | 42 | the <ulink url="https://systemd.io/PASSWORD_AGENTS/">Password Agents |
43 | Specification</ulink>, and is one of many possible response agents which | |
c65aafbb ZJS |
44 | answer to queries formulated with |
45 | <citerefentry><refentrytitle>systemd-ask-password</refentrytitle><manvolnum>1</manvolnum></citerefentry>. | |
46 | </para> | |
798d3a52 ZJS |
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 | ||
ec07c3c8 AK |
58 | <listitem><para>Lists all currently pending system password requests.</para> |
59 | ||
60 | <xi:include href="version-info.xml" xpointer="v186"/></listitem> | |
798d3a52 ZJS |
61 | </varlistentry> |
62 | ||
63 | <varlistentry> | |
64 | <term><option>--query</option></term> | |
65 | ||
66 | <listitem><para>Process all currently pending system password | |
67 | requests by querying the user on the calling | |
ec07c3c8 AK |
68 | TTY.</para> |
69 | ||
70 | <xi:include href="version-info.xml" xpointer="v186"/></listitem> | |
798d3a52 ZJS |
71 | </varlistentry> |
72 | ||
73 | <varlistentry> | |
74 | <term><option>--watch</option></term> | |
75 | ||
76 | <listitem><para>Continuously process password | |
ec07c3c8 AK |
77 | requests.</para> |
78 | ||
79 | <xi:include href="version-info.xml" xpointer="v186"/></listitem> | |
798d3a52 ZJS |
80 | </varlistentry> |
81 | ||
82 | <varlistentry> | |
83 | <term><option>--wall</option></term> | |
84 | ||
85 | <listitem><para>Forward password requests to | |
86 | <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
87 | instead of querying the user on the calling | |
ec07c3c8 AK |
88 | TTY.</para> |
89 | ||
90 | <xi:include href="version-info.xml" xpointer="v186"/></listitem> | |
798d3a52 ZJS |
91 | </varlistentry> |
92 | ||
93 | <varlistentry> | |
94 | <term><option>--plymouth</option></term> | |
95 | ||
96 | <listitem><para>Ask question with | |
97 | <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
98 | instead of querying the user on the calling | |
ec07c3c8 AK |
99 | TTY.</para> |
100 | ||
101 | <xi:include href="version-info.xml" xpointer="v186"/></listitem> | |
798d3a52 ZJS |
102 | </varlistentry> |
103 | ||
104 | <varlistentry> | |
af88c399 | 105 | <term><option>--console</option><optional>=<replaceable>DEVICE</replaceable></optional></term> |
798d3a52 | 106 | |
af88c399 ZJS |
107 | <listitem><para>Ask question on TTY <replaceable>DEVICE</replaceable> instead of querying the user on |
108 | the calling TTY. If <replaceable>DEVICE</replaceable> is not specified, | |
ec07c3c8 AK |
109 | <filename>/dev/console</filename> will be used.</para> |
110 | ||
aefdc112 | 111 | <xi:include href="version-info.xml" xpointer="v186"/></listitem> |
798d3a52 ZJS |
112 | </varlistentry> |
113 | ||
114 | <xi:include href="standard-options.xml" xpointer="help" /> | |
115 | <xi:include href="standard-options.xml" xpointer="version" /> | |
116 | </variablelist> | |
117 | ||
118 | </refsect1> | |
119 | ||
120 | <refsect1> | |
121 | <title>Exit status</title> | |
122 | ||
123 | <para>On success, 0 is returned, a non-zero failure | |
124 | code otherwise.</para> | |
125 | </refsect1> | |
126 | ||
127 | <refsect1> | |
128 | <title>See Also</title> | |
13a69c12 DT |
129 | <para><simplelist type="inline"> |
130 | <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> | |
131 | <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> | |
132 | <member><citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> | |
133 | <member><citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> | |
134 | <member><citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> | |
135 | </simplelist></para> | |
798d3a52 | 136 | </refsect1> |
c52f663b LP |
137 | |
138 | </refentry> |