man/systemd-tty-ask-password-agent.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   This file is part of systemd.
   7
   8   Copyright 2010 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="systemd-tty-ask-password-agent"
  25           xmlns:xi="http://www.w3.org/2001/XInclude">
  26
  27         <refentryinfo>
  28                 <title>systemd-tty-ask-password-agent</title>
  29                 <productname>systemd</productname>
  30
  31                 <authorgroup>
  32                         <author>
  33                                 <contrib>Developer</contrib>
  34                                 <firstname>Lennart</firstname>
  35                                 <surname>Poettering</surname>
  36                                 <email>lennart@poettering.net</email>
  37                         </author>
  38                 </authorgroup>
  39         </refentryinfo>
  40
  41         <refmeta>
  42                 <refentrytitle>systemd-tty-ask-password-agent</refentrytitle>
  43                 <manvolnum>1</manvolnum>
  44         </refmeta>
  45
  46         <refnamediv>
  47                 <refname>systemd-tty-ask-password-agent</refname>
  48                 <refpurpose>List or process pending systemd password requests</refpurpose>
  49         </refnamediv>
  50
  51         <refsynopsisdiv>
  52                 <cmdsynopsis>
  53                         <command>systemd-tty-ask-password-agent <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg></command>
  54                 </cmdsynopsis>
  55         </refsynopsisdiv>
  56
  57         <refsect1>
  58                 <title>Description</title>
  59
  60                 <para><command>systemd-tty-ask-password-agent</command>
  61                 is a password agent that handles password
  62                 requests of the system, for example for hard disk
  63                 encryption passwords or SSL certificate passwords that
  64                 need to be queried at boot-time or during
  65                 runtime.</para>
  66
  67                 <para><command>systemd-tty-ask-password-agent</command>
  68                 implements the <ulink
  69                 url="http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password
  70                 Agents Specification</ulink>.</para>
  71
  72         </refsect1>
  73
  74         <refsect1>
  75                 <title>Options</title>
  76
  77                 <para>The following options are understood:</para>
  78
  79                 <variablelist>
  80                         <varlistentry>
  81                                 <term><option>--list</option></term>
  82
  83                                 <listitem><para>Lists all currently pending system password requests.</para></listitem>
  84                         </varlistentry>
  85
  86                         <varlistentry>
  87                                 <term><option>--query</option></term>
  88
  89                                 <listitem><para>Process all currently
  90                                 pending system password requests by
  91                                 querying the user on the calling
  92                                 TTY.</para></listitem>
  93                         </varlistentry>
  94
  95                         <varlistentry>
  96                                 <term><option>--watch</option></term>
  97
  98                                 <listitem><para>Continuously process
  99                                 password requests.</para></listitem>
 100                         </varlistentry>
 101
 102                         <varlistentry>
 103                                 <term><option>--wall</option></term>
 104
 105                                 <listitem><para>Forward password
 106                                 requests to
 107                                 <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 108                                 instead of querying the user on the
 109                                 calling TTY.</para></listitem>
 110                         </varlistentry>
 111
 112                         <varlistentry>
 113                                 <term><option>--plymouth</option></term>
 114
 115                                 <listitem><para>Ask question with
 116                                 <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 117                                 instead of querying the user on the
 118                                 calling TTY.</para></listitem>
 119                         </varlistentry>
 120
 121                         <varlistentry>
 122                                 <term><option>--console</option></term>
 123
 124                                 <listitem><para>Ask question on
 125                                 <filename>/dev/console</filename>
 126                                 instead of querying the user on the
 127                                 calling TTY.  </para></listitem>
 128                         </varlistentry>
 129
 130                         <xi:include href="standard-options.xml" xpointer="help" />
 131                         <xi:include href="standard-options.xml" xpointer="version" />
 132                 </variablelist>
 133
 134         </refsect1>
 135
 136         <refsect1>
 137                 <title>Exit status</title>
 138
 139                 <para>On success, 0 is returned, a non-zero failure
 140                 code otherwise.</para>
 141         </refsect1>
 142
 143         <refsect1>
 144                 <title>See Also</title>
 145                 <para>
 146                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 147                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 148                         <citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 149                         <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 150                         <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 151                 </para>
 152         </refsect1>
 153
 154 </refentry>