man: add docs for systemd-growfs and systemd-makefs

1 files changed, 120 insertions, 0 deletions

diff --git a/man/systemd-makefs@.service.xml b/man/systemd-makefs@.service.xml
new file mode 100644
index 0000000000..073c52fafe
--- /dev/null
+++ b/man/systemd-makefs@.service.xml
@@ -0,0 +1,120 @@
+<?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">
+<!--
+  SPDX-License-Identifier: LGPL-2.1+
+
+  This file is part of systemd.
+
+  Copyright 2017 Zbigniew Jędrzejewski-Szmek
+
+  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-makefs@.service">
+
+  <refentryinfo>
+    <title>systemd-makefs@.service</title>
+    <productname>systemd</productname>
+
+    <authorgroup>
+      <author>
+        <contrib>Developer</contrib>
+        <firstname>Zbigniew</firstname>
+        <surname>Jędrzejewski-Szmek</surname>
+        <email>zbyszek@in.waw.pl</email>
+      </author>
+    </authorgroup>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>systemd-makefs@.service</refentrytitle>
+    <manvolnum>8</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>systemd-makefs@.service</refname>
+    <refname>systemd-makeswap@.service</refname>
+    <refname>systemd-growfs@.service</refname>
+    <refname>systemd-makefs</refname>
+    <refname>systemd-growfs</refname>
+    <refpurpose>Creating and growing file systems on demand</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <para><filename>systemd-makefs@<replaceable>device</replaceable>.service</filename></para>
+    <para><filename>systemd-makeswap@<replaceable>device</replaceable>.service</filename></para>
+    <para><filename>systemd-growfs@<replaceable>mountpoint</replaceable>.service</filename></para>
+    <para><filename>/usr/lib/systemd/systemd-makefs</filename></para>
+    <para><filename>/usr/lib/systemd/systemd-growfs</filename></para>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para><filename>systemd-makefs@.service</filename>,
+    <filename>systemd-makeswap@.service</filename>, and
+    <filename>systemd-growfs@.service</filename> are used to implement the
+    <option>x-systemd.makefs</option> and <option>x-systemd.growfs</option> options
+    in <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+    see <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+    They are instantiated for each device for which the file system or swap structure
+    needs to be initalized, and for each mount point where the file system needs to
+    be grown.</para>
+
+    <para>These services are started at boot, either right before or right after the
+    mount point or swap device are used.</para>
+
+    <para><filename>systemd-makefs</filename> knows very little about specific file
+    systems and swap devices, and after checking that the block device does not already
+    contain a file system or other content, it will execute binaries specific to
+    each filesystem type (<filename>/sbin/mkfs.*</filename>).</para>
+
+    <para><filename>systemd-growfs</filename> knows very little about specific file
+    systems and swap devices, and will instruct the kernel to grow the mounted
+    filesystem to full size of the underlying block device. Nevertheless, it needs
+    to know the
+    <citerefentry project='man-pages'><refentrytitle>ioctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+    number specific to each file system, so only certain types are supported.
+    Currently:
+    <citerefentry project='man-pages'><refentrytitle>ext4</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+    btrfs (see
+    <citerefentry project='man-pages'><refentrytitle>btrfs-man5</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
+    <!-- yes, that's what the man page is called. -->
+    and dm-crypt partitions (see
+    <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>).
+    </para>
+
+    <para>If the creation of a file system or swap device fails, the mount point or
+    swap is failed too. If the growing of a file system fails, a warning is emitted.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>See Also</title>
+    <para>
+      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>mkfs.btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>mkfs.cramfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>mkfs.ext4</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>mkfs.fat</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>mkfs.hfsplus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>mkfs.minix</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>mkfs.ntfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry project='man-pages'><refentrytitle>mkfs.xfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    </para>
+  </refsect1>
+
+</refentry>