summaryrefslogtreecommitdiff
path: root/man/systemd-fsckd.service.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2015-04-28 17:13:23 +0200
committerLennart Poettering <lennart@poettering.net>2015-04-28 17:30:00 +0200
commit96d9117ad2db7d8c13f7898127eee8939e88daf1 (patch)
tree182c7c733b81452f4099fe4c33a2e3bf060b2051 /man/systemd-fsckd.service.xml
parente7a3aa3df640993ce9aace39b946543305f3af53 (diff)
fsck: remove fsckd again, but keep the door open for external replacement
For a longer discussion see this: http://lists.freedesktop.org/archives/systemd-devel/2015-April/030175.html This introduces /run/systemd/fsck.progress as a simply AF_UNIX/SOCK_STREAM socket. If it exists and is connectable we'll connect fsck's -c switch with it. If external programs want to get progress data they should hence listen on this socket and will get all they need via that socket. To get information about the connecting fsck client they should use SO_PEERCRED. Unless /run/systemd/fsck.progress is around and connectable this change reverts back to v219 behaviour where we'd forward fsck output to /dev/console on our own.
Diffstat (limited to 'man/systemd-fsckd.service.xml')
-rw-r--r--man/systemd-fsckd.service.xml162
1 files changed, 0 insertions, 162 deletions
diff --git a/man/systemd-fsckd.service.xml b/man/systemd-fsckd.service.xml
deleted file mode 100644
index 2ad78448f8..0000000000
--- a/man/systemd-fsckd.service.xml
+++ /dev/null
@@ -1,162 +0,0 @@
-<?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@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>
-
- <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><command>systemd-fsckd</command> 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>
- </refsect1>
-
- <refsect1>
- <title>Protocol for communication with plymouth</title>
-
- <para><filename>systemd-fsckd</filename> passes the
- following messages to the theme:</para>
-
- <para>Progress update, sent as a plymouth update message:
- <literal>fsckd:&lt;num_devices&gt;:&lt;progress&gt;:&lt;string&gt;</literal>
- <variablelist>
- <varlistentry>
- <term><literal>&lt;num_devices&gt;</literal></term>
- <listitem><para>the current number of devices
- being checked (int)</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>&lt;progress&gt;</literal></term>
- <listitem><para>the current minimum percentage of
- all devices being checking (float, from 0 to 100)</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><literal>&lt;string&gt;</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:&lt;string&gt;</literal>
- <variablelist>
- <varlistentry>
- <term><literal>&lt;strings&gt;</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 project='man-pages'><refentrytitle>fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>fsck.btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>fsck.cramfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>fsck.ext4</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>fsck.fat</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>fsck.hfsplus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>fsck.minix</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>fsck.ntfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>fsck.xfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>
- </para>
- </refsect1>
-
-</refentry>