]>
Commit | Line | Data |
---|---|---|
14228c0d | 1 | '\" t |
e735f4d4 | 2 | .TH "SYSTEMD\-ASK\-PASSWORD" "1" "" "systemd 219" "systemd-ask-password" |
14228c0d MB |
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-ask-password \- Query the user for a system password | |
24 | .SH "SYNOPSIS" | |
25 | .HP \w'\fBsystemd\-ask\-password\ \fR\fB[OPTIONS...]\fR\fB\ \fR\fB[MESSAGE]\fR\ 'u | |
26 | \fBsystemd\-ask\-password \fR\fB[OPTIONS...]\fR\fB \fR\fB[MESSAGE]\fR | |
27 | .SH "DESCRIPTION" | |
28 | .PP | |
29 | \fBsystemd\-ask\-password\fR | |
60f067b4 | 30 | may be used to query a system password or passphrase from the user, using a question message specified on the command line\&. When run from a TTY it will query a password on the TTY and print it to standard output\&. When run with no TTY or with |
14228c0d MB |
31 | \fB\-\-no\-tty\fR |
32 | it will query the password system\-wide and allow active users to respond via several agents\&. The latter is only available to privileged processes\&. | |
33 | .PP | |
34 | The purpose of this tool is to query system\-wide passwords \-\- that is passwords not attached to a specific user account\&. Examples include: unlocking encrypted hard disks when they are plugged in or at boot, entering an SSL certificate passphrase for web and VPN servers\&. | |
35 | .PP | |
36 | Existing agents are: a boot\-time password agent asking the user for passwords using Plymouth; a boot\-time password agent querying the user directly on the console; an agent requesting password input via a | |
37 | \fBwall\fR(1) | |
38 | message; an agent suitable for running in a GNOME session; a command line agent which can be started temporarily to process queued password requests; a TTY agent that is temporarily spawned during | |
39 | \fBsystemctl\fR(1) | |
40 | invocations\&. | |
41 | .PP | |
42 | Additional password agents may be implemented according to the | |
43 | \m[blue]\fBsystemd Password Agent Specification\fR\m[]\&\s-2\u[1]\d\s+2\&. | |
44 | .PP | |
45 | If a password is queried on a TTY, the user may press TAB to hide the asterisks normally shown for each character typed\&. Pressing Backspace as first key achieves the same effect\&. | |
46 | .SH "OPTIONS" | |
47 | .PP | |
48 | The following options are understood: | |
49 | .PP | |
14228c0d MB |
50 | \fB\-\-icon=\fR |
51 | .RS 4 | |
52 | Specify an icon name alongside the password query, which may be used in all agents supporting graphical display\&. The icon name should follow the | |
53 | \m[blue]\fBXDG Icon Naming Specification\fR\m[]\&\s-2\u[2]\d\s+2\&. | |
54 | .RE | |
55 | .PP | |
56 | \fB\-\-timeout=\fR | |
57 | .RS 4 | |
58 | Specify the query timeout in seconds\&. Defaults to 90s\&. A timeout of 0 waits indefinitely\&. | |
59 | .RE | |
60 | .PP | |
5eef597e MP |
61 | \fB\-\-echo\fR |
62 | .RS 4 | |
63 | Echo the user input instead of masking it\&. This is useful when using | |
64 | systemd\-ask\-password | |
65 | to query for usernames\&. | |
66 | .RE | |
67 | .PP | |
14228c0d MB |
68 | \fB\-\-no\-tty\fR |
69 | .RS 4 | |
70 | Never ask for password on current TTY even if one is available\&. Always use agent system\&. | |
71 | .RE | |
72 | .PP | |
73 | \fB\-\-accept\-cached\fR | |
74 | .RS 4 | |
75 | If passed, accept cached passwords, i\&.e\&. passwords previously typed in\&. | |
76 | .RE | |
77 | .PP | |
78 | \fB\-\-multiple\fR | |
79 | .RS 4 | |
80 | When used in conjunction with | |
81 | \fB\-\-accept\-cached\fR | |
82 | accept multiple passwords\&. This will output one password per line\&. | |
83 | .RE | |
60f067b4 JS |
84 | .PP |
85 | \fB\-h\fR, \fB\-\-help\fR | |
86 | .RS 4 | |
87 | Print a short help text and exit\&. | |
88 | .RE | |
14228c0d MB |
89 | .SH "EXIT STATUS" |
90 | .PP | |
60f067b4 | 91 | On success, 0 is returned, a non\-zero failure code otherwise\&. |
14228c0d MB |
92 | .SH "SEE ALSO" |
93 | .PP | |
94 | \fBsystemd\fR(1), | |
95 | \fBsystemctl\fR(1), | |
96 | \fBplymouth\fR(8), | |
97 | \fBwall\fR(1) | |
98 | .SH "NOTES" | |
99 | .IP " 1." 4 | |
100 | systemd Password Agent Specification | |
101 | .RS 4 | |
102 | \%http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents | |
103 | .RE | |
104 | .IP " 2." 4 | |
105 | XDG Icon Naming Specification | |
106 | .RS 4 | |
107 | \%http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html | |
108 | .RE |