man/systemd-makefs@.service.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   4   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   5 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
   6 <refentry id="systemd-makefs@.service">
   7
   8   <refentryinfo>
   9     <title>systemd-makefs@.service</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>systemd-makefs@.service</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>systemd-makefs@.service</refname>
  20     <refname>systemd-mkswap@.service</refname>
  21     <refname>systemd-growfs@.service</refname>
  22     <refname>systemd-makefs</refname>
  23     <refname>systemd-growfs</refname>
  24     <refpurpose>Creating and growing file systems on demand</refpurpose>
  25   </refnamediv>
  26
  27   <refsynopsisdiv>
  28     <para><filename>systemd-makefs@<replaceable>device</replaceable>.service</filename></para>
  29     <para><filename>systemd-mkswap@<replaceable>device</replaceable>.service</filename></para>
  30     <para><filename>systemd-growfs@<replaceable>mountpoint</replaceable>.service</filename></para>
  31     <para><filename>/usr/lib/systemd/systemd-makefs</filename></para>
  32     <para><filename>/usr/lib/systemd/systemd-growfs</filename></para>
  33   </refsynopsisdiv>
  34
  35   <refsect1>
  36     <title>Description</title>
  37
  38     <para><filename>systemd-makefs@.service</filename>,
  39     <filename>systemd-mkswap@.service</filename>, and
  40     <filename>systemd-growfs@.service</filename> are used to implement the
  41     <option>x-systemd.makefs</option> and <option>x-systemd.growfs</option> options
  42     in <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  43     see <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
  44     They are instantiated for each device for which the file system or swap structure
  45     needs to be initialized, and for each mount point where the file system needs to
  46     be grown.</para>
  47
  48     <para>These services are started at boot, either right before or right after the
  49     mount point or swap device are used.</para>
  50
  51     <para><filename>systemd-makefs</filename> knows very little about specific file
  52     systems and swap devices, and after checking that the block device does not already
  53     contain a file system or other content, it will execute binaries specific to
  54     each filesystem type (<filename>/sbin/mkfs.<replaceable>type</replaceable></filename>
  55     or <filename>/sbin/mkswap</filename>).</para>
  56
  57     <para><filename>systemd-growfs</filename> knows very little about specific file
  58     systems and swap devices, and will instruct the kernel to grow the mounted
  59     filesystem to full size of the underlying block device. Nevertheless, it needs
  60     to know the
  61     <citerefentry project='man-pages'><refentrytitle>ioctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
  62     number specific to each file system, so only certain types are supported.
  63     Currently:
  64     <citerefentry project='man-pages'><refentrytitle>ext4</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  65     <citerefentry project='url'><refentrytitle url='https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs(5)'>btrfs</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  66     <citerefentry project='man-pages'><refentrytitle>xfs</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  67     <!-- yes, that's what the man page is called. -->
  68     and dm-crypt partitions (see
  69     <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>).
  70     </para>
  71
  72     <para>If the creation of a file system or swap device fails, the mount point or
  73     swap is failed too. If the growing of a file system fails, a warning is emitted.
  74     </para>
  75   </refsect1>
  76
  77   <refsect1>
  78     <title>See Also</title>
  79     <para>
  80       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  81       <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  82       <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  83       <citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  84       <citerefentry project='man-pages'><refentrytitle>mkfs.btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  85       <citerefentry project='man-pages'><refentrytitle>mkfs.cramfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  86       <citerefentry project='man-pages'><refentrytitle>mkfs.ext4</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  87       <citerefentry project='man-pages'><refentrytitle>mkfs.fat</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  88       <citerefentry project='man-pages'><refentrytitle>mkfs.hfsplus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  89       <citerefentry project='man-pages'><refentrytitle>mkfs.minix</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  90       <citerefentry project='man-pages'><refentrytitle>mkfs.ntfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  91       <citerefentry project='man-pages'><refentrytitle>mkfs.xfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  92     </para>
  93   </refsect1>
  94
  95 </refentry>