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

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="systemd-tty-ask-password-agent"
   7     xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>systemd-tty-ask-password-agent</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-tty-ask-password-agent</refentrytitle>
  16     <manvolnum>1</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-tty-ask-password-agent</refname>
  21     <refpurpose>List or process pending systemd password requests</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>systemd-tty-ask-password-agent</command>
  27       <arg choice="opt" rep="repeat">OPTIONS</arg>
  28       <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg>
  29     </cmdsynopsis>
  30   </refsynopsisdiv>
  31
  32   <refsect1>
  33     <title>Description</title>
  34
  35     <para><command>systemd-tty-ask-password-agent</command> is a
  36     password agent that handles password requests of the system, for
  37     example for hard disk encryption passwords or SSL certificate
  38     passwords that need to be queried at boot-time or during
  39     runtime.</para>
  40
  41     <para><command>systemd-tty-ask-password-agent</command> implements
  42     the <ulink url="https://systemd.io/PASSWORD_AGENTS/">Password Agents
  43     Specification</ulink>, and is one of many possible response agents which
  44     answer to queries formulated with
  45     <citerefentry><refentrytitle>systemd-ask-password</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
  46     </para>
  47   </refsect1>
  48
  49   <refsect1>
  50     <title>Options</title>
  51
  52     <para>The following options are understood:</para>
  53
  54     <variablelist>
  55       <varlistentry>
  56         <term><option>--list</option></term>
  57
  58         <listitem><para>Lists all currently pending system password requests.</para>
  59
  60         <xi:include href="version-info.xml" xpointer="v186"/></listitem>
  61       </varlistentry>
  62
  63       <varlistentry>
  64         <term><option>--query</option></term>
  65
  66         <listitem><para>Process all currently pending system password
  67         requests by querying the user on the calling
  68         TTY.</para>
  69
  70         <xi:include href="version-info.xml" xpointer="v186"/></listitem>
  71       </varlistentry>
  72
  73       <varlistentry>
  74         <term><option>--watch</option></term>
  75
  76         <listitem><para>Continuously process password
  77         requests.</para>
  78
  79         <xi:include href="version-info.xml" xpointer="v186"/></listitem>
  80       </varlistentry>
  81
  82       <varlistentry>
  83         <term><option>--wall</option></term>
  84
  85         <listitem><para>Forward password requests to
  86         <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  87         instead of querying the user on the calling
  88         TTY.</para>
  89
  90         <xi:include href="version-info.xml" xpointer="v186"/></listitem>
  91       </varlistentry>
  92
  93       <varlistentry>
  94         <term><option>--plymouth</option></term>
  95
  96         <listitem><para>Ask question with
  97         <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  98         instead of querying the user on the calling
  99         TTY.</para>
 100
 101         <xi:include href="version-info.xml" xpointer="v186"/></listitem>
 102       </varlistentry>
 103
 104       <varlistentry>
 105         <term><option>--console</option><optional>=<replaceable>DEVICE</replaceable></optional></term>
 106
 107         <listitem><para>Ask question on TTY <replaceable>DEVICE</replaceable> instead of querying the user on
 108         the calling TTY. If <replaceable>DEVICE</replaceable> is not specified,
 109         <filename>/dev/console</filename> will be used.</para>
 110
 111         <xi:include href="version-info.xml" xpointer="v186"/></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>