]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/systemd-fsck@.service.xml
travis: add more ASan options
[thirdparty/systemd.git] / man / systemd-fsck@.service.xml
index e934352f1916d7bb9ee74accefb7d0a5f60d4be1..121b0cdf76f2dca62fd72c4df4df3d24e49b9e5c 100644 (file)
 <?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 2012 Lennart Poettering
-
-  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/>.
--->
+<!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+ -->
 <refentry id="systemd-fsck@.service">
 
-        <refentryinfo>
-                <title>systemd-fsck@.service</title>
-                <productname>systemd</productname>
-
-                <authorgroup>
-                        <author>
-                                <contrib>Developer</contrib>
-                                <firstname>Lennart</firstname>
-                                <surname>Poettering</surname>
-                                <email>lennart@poettering.net</email>
-                        </author>
-                </authorgroup>
-        </refentryinfo>
-
-        <refmeta>
-                <refentrytitle>systemd-fsck@.service</refentrytitle>
-                <manvolnum>8</manvolnum>
-        </refmeta>
-
-        <refnamediv>
-                <refname>systemd-fsck@.service</refname>
-                <refname>systemd-fsck-root.service</refname>
-                <refname>systemd-fsck</refname>
-                <refpurpose>File system checker logic</refpurpose>
-        </refnamediv>
-
-        <refsynopsisdiv>
-                <para><filename>systemd-fsck@.service</filename></para>
-                <para><filename>systemd-fsck-root.service</filename></para>
-                <para><filename>/usr/lib/systemd/systemd-fsck</filename></para>
-        </refsynopsisdiv>
-
-        <refsect1>
-                <title>Description</title>
-
-                <para><filename>systemd-fsck@.service</filename> is a
-                service responsible for file system checks. It is
-                instantiated for each device that requires a file
-                system
-                check. <filename>systemd-fsck-root.service</filename> is
-                responsible for file system checks on the root
-                file system.</para>
-
-                <para><filename>systemd-fsck</filename> will
-                forward file system checking progress to the
-                console. If a file system check fails, emergency mode
-                is activated, by isolating to
-                <filename>emergency.target</filename>.</para>
-        </refsect1>
-
-        <refsect1>
-                <title>Kernel Command Line</title>
-
-                <para><filename>systemd-fsck</filename> understands
-                one kernel command line parameter:</para>
-
-                <variablelist class='kernel-commandline-options'>
-                        <varlistentry>
-                                <term><varname>fsck.mode=</varname></term>
-
-                                <listitem><para>One of
-                                <literal>auto</literal>,
-                                <literal>force</literal>,
-                                <literal>skip</literal>. Controls the
-                                mode of operation. The default is
-                                <literal>auto</literal>, and ensures
-                                that file system checks are done when
-                                the file system checker deems them
-                                necessary. <literal>force</literal>
-                                unconditionally results in full file
-                                system checks. <literal>skip</literal>
-                                skips any file system
-                                checks.</para></listitem>
-                        </varlistentry>
-                </variablelist>
-        </refsect1>
-
-        <refsect1>
-                <title>See Also</title>
-                <para>
-                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-                </para>
-        </refsect1>
+  <refentryinfo>
+    <title>systemd-fsck@.service</title>
+    <productname>systemd</productname>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>systemd-fsck@.service</refentrytitle>
+    <manvolnum>8</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>systemd-fsck@.service</refname>
+    <refname>systemd-fsck-root.service</refname>
+    <refname>systemd-fsck</refname>
+    <refpurpose>File system checker logic</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <para><filename>systemd-fsck@.service</filename></para>
+    <para><filename>systemd-fsck-root.service</filename></para>
+    <para><filename>/usr/lib/systemd/systemd-fsck</filename></para>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para><filename>systemd-fsck@.service</filename> and
+    <filename>systemd-fsck-root.service</filename> are services
+    responsible for file system checks. They are instantiated for each
+    device that is configured for file system checking.
+    <filename>systemd-fsck-root.service</filename> is responsible for
+    file system checks on the root file system, but only if the
+    root filesystem was not checked in the initramfs.
+    <filename>systemd-fsck@.service</filename> is used for all other
+    file systems and for the root file system in the initramfs.</para>
+
+    <para>These services are started at boot if
+    <option>passno</option> in <filename>/etc/fstab</filename> for the
+    file system is set to a value greater than zero. The file system
+    check for root is performed before the other file systems. Other
+    file systems may be checked in parallel, except when they are on
+    the same rotating disk.</para>
+
+    <para><filename>systemd-fsck</filename> does not know any details
+    about specific filesystems, and simply executes file system
+    checkers specific to each filesystem type
+    (<filename>/sbin/fsck.*</filename>). These checkers will decide if
+    the filesystem should actually be checked based on the time since
+    last check, number of mounts, unclean unmount, etc.</para>
+
+    <para>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>
+  </refsect1>
+
+  <refsect1>
+    <title>Kernel Command Line</title>
+
+    <para><filename>systemd-fsck</filename> understands these kernel
+    command line parameters:</para>
+
+    <variablelist class='kernel-commandline-options'>
+      <varlistentry>
+        <term><varname>fsck.mode=</varname></term>
+
+        <listitem><para>One of <literal>auto</literal>,
+        <literal>force</literal>, <literal>skip</literal>. Controls
+        the mode of operation. The default is <literal>auto</literal>,
+        and ensures that file system checks are done when the file
+        system checker deems them necessary. <literal>force</literal>
+        unconditionally results in full file system checks.
+        <literal>skip</literal> skips any file system
+        checks.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><varname>fsck.repair=</varname></term>
+
+        <listitem><para>One of <literal>preen</literal>,
+        <literal>yes</literal>, <literal>no</literal>. Controls the
+        mode of operation. The default is <literal>preen</literal>,
+        and will automatically repair problems that can be safely
+        fixed. <literal>yes</literal> will answer yes to all
+        questions by fsck and <literal>no</literal> will answer no to
+        all questions. </para></listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+    <para>
+      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</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>