]> git.proxmox.com Git - systemd.git/blame - man/systemd-tty-ask-password-agent.1
Imported Upstream version 208
[systemd.git] / man / systemd-tty-ask-password-agent.1
CommitLineData
14228c0d
MB
1'\" t
2.TH "SYSTEMD\-TTY\-ASK\-PASSWORD\-AGENT" "1" "" "systemd 208" "systemd-tty-ask-password-agent"
3.\" -----------------------------------------------------------------
4.\" * Define some portability stuff
5.\" -----------------------------------------------------------------
6.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7.\" http://bugs.debian.org/507673
8.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10.ie \n(.g .ds Aq \(aq
11.el .ds Aq '
12.\" -----------------------------------------------------------------
13.\" * set default formatting
14.\" -----------------------------------------------------------------
15.\" disable hyphenation
16.nh
17.\" disable justification (adjust text to left margin only)
18.ad l
19.\" -----------------------------------------------------------------
20.\" * MAIN CONTENT STARTS HERE *
21.\" -----------------------------------------------------------------
22.SH "NAME"
23systemd-tty-ask-password-agent \- List or process pending systemd password requests
24.SH "SYNOPSIS"
25.HP \w'\fBsystemd\-tty\-ask\-password\-agent\ \fR\fB[OPTIONS...]\fR\fB\ \fR\fB[VARIABLE=VALUE...]\fR\ 'u
26\fBsystemd\-tty\-ask\-password\-agent \fR\fB[OPTIONS...]\fR\fB \fR\fB[VARIABLE=VALUE...]\fR
27.SH "DESCRIPTION"
28.PP
29\fBsystemd\-tty\-ask\-password\-agent\fR
30is a password agent that handles password requests of the system, for example for hard disk encryption passwords or SSL certificate passwords that need to be queried at boot\-time or during runtime\&.
31.PP
32\fBsystemd\-tty\-ask\-password\-agent\fR
33implements the
34\m[blue]\fBPassword Agents Specification\fR\m[]\&\s-2\u[1]\d\s+2\&.
35.SH "OPTIONS"
36.PP
37The following options are understood:
38.PP
39\fB\-h\fR, \fB\-\-help\fR
40.RS 4
41Prints a short help text and exits\&.
42.RE
43.PP
44\fB\-\-version\fR
45.RS 4
46Prints a short version string and exits\&.
47.RE
48.PP
49\fB\-\-list\fR
50.RS 4
51Lists all currently pending system password requests\&.
52.RE
53.PP
54\fB\-\-query\fR
55.RS 4
56Process all currently pending system password requests by querying the user on the calling TTY\&.
57.RE
58.PP
59\fB\-\-watch\fR
60.RS 4
61Continuously process password requests\&.
62.RE
63.PP
64\fB\-\-wall\fR
65.RS 4
66Forward password requests to
67\fBwall\fR(1)
68instead of querying the user on the calling TTY\&.
69.RE
70.PP
71\fB\-\-plymouth\fR
72.RS 4
73Ask question with
74\fBplymouth\fR(8)
75instead of querying the user on the calling TTY\&.
76.RE
77.PP
78\fB\-\-console\fR
79.RS 4
80Ask question on
81/dev/console
82instead of querying the user on the calling TTY\&.
83.RE
84.SH "EXIT STATUS"
85.PP
86On success 0 is returned, a non\-zero failure code otherwise\&.
87.SH "SEE ALSO"
88.PP
89\fBsystemd\fR(1),
90\fBsystemctl\fR(1),
91\fBsystemd-ask-password-console.service\fR(8),
92\fBwall\fR(1),
93\fBplymouth\fR(8)
94.SH "NOTES"
95.IP " 1." 4
96Password Agents Specification
97.RS 4
98\%http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
99.RE