]>
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 ZJS |
6 | SPDX-License-Identifier: LGPL-2.1+ |
7 | ||
c52f663b LP |
8 | This file is part of systemd. |
9 | ||
10 | Copyright 2010 Lennart Poettering | |
11 | ||
12 | systemd is free software; you can redistribute it and/or modify it | |
13 | under the terms of the GNU Lesser General Public License as published by | |
14 | the Free Software Foundation; either version 2.1 of the License, or | |
15 | (at your option) any later version. | |
16 | ||
17 | systemd is distributed in the hope that it will be useful, but | |
18 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
20 | Lesser General Public License for more details. | |
21 | ||
22 | You should have received a copy of the GNU Lesser General Public License | |
23 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
24 | --> | |
25 | ||
dfdebb1b | 26 | <refentry id="systemd-tty-ask-password-agent" |
798d3a52 ZJS |
27 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
28 | ||
29 | <refentryinfo> | |
30 | <title>systemd-tty-ask-password-agent</title> | |
31 | <productname>systemd</productname> | |
32 | ||
33 | <authorgroup> | |
34 | <author> | |
35 | <contrib>Developer</contrib> | |
36 | <firstname>Lennart</firstname> | |
37 | <surname>Poettering</surname> | |
38 | <email>lennart@poettering.net</email> | |
39 | </author> | |
40 | </authorgroup> | |
41 | </refentryinfo> | |
42 | ||
43 | <refmeta> | |
44 | <refentrytitle>systemd-tty-ask-password-agent</refentrytitle> | |
45 | <manvolnum>1</manvolnum> | |
46 | </refmeta> | |
47 | ||
48 | <refnamediv> | |
49 | <refname>systemd-tty-ask-password-agent</refname> | |
50 | <refpurpose>List or process pending systemd password requests</refpurpose> | |
51 | </refnamediv> | |
52 | ||
53 | <refsynopsisdiv> | |
54 | <cmdsynopsis> | |
c65aafbb ZJS |
55 | <command>systemd-tty-ask-password-agent</command> |
56 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
57 | <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg> | |
798d3a52 ZJS |
58 | </cmdsynopsis> |
59 | </refsynopsisdiv> | |
60 | ||
61 | <refsect1> | |
62 | <title>Description</title> | |
63 | ||
64 | <para><command>systemd-tty-ask-password-agent</command> is a | |
65 | password agent that handles password requests of the system, for | |
66 | example for hard disk encryption passwords or SSL certificate | |
67 | passwords that need to be queried at boot-time or during | |
68 | runtime.</para> | |
69 | ||
70 | <para><command>systemd-tty-ask-password-agent</command> implements | |
28a0ad81 | 71 | the <ulink url="https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password |
c65aafbb ZJS |
72 | Agents Specification</ulink>, and is one of many possible response agents which |
73 | answer to queries formulated with | |
74 | <citerefentry><refentrytitle>systemd-ask-password</refentrytitle><manvolnum>1</manvolnum></citerefentry>. | |
75 | </para> | |
798d3a52 ZJS |
76 | </refsect1> |
77 | ||
78 | <refsect1> | |
79 | <title>Options</title> | |
80 | ||
81 | <para>The following options are understood:</para> | |
82 | ||
83 | <variablelist> | |
84 | <varlistentry> | |
85 | <term><option>--list</option></term> | |
86 | ||
87 | <listitem><para>Lists all currently pending system password requests.</para></listitem> | |
88 | </varlistentry> | |
89 | ||
90 | <varlistentry> | |
91 | <term><option>--query</option></term> | |
92 | ||
93 | <listitem><para>Process all currently pending system password | |
94 | requests by querying the user on the calling | |
95 | TTY.</para></listitem> | |
96 | </varlistentry> | |
97 | ||
98 | <varlistentry> | |
99 | <term><option>--watch</option></term> | |
100 | ||
101 | <listitem><para>Continuously process password | |
102 | requests.</para></listitem> | |
103 | </varlistentry> | |
104 | ||
105 | <varlistentry> | |
106 | <term><option>--wall</option></term> | |
107 | ||
108 | <listitem><para>Forward password requests to | |
109 | <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
110 | instead of querying the user on the calling | |
111 | TTY.</para></listitem> | |
112 | </varlistentry> | |
113 | ||
114 | <varlistentry> | |
115 | <term><option>--plymouth</option></term> | |
116 | ||
117 | <listitem><para>Ask question with | |
118 | <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
119 | instead of querying the user on the calling | |
120 | TTY.</para></listitem> | |
121 | </varlistentry> | |
122 | ||
123 | <varlistentry> | |
124 | <term><option>--console</option></term> | |
125 | ||
126 | <listitem><para>Ask question on | |
127 | <filename>/dev/console</filename> instead of querying the user | |
128 | on the calling TTY. </para></listitem> | |
129 | </varlistentry> | |
130 | ||
131 | <xi:include href="standard-options.xml" xpointer="help" /> | |
132 | <xi:include href="standard-options.xml" xpointer="version" /> | |
133 | </variablelist> | |
134 | ||
135 | </refsect1> | |
136 | ||
137 | <refsect1> | |
138 | <title>Exit status</title> | |
139 | ||
140 | <para>On success, 0 is returned, a non-zero failure | |
141 | code otherwise.</para> | |
142 | </refsect1> | |
143 | ||
144 | <refsect1> | |
145 | <title>See Also</title> | |
146 | <para> | |
147 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
148 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
149 | <citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
150 | <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
151 | <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
152 | </para> | |
153 | </refsect1> | |
c52f663b LP |
154 | |
155 | </refentry> |