Commit f3bc7fdc authored by Lennart Poettering's avatar Lennart Poettering
Browse files

man: add man page for ask-password

parent b21a0ef8
......@@ -572,7 +572,8 @@ MANPAGES = \
man/os-release.5 \
man/modules-load.d.5 \
man/binfmt.d.5 \
man/sysctl.d.5 \
man/reboot.8 \
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
This file is part of systemd.
Copyright 2011 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
General Public License for more details.
You should have received a copy of the GNU General Public License
along with systemd; If not, see <>.
<refentry id="systemd-ask-password">
<refpurpose>Query the user for a system password</refpurpose>
<command>systemd-ask-password <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">MESSAGE</arg></command>
<para><command>systemd-ask-password</command> 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 <option>--no-tty</option> it will
query the password system-wide and allow active users
to respond via several agents. The latter is
only available to privileged processes.</para>
<para>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.</para>
<para>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
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
<para>Additional password agents may be implemented
according to the <ulink
Password Agent Specification</ulink>.</para>
<para>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.</para>
<para>The following options are understood:</para>
<listitem><para>Prints a short help
text and exits.</para></listitem>
<listitem><para>Specify an icon name
alongside the pasword query, which may
be used in all agents supporting
graphical display. The icon name
should follow the <ulink
Icon Naming
<listitem><para>Specify the query
timeout in seconds.</para></listitem>
<listitem><para>Never ask for password
on current TTY even if one is
available. Always use agent
<listitem><para>If passed accept
cached passwords, i.e. passwords
previously typed in.</para></listitem>
<listitem><para>When used in
conjunction with
accept multiple passwords. This will
output one password per
<title>Exit status</title>
<para>On success 0 is returned, a non-zero failure
code otherwise.</para>
<title>See Also</title>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment