man: document quotacheck

diff --git a/Makefile.am b/Makefile.am
index 3732258e669787f5ab4f1ed1c96be9b060c338d8..215e88d9b779e8dbef78cf60ba502656b6af6a30 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -2502,6 +2502,15 @@ systemd_quotacheck_SOURCES = \
 
 systemd_quotacheck_LDADD = \
        libsystemd-shared.la
+
+MANPAGES += \
+       man/systemd-quotacheck.service.8
+
+MANPAGES_ALIAS += \
+       man/systemd-quotacheck.8
+
+man/systemd-quotacheck.8: man/systemd-quotacheck.service.8
+
 endif
 
 # ------------------------------------------------------------------------------

diff --git a/man/systemd-quotacheck.service.xml b/man/systemd-quotacheck.service.xml
new file mode 100644 (file)
index 0000000..4d0218b
--- /dev/null
+++ b/man/systemd-quotacheck.service.xml
@@ -0,0 +1,102 @@
+<?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-quotacheck.service">
+
+        <refentryinfo>
+                <title>systemd-quotacheck.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-quotacheck.service</refentrytitle>
+                <manvolnum>8</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd-quotacheck.service</refname>
+                <refname>systemd-quotacheck</refname>
+                <refpurpose>File system quota checker logic</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>systemd-quotacheck.service</filename></para>
+                <para><filename>/usr/lib/systemd/systemd-quotacheck</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><filename>systemd-quotacheck.service</filename>
+                is a service responsible for file system quota
+                checks. It is run once at boot after all necessary
+                file systems are mounted. It is pulled in only if at
+                least one file system has quotas enabled.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>Kernel Command Line</title>
+
+                <para><filename>systemd-quotacheck</filename> understands
+                one kernel command line parameter:</para>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><varname>quotacheck.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 quota checks are done
+                                when the file system quota checker
+                                deems them
+                                necessary. <literal>force</literal>
+                                unconditionally results in full file
+                                system quota
+                                checks. <literal>skip</literal> skips
+                                any file system quota
+                                checks.</para></listitem>
+                        </varlistentry>
+                </variablelist>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>quotacheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>

diff --git a/units/systemd-quotacheck.service.in b/units/systemd-quotacheck.service.in
index d3343df2645e43b07b85620c8ca65d0d824725c7..319a3ced48c3da12df7d42d9ae4b819fd97c5916 100644 (file)
--- a/units/systemd-quotacheck.service.in
+++ b/units/systemd-quotacheck.service.in
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=File System Quota Check
+Documentation=man:systemd-quotacheck.service(8)
 DefaultDependencies=no
 After=systemd-readahead-collect.service systemd-readahead-replay.service systemd-remount-fs.service
 Before=local-fs.target shutdown.target