1
0
mirror of https://github.com/systemd/systemd.git synced 2024-12-26 03:22:00 +03:00
systemd/man/systemd-ask-password-console.service.xml
Zbigniew Jędrzejewski-Szmek 73e97bb064 man: use <simplelist> for file lists in synopsis
With <para><filename>…</filename></para>, we get a separate "paragraph" for
each line, i.e. entries separated by empty lines. This uses up a lot of space
and was only done because docbook makes it hard to insert a newline. In some
other places, <literallayout> was used, but then we cannot indent the source
text (because the whitespace would end up in the final page). We can get the
desired result with <simplelist>.

With <simplelist> the items are indented in roff output, but not in html
output. In some places this looks better then no indentation, and in others it
would probably be better to have no indent. But this is a minor issue and we
cannot control that.

(I didn't convert all spots. There's a bunch of other man pages which have two
lines, e.g. an executable and service file, and it doesn't matter there so
much.)
2023-12-15 14:27:28 +01:00

70 lines
2.8 KiB
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-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><simplelist>
<member><filename>systemd-ask-password-console.service</filename></member>
<member><filename>systemd-ask-password-console.path</filename></member>
<member><filename>systemd-ask-password-wall.service</filename></member>
<member><filename>systemd-ask-password-wall.path</filename></member>
</simplelist></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://systemd.io/PASSWORD_AGENTS/">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>