]>
Commit | Line | Data |
---|---|---|
c52f663b LP |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
c52f663b LP |
4 | |
5 | <!-- | |
572eb058 | 6 | SPDX-License-Identifier: LGPL-2.1+ |
c52f663b LP |
7 | --> |
8 | ||
dfdebb1b | 9 | <refentry id="systemd-tty-ask-password-agent" |
798d3a52 ZJS |
10 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
11 | ||
12 | <refentryinfo> | |
13 | <title>systemd-tty-ask-password-agent</title> | |
14 | <productname>systemd</productname> | |
798d3a52 ZJS |
15 | </refentryinfo> |
16 | ||
17 | <refmeta> | |
18 | <refentrytitle>systemd-tty-ask-password-agent</refentrytitle> | |
19 | <manvolnum>1</manvolnum> | |
20 | </refmeta> | |
21 | ||
22 | <refnamediv> | |
23 | <refname>systemd-tty-ask-password-agent</refname> | |
24 | <refpurpose>List or process pending systemd password requests</refpurpose> | |
25 | </refnamediv> | |
26 | ||
27 | <refsynopsisdiv> | |
28 | <cmdsynopsis> | |
c65aafbb ZJS |
29 | <command>systemd-tty-ask-password-agent</command> |
30 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
31 | <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg> | |
798d3a52 ZJS |
32 | </cmdsynopsis> |
33 | </refsynopsisdiv> | |
34 | ||
35 | <refsect1> | |
36 | <title>Description</title> | |
37 | ||
38 | <para><command>systemd-tty-ask-password-agent</command> is a | |
39 | password agent that handles password requests of the system, for | |
40 | example for hard disk encryption passwords or SSL certificate | |
41 | passwords that need to be queried at boot-time or during | |
42 | runtime.</para> | |
43 | ||
44 | <para><command>systemd-tty-ask-password-agent</command> implements | |
28a0ad81 | 45 | the <ulink url="https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password |
c65aafbb ZJS |
46 | Agents Specification</ulink>, and is one of many possible response agents which |
47 | answer to queries formulated with | |
48 | <citerefentry><refentrytitle>systemd-ask-password</refentrytitle><manvolnum>1</manvolnum></citerefentry>. | |
49 | </para> | |
798d3a52 ZJS |
50 | </refsect1> |
51 | ||
52 | <refsect1> | |
53 | <title>Options</title> | |
54 | ||
55 | <para>The following options are understood:</para> | |
56 | ||
57 | <variablelist> | |
58 | <varlistentry> | |
59 | <term><option>--list</option></term> | |
60 | ||
61 | <listitem><para>Lists all currently pending system password requests.</para></listitem> | |
62 | </varlistentry> | |
63 | ||
64 | <varlistentry> | |
65 | <term><option>--query</option></term> | |
66 | ||
67 | <listitem><para>Process all currently pending system password | |
68 | requests by querying the user on the calling | |
69 | TTY.</para></listitem> | |
70 | </varlistentry> | |
71 | ||
72 | <varlistentry> | |
73 | <term><option>--watch</option></term> | |
74 | ||
75 | <listitem><para>Continuously process password | |
76 | requests.</para></listitem> | |
77 | </varlistentry> | |
78 | ||
79 | <varlistentry> | |
80 | <term><option>--wall</option></term> | |
81 | ||
82 | <listitem><para>Forward password requests to | |
83 | <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
84 | instead of querying the user on the calling | |
85 | TTY.</para></listitem> | |
86 | </varlistentry> | |
87 | ||
88 | <varlistentry> | |
89 | <term><option>--plymouth</option></term> | |
90 | ||
91 | <listitem><para>Ask question with | |
92 | <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
93 | instead of querying the user on the calling | |
94 | TTY.</para></listitem> | |
95 | </varlistentry> | |
96 | ||
97 | <varlistentry> | |
98 | <term><option>--console</option></term> | |
99 | ||
100 | <listitem><para>Ask question on | |
101 | <filename>/dev/console</filename> instead of querying the user | |
102 | on the calling TTY. </para></listitem> | |
103 | </varlistentry> | |
104 | ||
105 | <xi:include href="standard-options.xml" xpointer="help" /> | |
106 | <xi:include href="standard-options.xml" xpointer="version" /> | |
107 | </variablelist> | |
108 | ||
109 | </refsect1> | |
110 | ||
111 | <refsect1> | |
112 | <title>Exit status</title> | |
113 | ||
114 | <para>On success, 0 is returned, a non-zero failure | |
115 | code otherwise.</para> | |
116 | </refsect1> | |
117 | ||
118 | <refsect1> | |
119 | <title>See Also</title> | |
120 | <para> | |
121 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
122 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
123 | <citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
124 | <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
125 | <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
126 | </para> | |
127 | </refsect1> | |
c52f663b LP |
128 | |
129 | </refentry> |