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
  26         <refentryinfo>
  27                 <title>systemd-tty-ask-password-agent</title>
  28                 <productname>systemd</productname>
  29
  30                 <authorgroup>
  31                         <author>
  32                                 <contrib>Developer</contrib>
  33                                 <firstname>Lennart</firstname>
  34                                 <surname>Poettering</surname>
  35                                 <email>lennart@poettering.net</email>
  36                         </author>
  37                 </authorgroup>
  38         </refentryinfo>
  39
  40         <refmeta>
  41                 <refentrytitle>systemd-tty-ask-password-agent</refentrytitle>
  42                 <manvolnum>1</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>systemd-tty-ask-password-agent</refname>
  47                 <refpurpose>List or process pending systemd password requests</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <cmdsynopsis>
  52                         <command>systemd-tty-ask-password-agent <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg></command>
  53                 </cmdsynopsis>
  54         </refsynopsisdiv>
  55
  56         <refsect1>
  57                 <title>Description</title>
  58
  59                 <para><command>systemd-tty-ask-password-agent</command>
  60                 is a password agent that handles password
  61                 requests of the system, for example for hard disk
  62                 encryption passwords or SSL certificate passwords that
  63                 need to be queried at boot-time or during
  64                 runtime.</para>
  65
  66                 <para><command>systemd-tty-ask-password-agent</command>
  67                 implements the <ulink
  68                 url="http://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password
  69                 Agents Specification</ulink>.</para>
  70
  71         </refsect1>
  72
  73         <refsect1>
  74                 <title>Options</title>
  75
  76                 <para>The following options are understood:</para>
  77
  78                 <variablelist>
  79                         <varlistentry>
  80                                 <term><option>-h</option></term>
  81                                 <term><option>--help</option></term>
  82
  83                                 <listitem><para>Prints a short help
  84                                 text and exits.</para></listitem>
  85                         </varlistentry>
  86
  87                         <varlistentry>
  88                                 <term><option>--version</option></term>
  89
  90                                 <listitem><para>Prints a short version
  91                                 string and exits.</para></listitem>
  92                         </varlistentry>
  93
  94                         <varlistentry>
  95                                 <term><option>--list</option></term>
  96
  97                                 <listitem><para>Lists all currently pending system password requests.</para></listitem>
  98                         </varlistentry>
  99
 100                         <varlistentry>
 101                                 <term><option>--query</option></term>
 102
 103                                 <listitem><para>Process all currently
 104                                 pending system password requests by
 105                                 querying the user on the calling
 106                                 TTY.</para></listitem>
 107                         </varlistentry>
 108
 109                         <varlistentry>
 110                                 <term><option>--watch</option></term>
 111
 112                                 <listitem><para>Continuously process
 113                                 password requests.</para></listitem>
 114                         </varlistentry>
 115
 116                         <varlistentry>
 117                                 <term><option>--wall</option></term>
 118
 119                                 <listitem><para>Forward password
 120                                 requests to
 121                                 <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 122                                 instead of querying the user on the
 123                                 calling TTY.</para></listitem>
 124                         </varlistentry>
 125
 126                         <varlistentry>
 127                                 <term><option>--plymouth</option></term>
 128
 129                                 <listitem><para>Ask question with
 130                                 <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 131                                 instead of querying the user on the
 132                                 calling TTY.</para></listitem>
 133                         </varlistentry>
 134
 135                         <varlistentry>
 136                                 <term><option>--console</option></term>
 137
 138                                 <listitem><para>Ask question on
 139                                 <filename>/dev/console</filename>
 140                                 instead of querying the user on the
 141                                 calling TTY.  </para></listitem>
 142                         </varlistentry>
 143
 144                 </variablelist>
 145
 146         </refsect1>
 147
 148         <refsect1>
 149                 <title>Exit status</title>
 150
 151                 <para>On success 0 is returned, a non-zero failure
 152                 code otherwise.</para>
 153         </refsect1>
 154
 155         <refsect1>
 156                 <title>See Also</title>
 157                 <para>
 158                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 159                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 160                         <citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 161                         <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 162                         <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 163                 </para>
 164         </refsect1>
 165
 166 </refentry>