man/systemd-ask-password.1

   1 '\" t
   2 .\"     Title: systemd-ask-password
   3 .\"    Author: Lennart Poettering <lennart@poettering.net>
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 02/15/2012
   6 .\"    Manual: systemd-ask-password
   7 .\"    Source: systemd
   8 .\"  Language: English
   9 .\"
  10 .TH "SYSTEMD\-ASK\-PASSWO" "1" "02/15/2012" "systemd" "systemd-ask-password"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 systemd-ask-password \- Query the user for a system password
  32 .SH "SYNOPSIS"
  33 .HP \w'\fBsystemd\-ask\-password\ \fR\fB[OPTIONS...]\fR\fB\ \fR\fB[MESSAGE]\fR\ 'u
  34 \fBsystemd\-ask\-password \fR\fB[OPTIONS...]\fR\fB \fR\fB[MESSAGE]\fR
  35 .SH "DESCRIPTION"
  36 .PP
  37 \fBsystemd\-ask\-password\fR
  38 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 STDOUT\&. When run with no TTY or with
  39 \fB\-\-no\-tty\fR
  40 it will query the password system\-wide and allow active users to respond via several agents\&. The latter is only available to privileged processes\&.
  41 .PP
  42 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\&.
  43 .PP
  44 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
  45 \fBwall\fR(1)
  46 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
  47 \fBsystemctl\fR(1)
  48 invocations\&.
  49 .PP
  50 Additional password agents may be implemented according to the
  51 \m[blue]\fBsystemd Password Agent Specification\fR\m[]\&\s-2\u[1]\d\s+2\&.
  52 .PP
  53 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\&.
  54 .SH "OPTIONS"
  55 .PP
  56 The following options are understood:
  57 .PP
  58 \fB\-\-h\fR, \fB\-\-help\fR
  59 .RS 4
  60 Prints a short help text and exits\&.
  61 .RE
  62 .PP
  63 \fB\-\-icon=\fR
  64 .RS 4
  65 Specify an icon name alongside the password query, which may be used in all agents supporting graphical display\&. The icon name should follow the
  66 \m[blue]\fBXDG Icon Naming Specification\fR\m[]\&\s-2\u[2]\d\s+2\&.
  67 .RE
  68 .PP
  69 \fB\-\-timeout=\fR
  70 .RS 4
  71 Specify the query timeout in seconds\&. Defaults to 90s\&.
  72 .RE
  73 .PP
  74 \fB\-\-no\-tty\fR
  75 .RS 4
  76 Never ask for password on current TTY even if one is available\&. Always use agent system\&.
  77 .RE
  78 .PP
  79 \fB\-\-accept\-cached\fR
  80 .RS 4
  81 If passed accept cached passwords, i\&.e\&. passwords previously typed in\&.
  82 .RE
  83 .PP
  84 \fB\-\-multiple\fR
  85 .RS 4
  86 When used in conjunction with
  87 \fB\-\-accept\-cached\fR
  88 accept multiple passwords\&. This will output one password per line\&.
  89 .RE
  90 .SH "EXIT STATUS"
  91 .PP
  92 On success 0 is returned, a non\-zero failure code otherwise\&.
  93 .SH "SEE ALSO"
  94 .PP
  95
  96 \fBsystemd\fR(1),
  97 \fBsystemctl\fR(1),
  98 \fBplymouth\fR(8),
  99 \fBwall\fR(1)
 100 .SH "AUTHOR"
 101 .PP
 102 \fBLennart Poettering\fR <\&lennart@poettering\&.net\&>
 103 .RS 4
 104 Developer
 105 .RE
 106 .SH "NOTES"
 107 .IP " 1." 4
 108 systemd Password Agent Specification
 109 .RS 4
 110 \%http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents
 111 .RE
 112 .IP " 2." 4
 113 XDG Icon Naming Specification
 114 .RS 4
 115 \%http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
 116 .RE