man: document systemd-fsck

[elogind.git] / man / systemd-fsck@.service.xml

diff --git a/man/systemd-fsck@.service.xml b/man/systemd-fsck@.service.xml
new file mode 100644 (file)
index 0000000..ad980a7
--- /dev/null
+++ b/man/systemd-fsck@.service.xml
@@ -0,0 +1,110 @@
+<?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/>.
+-->
+<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@.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>
+                        <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>
+
+</refentry>