test: mark plymouth as optional dependency

[thirdparty/systemd.git] / man / systemd-ask-password-console.service.xml

<?xml version="1.0"?>
<!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
  SPDX-License-Identifier: LGPL-2.1+
-->
<refentry id="systemd-ask-password-console.service">

  <refentryinfo>
    <title>systemd-ask-password-console.service</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>systemd-ask-password-console.service</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-ask-password-console.service</refname>
    <refname>systemd-ask-password-console.path</refname>
    <refname>systemd-ask-password-wall.service</refname>
    <refname>systemd-ask-password-wall.path</refname>
    <refpurpose>Query the user for system passwords on the
    console and via wall</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <para><filename>systemd-ask-password-console.service</filename></para>
    <para><filename>systemd-ask-password-console.path</filename></para>
    <para><filename>systemd-ask-password-wall.service</filename></para>
    <para><filename>systemd-ask-password-wall.path</filename></para>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><filename>systemd-ask-password-console.service</filename> is
    a system service that queries the user for system passwords (such
    as hard disk encryption keys and SSL certificate passphrases) on
    the console. It is intended to be used during boot to ensure
    proper handling of passwords necessary for boot.
    <filename>systemd-ask-password-wall.service</filename> is a system
    service that informs all logged in users for system passwords via
    <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
    It is intended to be used after boot to ensure that users are
    properly notified.</para>

    <para>See the <ulink
    url="https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">
    developer documentation</ulink> for more information about the
    system password logic.</para>

    <para>Note that these services invoke
    <citerefentry><refentrytitle>systemd-tty-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>
    with either the <command>--watch --console</command> or
    <command>--watch --wall</command> command line parameters.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-tty-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>