| 1 |
'\" t |
| 2 |
.TH "SYSTEMD\-TTY\-ASK\-PASSWORD\-AGENT" "1" "" "systemd 261~rc3" "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" |
| 23 |
systemd-tty-ask-password-agent \- List or process pending systemd password requests |
| 24 |
.SH "SYNOPSIS" |
| 25 |
.HP \w'\fBsystemd\-tty\-ask\-password\-agent\fR\ 'u |
| 26 |
\fBsystemd\-tty\-ask\-password\-agent\fR [OPTIONS...] [VARIABLE=VALUE...] |
| 27 |
.SH "DESCRIPTION" |
| 28 |
.PP |
| 29 |
\fBsystemd\-tty\-ask\-password\-agent\fR |
| 30 |
is 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 |
| 33 |
implements the |
| 34 |
\m[blue]\fBPassword Agents Specification\fR\m[]\&\s-2\u[1]\d\s+2, and is one of many possible response agents which answer to queries formulated with |
| 35 |
\fBsystemd-ask-password\fR(1)\&. |
| 36 |
.SH "OPTIONS" |
| 37 |
.PP |
| 38 |
The following options are understood: |
| 39 |
.PP |
| 40 |
\fB\-\-list\fR |
| 41 |
.RS 4 |
| 42 |
Lists all currently pending system password requests\&. |
| 43 |
.sp |
| 44 |
Added in version 186\&. |
| 45 |
.RE |
| 46 |
.PP |
| 47 |
\fB\-\-query\fR |
| 48 |
.RS 4 |
| 49 |
Process all currently pending system password requests by querying the user on the calling TTY\&. |
| 50 |
.sp |
| 51 |
Added in version 186\&. |
| 52 |
.RE |
| 53 |
.PP |
| 54 |
\fB\-\-watch\fR |
| 55 |
.RS 4 |
| 56 |
Continuously process password requests\&. |
| 57 |
.sp |
| 58 |
Added in version 186\&. |
| 59 |
.RE |
| 60 |
.PP |
| 61 |
\fB\-\-wall\fR |
| 62 |
.RS 4 |
| 63 |
Forward password requests to |
| 64 |
\fBwall\fR(1) |
| 65 |
instead of querying the user on the calling TTY\&. |
| 66 |
.sp |
| 67 |
Added in version 186\&. |
| 68 |
.RE |
| 69 |
.PP |
| 70 |
\fB\-\-plymouth\fR |
| 71 |
.RS 4 |
| 72 |
Ask question with |
| 73 |
\fBplymouth\fR(8) |
| 74 |
instead of querying the user on the calling TTY\&. |
| 75 |
.sp |
| 76 |
Added in version 186\&. |
| 77 |
.RE |
| 78 |
.PP |
| 79 |
\fB\-\-console\fR[=\fIDEVICE\fR] |
| 80 |
.RS 4 |
| 81 |
Ask question on TTY |
| 82 |
\fIDEVICE\fR |
| 83 |
instead of querying the user on the calling TTY\&. If |
| 84 |
\fIDEVICE\fR |
| 85 |
is not specified, |
| 86 |
/dev/console |
| 87 |
will be used\&. |
| 88 |
.sp |
| 89 |
Added in version 186\&. |
| 90 |
.RE |
| 91 |
.PP |
| 92 |
\fB\-h\fR, \fB\-\-help\fR |
| 93 |
.RS 4 |
| 94 |
Print a short help text and exit\&. |
| 95 |
.RE |
| 96 |
.PP |
| 97 |
\fB\-\-version\fR |
| 98 |
.RS 4 |
| 99 |
Print a short version string and exit\&. |
| 100 |
.RE |
| 101 |
.SH "EXIT STATUS" |
| 102 |
.PP |
| 103 |
On success, 0 is returned, a non\-zero failure code otherwise\&. |
| 104 |
.SH "SEE ALSO" |
| 105 |
.PP |
| 106 |
\fBsystemd\fR(1), \fBsystemctl\fR(1), \fBsystemd-ask-password-console.service\fR(8), \fBwall\fR(1), \fBplymouth\fR(8) |
| 107 |
.SH "NOTES" |
| 108 |
.IP " 1." 4 |
| 109 |
Password Agents Specification |
| 110 |
.RS 4 |
| 111 |
\%https://systemd.io/PASSWORD_AGENTS/ |
| 112 |
.RE |