[systemd-devel] [PATCH 8/9] Add man page and references to it.
Zbigniew Jędrzejewski-Szmek
zbyszek at in.waw.pl
Sat Feb 14 08:58:54 PST 2015
On Thu, Feb 05, 2015 at 06:11:24PM +0100, Didier Roche wrote:
>
> From 2533acf15135d9db18fbd79e63de9a702e3859cc Mon Sep 17 00:00:00 2001
> From: Didier Roche <didrocks at ubuntu.com>
> Date: Mon, 26 Jan 2015 17:34:59 +0100
> Subject: [PATCH 8/9] Add man page and references to it.
>
> Add man page explaining the plymouth theme protocol, usage of the daemon
> as well as the socket activation part.
> Adapt existing fsck man page.
> ---
> Makefile-man.am | 12 +++
> man/systemd-fsck at .service.xml | 6 +-
> man/systemd-fsckd.service.xml | 165 +++++++++++++++++++++++++++++++++++++++++
> units/systemd-fsckd.service.in | 1 +
> units/systemd-fsckd.socket | 2 +-
> 5 files changed, 183 insertions(+), 3 deletions(-)
> create mode 100644 man/systemd-fsckd.service.xml
>
> diff --git a/Makefile-man.am b/Makefile-man.am
> index 105853e..f2e13e8 100644
> --- a/Makefile-man.am
> +++ b/Makefile-man.am
> @@ -67,6 +67,7 @@ MANPAGES += \
> man/systemd-escape.1 \
> man/systemd-firstboot.1 \
> man/systemd-fsck at .service.8 \
> + man/systemd-fsckd.service.8 \
> man/systemd-fstab-generator.8 \
> man/systemd-getty-generator.8 \
> man/systemd-gpt-auto-generator.8 \
> @@ -210,6 +211,8 @@ MANPAGES_ALIAS += \
> man/systemd-firstboot.service.1 \
> man/systemd-fsck-root.service.8 \
> man/systemd-fsck.8 \
> + man/systemd-fsckd.8 \
> + man/systemd-fsckd.socket.8 \
> man/systemd-hibernate-resume.8 \
> man/systemd-hibernate.service.8 \
> man/systemd-hybrid-sleep.service.8 \
> @@ -323,6 +326,8 @@ man/systemd-ask-password-wall.service.8: man/systemd-ask-password-console.servic
> man/systemd-firstboot.service.1: man/systemd-firstboot.1
> man/systemd-fsck-root.service.8: man/systemd-fsck at .service.8
> man/systemd-fsck.8: man/systemd-fsck at .service.8
> +man/systemd-fsckd.8: man/systemd-fsckd.service.8
> +man/systemd-fsckd.socket.8: man/systemd-fsckd.service.8
> man/systemd-hibernate-resume.8: man/systemd-hibernate-resume at .service.8
> man/systemd-hibernate.service.8: man/systemd-suspend.service.8
> man/systemd-hybrid-sleep.service.8: man/systemd-suspend.service.8
> @@ -606,6 +611,12 @@ man/systemd-fsck-root.service.html: man/systemd-fsck at .service.html
> man/systemd-fsck.html: man/systemd-fsck at .service.html
> $(html-alias)
>
> +man/systemd-fsckd.html: man/systemd-fsckd.service.html
> + $(html-alias)
> +
> +man/systemd-fsckd.socket.html: man/systemd-fsckd.service.html
> + $(html-alias)
> +
> man/systemd-hibernate-resume.html: man/systemd-hibernate-resume at .service.html
> $(html-alias)
>
> @@ -1732,6 +1743,7 @@ EXTRA_DIST += \
> man/systemd-escape.xml \
> man/systemd-firstboot.xml \
> man/systemd-fsck at .service.xml \
> + man/systemd-fsckd.service.xml \
> man/systemd-fstab-generator.xml \
> man/systemd-getty-generator.xml \
> man/systemd-gpt-auto-generator.xml \
> diff --git a/man/systemd-fsck at .service.xml b/man/systemd-fsck at .service.xml
> index ee66f37..d366712 100644
> --- a/man/systemd-fsck at .service.xml
> +++ b/man/systemd-fsck at .service.xml
> @@ -87,8 +87,9 @@
> check, number of mounts, unclean unmount, etc.</para>
>
> <para><filename>systemd-fsck</filename> will forward
> - file system checking progress to the console. If a
> - file system check fails for a service without
> + file system checking progress to
> + <filename>systemd-fsckd.service</filename>
> + socket. If a file system check fails for a service without
> <option>nofail</option>, emergency mode is activated,
> by isolating to
> <filename>emergency.target</filename>.</para>
> @@ -142,6 +143,7 @@
> <para>
> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
> <citerefentry><refentrytitle>fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> + <citerefentry><refentrytitle>systemd-fsckd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> <citerefentry><refentrytitle>fsck.btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> <citerefentry><refentrytitle>fsck.cramfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> diff --git a/man/systemd-fsckd.service.xml b/man/systemd-fsckd.service.xml
> new file mode 100644
> index 0000000..4a3b60d
> --- /dev/null
> +++ b/man/systemd-fsckd.service.xml
> @@ -0,0 +1,165 @@
> +<?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">
> +<!--
> + This file is part of systemd.
> +
> + Copyright 2015 Canonical
> +
> + systemd is free software; you can redistribute it and/or modify it
> + under the terms of the GNU Lesser General Public License as published by
> + the Free Software Foundation; either version 2.1 of the License, or
> + (at your option) any later version.
> +
> + systemd is distributed in the hope that it will be useful, but
> + WITHOUT ANY WARRANTY; without even the implied warranty of
> + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
> + Lesser General Public License for more details.
> +
> + You should have received a copy of the GNU Lesser General Public License
> + along with systemd; If not, see <http://www.gnu.org/licenses/>.
> +-->
> +<refentry id="systemd-fsckd.service" xmlns:xi="http://www.w3.org/2001/XInclude">
> +
> + <refentryinfo>
> + <title>systemd-fsckd.service</title>
> + <productname>systemd</productname>
> +
> + <authorgroup>
> + <author>
> + <contrib>Developer</contrib>
> + <firstname>Didier</firstname>
> + <surname>Roche</surname>
> + <email>didrocks at ubuntu.com</email>
> + </author>
> + </authorgroup>
> + </refentryinfo>
> +
> + <refmeta>
> + <refentrytitle>systemd-fsckd.service</refentrytitle>
> + <manvolnum>8</manvolnum>
> + </refmeta>
> +
> + <refnamediv>
> + <refname>systemd-fsckd.service</refname>
> + <refname>systemd-fsckd.socket</refname>
> + <refname>systemd-fsckd</refname>
> + <refpurpose>File system check progress reporting</refpurpose>
> + </refnamediv>
> +
> + <refsynopsisdiv>
> + <para><filename>systemd-fsckd.service</filename></para>
> + <para><filename>systemd-fsckd.socket</filename></para>
> + <para><filename>/usr/lib/systemd/systemd-fsckd</filename></para>
> + </refsynopsisdiv>
> +
> + <refsect1>
> + <title>Description</title>
> +
> + <para><filename>systemd-fsckd.service</filename> is a
> + service responsible for receiving file system check
> + progress, and communicating some consolidated data
> + to console and plymouth (if running). It also handles
> + possible check cancellations.</para>
Reflow?
> +
> + <para><filename>systemd-fsckd</filename> accepts
> + <filename>systemd-fsck</filename> UNIX domain
> + sockets communication, fetches the lowest progress value of
> + all fsck running in parallel with the number of devices
> + being currently checked. It writes the result to
> + <filename>/dev/console</filename> if show status is enabled,
> + and communicates to the user translated strings to plymouth
> + ready to be used by scripted themes, not supporting i18n.
> + The compilted plymouth themes can use the raw data (see below)
> + to display their own custom messages.</para>
<para><command>systemd-fsckd</command> receives messages about file
system check progress from <command>systemd-fsck</command> through a
UNIX domain socket. It can display the progress of the least advanced
fsck as well as the total number of devices being checked in parallel
to the console. It will also send progress messages to plymouth.
Both the raw data and translated messages are sent, so compiled
plymouth themes can use the raw data to display custom messages, and
scripted themes, not supporting i18n, can display the translated
versions.</para>
> +
> + <para>The first time it connects to plymouth, a request
> + to grab Control+C keypresses is sent, as well as a text message.
> + When the cancel key is pressed, all running fscks are terminated.
> + It will also cancel any new connected fsck for the lifetime of
> + <filename>systemd-fsckd</filename>.</para>
<para><command>systemd-fsckd</> will instruct plymouth to grab
Control+C keypresses. When the key is pressed, running checks will be
terminated. It will also cancel any newly connected fsck instances for
the lifetime of <filename>systemd-fsckd</filename>.</para>
This raises an intereseting question. IIUC, fsckd will exit on idle
after 30s, losing the information that ^C was pressed. Shouldn't
the exit-on-idle be raised to something bigger like 5 minutes, to
make this less likely to happen?
> + </refsect1>
> +
> + <refsect1>
> + <title>Protocol with plymouth</title>
Protocol for communication with plymouth
> +
> + <para><filename>systemd-fsckd</filename> passes the
> + following messages to the theme via libplymouth:</para>
Does it actually use libplymouth?
> + <para>Progress update, sent as a plymouth update message:
> + <literal>fsckd:<num_devices>:<progress>:<string></literal>
> + <variablelist>
> + <varlistentry>
> + <term><literal><num_devices></literal></term>
> + <listitem><para>the current number of devices
> + being checked (int)</para></listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><literal><progress></literal></term>
> + <listitem><para>the current minimum percentage of
> + all devices being checking (float, from 0 to 100)</para></listitem>
> + </varlistentry>
> + <varlistentry>
> + <term><literal><string></literal></term>
> + <listitem><para>a translated message ready to be displayed
> + by the plymouth theme displaying the data above. It can be overriden
> + by themes supporting i18n.</para></listitem>
> + </varlistentry>
> + </variablelist>
> + </para>
> +
> + <para>Cancel message, sent as a traditional plymouth message:
> + <literal>fsckd-cancel-msg:<string></literal>
> + <variablelist>
> + <varlistentry>
> + <term><literal><strings></literal></term>
> + <listitem><para>a translated string ready to be displayed
> + by the plymouth theme indicating that Control+C can be used to cancel
> + current checks. It can be overriden (matching only
> + <literal>fsckd-cancel-msg</literal> prefix)
> + by themes supporting i18n.</para></listitem>
> + </varlistentry>
> + </variablelist>
> + </para>
> + </refsect1>
> +
> + <refsect1>
> + <title>Options</title>
> +
> + <para>The following options are understood:</para>
> +
> + <variablelist>
> + <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. Note that the daemon stays idle for
> + a while to accept new <filename>systemd-fsck</filename>
> + connections before exiting.</para>
> + </refsect1>
> +
> + <refsect1>
> + <title>See Also</title>
> + <para>
> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
> + <citerefentry><refentrytitle>systemd-fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> + <citerefentry><refentrytitle>fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> + <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
Please add something like project='man-pages' (needs to be checked) to citerefentry,
so the links are correct in html version.
> + <citerefentry><refentrytitle>fsck.btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> + <citerefentry><refentrytitle>fsck.cramfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> + <citerefentry><refentrytitle>fsck.ext4</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> + <citerefentry><refentrytitle>fsck.fat</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> + <citerefentry><refentrytitle>fsck.hfsplus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> + <citerefentry><refentrytitle>fsck.minix</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> + <citerefentry><refentrytitle>fsck.ntfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
> + <citerefentry><refentrytitle>fsck.xfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>
> + </para>
> + </refsect1>
> +
> +</refentry>
> diff --git a/units/systemd-fsckd.service.in b/units/systemd-fsckd.service.in
> index 27c325f..9c7ed51 100644
> --- a/units/systemd-fsckd.service.in
> +++ b/units/systemd-fsckd.service.in
> @@ -7,6 +7,7 @@
>
> [Unit]
> Description=File System Check Daemon to report status
> +Documentation=man:systemd-fsckd.service(8)
> DefaultDependencies=no
> Requires=systemd-fsckd.socket
> Before=shutdown.target
> diff --git a/units/systemd-fsckd.socket b/units/systemd-fsckd.socket
> index a8994a1..93c4ea9 100644
> --- a/units/systemd-fsckd.socket
> +++ b/units/systemd-fsckd.socket
> @@ -7,7 +7,7 @@
>
> [Unit]
> Description=fsck to fsckd communication Socket
> -Documentation=man:systemd-fsck at .service(8) man:systemd-fsck-root.service(8)
> +Documentation=man:systemd-fsckd.service(8) man:systemd-fsck at .service(8) man:systemd-fsck-root.service(8)
> DefaultDependencies=no
>
> [Socket]
Zbyszek
More information about the systemd-devel
mailing list