From: Lennart Poettering Date: Fri, 8 Apr 2011 15:57:17 +0000 (+0200) Subject: man: add man page for ask-password X-Git-Tag: v25~76 X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=f3bc7fdc7bf47193a9f8618a7d22a6ceec2df6f7 man: add man page for ask-password --- diff --git a/Makefile.am b/Makefile.am index 2f08ceb17..6a5c491bf 100644 --- a/Makefile.am +++ b/Makefile.am @@ -572,7 +572,8 @@ MANPAGES = \ man/os-release.5 \ man/modules-load.d.5 \ man/binfmt.d.5 \ - man/sysctl.d.5 + man/sysctl.d.5 \ + man/systemd-ask-password.1 MANPAGES_ALIAS = \ man/reboot.8 \ diff --git a/man/systemd-ask-password.xml b/man/systemd-ask-password.xml new file mode 100644 index 000000000..7a6498d25 --- /dev/null +++ b/man/systemd-ask-password.xml @@ -0,0 +1,182 @@ + + + + + + + + + systemd-ask-password + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-ask-password + 1 + + + + systemd-ask-password + Query the user for a system password + + + + + systemd-ask-password OPTIONS MESSAGE + + + + + Description + + systemd-ask-password 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 it will + query the password system-wide and allow active users + to respond via several agents. The latter is + only available to privileged processes. + + 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. + + 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 + wall1 + 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 + systemctl1 + invocations. + + Additional password agents may be implemented + according to the systemd + Password Agent Specification. + + 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. + + + + + Options + + The following options are understood: + + + + + + + Prints a short help + text and exits. + + + + + + Specify an icon name + alongside the pasword query, which may + be used in all agents supporting + graphical display. The icon name + should follow the XDG + Icon Naming + Specification. + + + + + + Specify the query + timeout in seconds. + + + + + + Never ask for password + on current TTY even if one is + available. Always use agent + system. + + + + + + If passed accept + cached passwords, i.e. passwords + previously typed in. + + + + + + When used in + conjunction with + + accept multiple passwords. This will + output one password per + line. + + + + + + + Exit status + + On success 0 is returned, a non-zero failure + code otherwise. + + + + See Also + + systemd1, + systemctl1, + plymouth8, + wall1 + + + +