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   SPDX-License-Identifier: LGPL-2.1+
   7 -->
   8
   9 <refentry id="systemd-tty-ask-password-agent"
  10     xmlns:xi="http://www.w3.org/2001/XInclude">
  11
  12   <refentryinfo>
  13     <title>systemd-tty-ask-password-agent</title>
  14     <productname>systemd</productname>
  15
  16     <authorgroup>
  17       <author>
  18         <contrib>Developer</contrib>
  19         <firstname>Lennart</firstname>
  20         <surname>Poettering</surname>
  21         <email>lennart@poettering.net</email>
  22       </author>
  23     </authorgroup>
  24   </refentryinfo>
  25
  26   <refmeta>
  27     <refentrytitle>systemd-tty-ask-password-agent</refentrytitle>
  28     <manvolnum>1</manvolnum>
  29   </refmeta>
  30
  31   <refnamediv>
  32     <refname>systemd-tty-ask-password-agent</refname>
  33     <refpurpose>List or process pending systemd password requests</refpurpose>
  34   </refnamediv>
  35
  36   <refsynopsisdiv>
  37     <cmdsynopsis>
  38       <command>systemd-tty-ask-password-agent</command>
  39       <arg choice="opt" rep="repeat">OPTIONS</arg>
  40       <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg>
  41     </cmdsynopsis>
  42   </refsynopsisdiv>
  43
  44   <refsect1>
  45     <title>Description</title>
  46
  47     <para><command>systemd-tty-ask-password-agent</command> is a
  48     password agent that handles password requests of the system, for
  49     example for hard disk encryption passwords or SSL certificate
  50     passwords that need to be queried at boot-time or during
  51     runtime.</para>
  52
  53     <para><command>systemd-tty-ask-password-agent</command> implements
  54     the <ulink url="https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">Password
  55     Agents Specification</ulink>, and is one of many possible response agents which
  56     answer to queries formulated with
  57     <citerefentry><refentrytitle>systemd-ask-password</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
  58     </para>
  59   </refsect1>
  60
  61   <refsect1>
  62     <title>Options</title>
  63
  64     <para>The following options are understood:</para>
  65
  66     <variablelist>
  67       <varlistentry>
  68         <term><option>--list</option></term>
  69
  70         <listitem><para>Lists all currently pending system password requests.</para></listitem>
  71       </varlistentry>
  72
  73       <varlistentry>
  74         <term><option>--query</option></term>
  75
  76         <listitem><para>Process all currently pending system password
  77         requests by querying the user on the calling
  78         TTY.</para></listitem>
  79       </varlistentry>
  80
  81       <varlistentry>
  82         <term><option>--watch</option></term>
  83
  84         <listitem><para>Continuously process password
  85         requests.</para></listitem>
  86       </varlistentry>
  87
  88       <varlistentry>
  89         <term><option>--wall</option></term>
  90
  91         <listitem><para>Forward password requests to
  92         <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  93         instead of querying the user on the calling
  94         TTY.</para></listitem>
  95       </varlistentry>
  96
  97       <varlistentry>
  98         <term><option>--plymouth</option></term>
  99
 100         <listitem><para>Ask question with
 101         <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 102         instead of querying the user on the calling
 103         TTY.</para></listitem>
 104       </varlistentry>
 105
 106       <varlistentry>
 107         <term><option>--console</option></term>
 108
 109         <listitem><para>Ask question on
 110         <filename>/dev/console</filename> instead of querying the user
 111         on the calling TTY. </para></listitem>
 112       </varlistentry>
 113
 114       <xi:include href="standard-options.xml" xpointer="help" />
 115       <xi:include href="standard-options.xml" xpointer="version" />
 116     </variablelist>
 117
 118   </refsect1>
 119
 120   <refsect1>
 121     <title>Exit status</title>
 122
 123     <para>On success, 0 is returned, a non-zero failure
 124     code otherwise.</para>
 125   </refsect1>
 126
 127   <refsect1>
 128     <title>See Also</title>
 129     <para>
 130       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 131       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 132       <citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 133       <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 134       <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 135     </para>
 136   </refsect1>
 137
 138 </refentry>