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</command>
  54       <arg choice="opt" rep="repeat">OPTIONS</arg>
  55       <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg>
  56     </cmdsynopsis>
  57   </refsynopsisdiv>
  58
  59   <refsect1>
  60     <title>Description</title>
  61
  62     <para><command>systemd-tty-ask-password-agent</command> is a
  63     password agent that handles password requests of the system, for
  64     example for hard disk encryption passwords or SSL certificate
  65     passwords that need to be queried at boot-time or during
  66     runtime.</para>
  67
  68     <para><command>systemd-tty-ask-password-agent</command> implements
  69     the <ulink url="https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password
  70     Agents Specification</ulink>, and is one of many possible response agents which
  71     answer to queries formulated with
  72     <citerefentry><refentrytitle>systemd-ask-password</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
  73     </para>
  74   </refsect1>
  75
  76   <refsect1>
  77     <title>Options</title>
  78
  79     <para>The following options are understood:</para>
  80
  81     <variablelist>
  82       <varlistentry>
  83         <term><option>--list</option></term>
  84
  85         <listitem><para>Lists all currently pending system password requests.</para></listitem>
  86       </varlistentry>
  87
  88       <varlistentry>
  89         <term><option>--query</option></term>
  90
  91         <listitem><para>Process all currently pending system password
  92         requests by querying the user on the calling
  93         TTY.</para></listitem>
  94       </varlistentry>
  95
  96       <varlistentry>
  97         <term><option>--watch</option></term>
  98
  99         <listitem><para>Continuously process password
 100         requests.</para></listitem>
 101       </varlistentry>
 102
 103       <varlistentry>
 104         <term><option>--wall</option></term>
 105
 106         <listitem><para>Forward password requests to
 107         <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 108         instead of querying the user on the calling
 109         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 calling
 118         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> instead of querying the user
 126         on the calling TTY. </para></listitem>
 127       </varlistentry>
 128
 129       <xi:include href="standard-options.xml" xpointer="help" />
 130       <xi:include href="standard-options.xml" xpointer="version" />
 131     </variablelist>
 132
 133   </refsect1>
 134
 135   <refsect1>
 136     <title>Exit status</title>
 137
 138     <para>On success, 0 is returned, a non-zero failure
 139     code otherwise.</para>
 140   </refsect1>
 141
 142   <refsect1>
 143     <title>See Also</title>
 144     <para>
 145       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 146       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 147       <citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 148       <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 149       <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 150     </para>
 151   </refsect1>
 152
 153 </refentry>