man/systemd-fsckd.service.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!--
   5   This file is part of systemd.
   6
   7   Copyright 2015 Canonical
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 -->
  22 <refentry id="systemd-fsckd.service" xmlns:xi="http://www.w3.org/2001/XInclude">
  23
  24   <refentryinfo>
  25     <title>systemd-fsckd.service</title>
  26     <productname>systemd</productname>
  27
  28     <authorgroup>
  29       <author>
  30         <contrib>Developer</contrib>
  31         <firstname>Didier</firstname>
  32         <surname>Roche</surname>
  33         <email>didrocks@ubuntu.com</email>
  34       </author>
  35     </authorgroup>
  36   </refentryinfo>
  37
  38   <refmeta>
  39     <refentrytitle>systemd-fsckd.service</refentrytitle>
  40     <manvolnum>8</manvolnum>
  41   </refmeta>
  42
  43   <refnamediv>
  44     <refname>systemd-fsckd.service</refname>
  45     <refname>systemd-fsckd.socket</refname>
  46     <refname>systemd-fsckd</refname>
  47     <refpurpose>File system check progress reporting</refpurpose>
  48   </refnamediv>
  49
  50   <refsynopsisdiv>
  51     <para><filename>systemd-fsckd.service</filename></para>
  52     <para><filename>systemd-fsckd.socket</filename></para>
  53     <para><filename>/usr/lib/systemd/systemd-fsckd</filename></para>
  54   </refsynopsisdiv>
  55
  56   <refsect1>
  57     <title>Description</title>
  58
  59     <para><filename>systemd-fsckd.service</filename> is a service responsible
  60     for receiving file system check progress, and communicating some
  61     consolidated data to console and plymouth (if running). It also handles
  62     possible check cancellations.</para>
  63
  64     <para><command>systemd-fsckd</command> receives messages about file
  65     system check progress from <command>systemd-fsck</command> through a
  66     UNIX domain socket. It can display the progress of the least advanced
  67     fsck as well as the total number of devices being checked in parallel
  68     to the console. It will also send progress messages to plymouth.
  69     Both the raw data and translated messages are sent, so compiled
  70     plymouth themes can use the raw data to display custom messages, and
  71     scripted themes, not supporting i18n, can display the translated
  72     versions.</para>
  73
  74     <para><command>systemd-fsckd</command> will instruct plymouth to grab
  75     Control+C keypresses. When the key is pressed, running checks will be
  76     terminated. It will also cancel any newly connected fsck instances for
  77     the lifetime of <filename>systemd-fsckd</filename>.</para>
  78   </refsect1>
  79
  80   <refsect1>
  81     <title>Protocol for communication with plymouth</title>
  82
  83     <para><filename>systemd-fsckd</filename> passes the
  84     following messages to the theme:</para>
  85
  86     <para>Progress update, sent as a plymouth update message:
  87       <literal>fsckd:&lt;num_devices&gt;:&lt;progress&gt;:&lt;string&gt;</literal>
  88       <variablelist>
  89         <varlistentry>
  90           <term><literal>&lt;num_devices&gt;</literal></term>
  91           <listitem><para>the current number of devices
  92           being checked (int)</para></listitem>
  93         </varlistentry>
  94         <varlistentry>
  95           <term><literal>&lt;progress&gt;</literal></term>
  96           <listitem><para>the current minimum percentage of
  97           all devices being checking (float, from 0 to 100)</para></listitem>
  98         </varlistentry>
  99         <varlistentry>
 100           <term><literal>&lt;string&gt;</literal></term>
 101           <listitem><para>a translated message ready to be displayed
 102           by the plymouth theme displaying the data above. It can be overriden
 103           by themes supporting i18n.</para></listitem>
 104         </varlistentry>
 105       </variablelist>
 106     </para>
 107
 108     <para>Cancel message, sent as a traditional plymouth message:
 109       <literal>fsckd-cancel-msg:&lt;string&gt;</literal>
 110       <variablelist>
 111         <varlistentry>
 112           <term><literal>&lt;strings&gt;</literal></term>
 113           <listitem><para>a translated string ready to be displayed
 114           by the plymouth theme indicating that Control+C can be used to cancel
 115           current checks. It can be overriden (matching only
 116           <literal>fsckd-cancel-msg</literal> prefix)
 117           by themes supporting i18n.</para></listitem>
 118         </varlistentry>
 119       </variablelist>
 120     </para>
 121   </refsect1>
 122
 123   <refsect1>
 124     <title>Options</title>
 125
 126     <para>The following options are understood:</para>
 127
 128     <variablelist>
 129       <xi:include href="standard-options.xml" xpointer="help" />
 130       <xi:include href="standard-options.xml" xpointer="version" />
 131     </variablelist>
 132
 133   </refsect1>
 134
 135   <refsect1>
 136     <title>Exit status</title>
 137
 138     <para>On success, 0 is returned, a non-zero failure
 139     code otherwise. Note that the daemon stays idle for
 140     a while to accept new <filename>systemd-fsck</filename>
 141     connections before exiting.</para>
 142   </refsect1>
 143
 144   <refsect1>
 145     <title>See Also</title>
 146     <para>
 147       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 148       <citerefentry><refentrytitle>systemd-fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 149       <citerefentry project='man-pages'><refentrytitle>fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 150       <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 151       <citerefentry project='man-pages'><refentrytitle>fsck.btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 152       <citerefentry project='man-pages'><refentrytitle>fsck.cramfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 153       <citerefentry project='man-pages'><refentrytitle>fsck.ext4</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 154       <citerefentry project='man-pages'><refentrytitle>fsck.fat</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 155       <citerefentry project='man-pages'><refentrytitle>fsck.hfsplus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 156       <citerefentry project='man-pages'><refentrytitle>fsck.minix</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 157       <citerefentry project='man-pages'><refentrytitle>fsck.ntfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 158       <citerefentry project='man-pages'><refentrytitle>fsck.xfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 159     </para>
 160   </refsect1>
 161
 162 </refentry>