man: document systemd-remount-fs.service

3 files changed, 92 insertions, 2 deletions

diff --git a/Makefile.am b/Makefile.am
index ca676e588e..09ea5ecdbb 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -487,7 +487,8 @@ MANPAGES = \
 	man/journald.conf.5 \
 	man/systemd-journald.service.8 \
 	man/journalctl.1 \
-	man/systemd-inhibit.1
+	man/systemd-inhibit.1 \
+	man/systemd-remount-fs.service.8
 
 MANPAGES_ALIAS = \
 	man/reboot.8 \
@@ -495,7 +496,8 @@ MANPAGES_ALIAS = \
 	man/init.1 \
 	man/systemd-modules-load.8 \
 	man/systemd-sysctl.8 \
-	man/systemd-journald.8
+	man/systemd-journald.8 \
+	man/systemd-remount-fs.8
 
 man/reboot.8: man/halt.8
 man/poweroff.8: man/halt.8
@@ -503,6 +505,7 @@ man/init.1: man/systemd.1
 man/systemd-modules-load.8: man/systemd-modules-load.service.8
 man/systemd-sysctl.8: man/systemd-sysctl.service.8
 man/systemd-journald.8: man/systemd-journald.service.8
+man/systemd-remount-fs.8: man/systemd-remount-fs.service.8
 
 XML_FILES = \
 	${patsubst %.1,%.xml,${patsubst %.3,%.xml,${patsubst %.5,%.xml,${patsubst %.7,%.xml,${patsubst %.8,%.xml,$(MANPAGES)}}}}}
diff --git a/man/systemd-remount-fs.service.xml b/man/systemd-remount-fs.service.xml
new file mode 100644
index 0000000000..fa3b009670
--- /dev/null
+++ b/man/systemd-remount-fs.service.xml
@@ -0,0 +1,86 @@
+<?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-remount-fs.service">
+
+        <refentryinfo>
+                <title>systemd-remount-fs.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-remount-fs.service</refentrytitle>
+                <manvolnum>8</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>systemd-remount-fs.service</refname>
+                <refname>systemd-remount-fs</refname>
+                <refpurpose>Remount Root and Kernel File Systems</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>systemd-remount-fs.service</filename></para>
+                <para><filename>/usr/lib/systemd/systemd-remount-fs</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para><filename>systemd-remount-fs.service</filename>
+                is an early-boot service that applies mount options
+                listed in
+                <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                to the root file system and the kernel API virtual
+                file systems. This is required so that the mount
+                options of these file systems -- which are pre-mounted
+                by the kernel, the initial RAM disk or system manager
+                code -- are updated to those listed in
+                <filename>/etc/fstab</filename>. This service ignores
+                normal file systems and only changes the root file
+                system (i.e. <filename>/</filename>) and the virtual
+                kernel API file systems such as
+                <filename>/proc</filename>, <filename>/sys</filename>
+                or <filename>/dev/</filename>. This service executes
+                no operation if <filename>/etc/fstab</filename> does
+                not exist or lists no entries for the root file system
+                or the kernel API VFS.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>See Also</title>
+                <para>
+                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+                </para>
+        </refsect1>
+
+</refentry>
diff --git a/units/systemd-remount-fs.service.in b/units/systemd-remount-fs.service.in
index 5074ab5ddc..0524de82cd 100644
--- a/units/systemd-remount-fs.service.in
+++ b/units/systemd-remount-fs.service.in
@@ -7,6 +7,7 @@
 
 [Unit]
 Description=Remount Root and Kernel File Systems
+Documentation=man:systemd-remount-fs.service(8)
 DefaultDependencies=no
 Conflicts=shutdown.target
 After=systemd-readahead-collect.service systemd-readahead-replay.service fsck-root.service