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

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->

<refentry id="systemd-tty-ask-password-agent"
    xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>systemd-tty-ask-password-agent</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>systemd-tty-ask-password-agent</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-tty-ask-password-agent</refname>
    <refpurpose>List or process pending systemd password requests</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>systemd-tty-ask-password-agent</command>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
      <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><command>systemd-tty-ask-password-agent</command> is a
    password agent that handles password requests of the system, for
    example for hard disk encryption passwords or SSL certificate
    passwords that need to be queried at boot-time or during
    runtime.</para>

    <para><command>systemd-tty-ask-password-agent</command> implements
    the <ulink url="https://systemd.io/PASSWORD_AGENTS/">Password Agents
    Specification</ulink>, and is one of many possible response agents which
    answer to queries formulated with
    <citerefentry><refentrytitle>systemd-ask-password</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
    </para>
  </refsect1>

  <refsect1>
    <title>Options</title>

    <para>The following options are understood:</para>

    <variablelist>
      <varlistentry>
        <term><option>--list</option></term>

        <listitem><para>Lists all currently pending system password requests.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--query</option></term>

        <listitem><para>Process all currently pending system password
        requests by querying the user on the calling
        TTY.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--watch</option></term>

        <listitem><para>Continuously process password
        requests.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--wall</option></term>

        <listitem><para>Forward password requests to
        <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
        instead of querying the user on the calling
        TTY.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--plymouth</option></term>

        <listitem><para>Ask question with
        <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
        instead of querying the user on the calling
        TTY.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--console</option></term>

        <listitem><para>Ask question on
        <filename>/dev/console</filename> instead of querying the user
        on the calling TTY. </para></listitem>
      </varlistentry>

      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Exit status</title>

    <para>On success, 0 is returned, a non-zero failure
    code otherwise.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
      <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>