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