man: document systemd-fsck

This commit is contained in:
Lennart Poettering 2012-06-27 00:37:36 +02:00
parent 56a379a97e
commit a32f224aaf
7 changed files with 126 additions and 5 deletions

View File

@ -493,7 +493,8 @@ MANPAGES = \
man/systemd-initctl.service.8 \
man/systemd-shutdownd.service.8 \
man/systemd-suspend.service.8 \
man/systemd-halt.service.8
man/systemd-halt.service.8 \
man/systemd-fsck@.service.8
MANPAGES_ALIAS = \
man/reboot.8 \
@ -512,7 +513,8 @@ MANPAGES_ALIAS = \
man/systemd-shutdown.8 \
man/systemd-poweroff.service.8 \
man/systemd-reboot.service.8 \
man/systemd-kexec.service.8
man/systemd-kexec.service.8 \
man/systemd-fsck-root.service.8
man/reboot.8: man/halt.8
man/poweroff.8: man/halt.8
@ -531,6 +533,7 @@ man/systemd-shutdown.8: man/systemd-halt.service.8
man/systemd-poweroff.service.8: man/systemd-halt.service.8
man/systemd-reboot.service.8: man/systemd-halt.service.8
man/systemd-kexec.service.8: man/systemd-halt.service.8
man/systemd-fsck-root.service.8: man/systemd-fsck@.service.8
XML_FILES = \
${patsubst %.1,%.xml,${patsubst %.3,%.xml,${patsubst %.5,%.xml,${patsubst %.7,%.xml,${patsubst %.8,%.xml,$(MANPAGES)}}}}}

6
TODO
View File

@ -25,6 +25,12 @@ Bugfixes:
Features:
* efi: implement /forcefsck as uefi variables thus not requiring file system altering to trigger a file system check
* efi: honour language efi variables for default language selection
* efi: honour timezone efi variables for default timezone selection
* new dependency type to "group" services in a target
* add switch to journalctl to only show data from current boot

View File

@ -160,7 +160,7 @@
<para>Parameter understood by
the file system checker
services. For details see
<citerefentry><refentrytitle>systemd-fsck-root.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
<citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
</listitem>
</varlistentry>
@ -280,7 +280,7 @@
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-fsck-root.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,

View File

@ -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>

View File

@ -82,7 +82,7 @@
<term><varname>vconsole.keymap.toggle=</varname></term>
<listitem><para>Overrides the key
mapping table for the keybaord and the
mapping table for the keyboard and the
second toggle keymap.</para></listitem>
</varlistentry>
<varlistentry>

View File

@ -7,6 +7,7 @@
[Unit]
Description=File System Check on Root Device
Documentaiton=man:systemd-fsck@.service(8)
DefaultDependencies=no
After=systemd-readahead-collect.service systemd-readahead-replay.service
Before=local-fs.target shutdown.target

View File

@ -7,6 +7,7 @@
[Unit]
Description=File System Check on %f
Documentaiton=man:systemd-fsck@.service(8)
DefaultDependencies=no
BindTo=%i.device
After=systemd-readahead-collect.service systemd-readahead-replay.service %i.device