summaryrefslogtreecommitdiffstats
path: root/man/systemd.mount.xml
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--man/systemd.mount.xml119
1 files changed, 64 insertions, 55 deletions
diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml
index c2e470e..d061736 100644
--- a/man/systemd.mount.xml
+++ b/man/systemd.mount.xml
@@ -1,6 +1,6 @@
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="systemd.mount" xmlns:xi="http://www.w3.org/2001/XInclude">
@@ -82,7 +82,7 @@
for kernel-to-userspace and userspace-to-userspace interfaces. Some
of them may not be changed via mount units, and cannot be
disabled. For a longer discussion see <ulink
- url="https://www.freedesktop.org/wiki/Software/systemd/APIFileSystems">API
+ url="https://systemd.io/API_FILE_SYSTEMS">API
File Systems</ulink>.</para>
<para>The
@@ -104,19 +104,18 @@
system hierarchy, both a requirement dependency and an ordering
dependency between both units are created automatically.</para></listitem>
- <listitem><para>Block device backed file systems automatically gain
- <varname>BindsTo=</varname> and <varname>After=</varname> type
- dependencies on the device unit encapsulating the block
- device (see below).</para></listitem>
+ <listitem><para>Block device backed file systems automatically gain <varname>Requires=</varname>,
+ <varname>StopPropagatedFrom=</varname>, and <varname>After=</varname> type dependencies on the
+ device unit encapsulating the block device (see <varname>x-systemd.device-bound=</varname> for details).
+ </para></listitem>
- <listitem><para>If traditional file system quota is enabled for a mount
- unit, automatic <varname>Wants=</varname> and
- <varname>Before=</varname> dependencies on
- <filename>systemd-quotacheck.service</filename> and
- <filename>quotaon.service</filename> are added.</para></listitem>
+ <listitem><para>If traditional file system quota is enabled for a mount unit, automatic
+ <varname>Wants=</varname> and <varname>Before=</varname> dependencies on
+ <filename>systemd-quotacheck.service</filename> and <filename>quotaon.service</filename>
+ are added.</para></listitem>
- <listitem><para>Additional implicit dependencies may be added as result of
- execution and resource control parameters as documented in
+ <listitem><para>Additional implicit dependencies may be added as result of execution and
+ resource control parameters as documented in
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
and
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
@@ -135,15 +134,20 @@
<listitem><para>Mount units referring to local file systems automatically gain
an <varname>After=</varname> dependency on <filename>local-fs-pre.target</filename>, and a
- <varname>Before=</varname> dependency on <filename>local-fs.target</filename> unless
- <option>nofail</option> mount option is set.</para></listitem>
-
- <listitem><para>Network mount units
- automatically acquire <varname>After=</varname> dependencies on <filename>remote-fs-pre.target</filename>,
- <filename>network.target</filename> and <filename>network-online.target</filename>, and gain a
- <varname>Before=</varname> dependency on <filename>remote-fs.target</filename> unless
- <option>nofail</option> mount option is set. Towards the latter a
- <varname>Wants=</varname> unit is added as well.</para></listitem>
+ <varname>Before=</varname> dependency on <filename>local-fs.target</filename> unless one or more
+ mount options among <option>nofail</option>, <option>x-systemd.wanted-by=</option>,
+ and <option>x-systemd.required-by=</option> is set. See below for detailed information.</para>
+
+ <para>Additionally, an <varname>After=</varname> dependency on <filename>swap.target</filename>
+ is added when the file system type is <literal>tmpfs</literal>.</para>
+ </listitem>
+
+ <listitem><para>Network mount units automatically acquire <varname>After=</varname> dependencies on
+ <filename>remote-fs-pre.target</filename>, <filename>network.target</filename>,
+ plus <varname>After=</varname> and <varname>Wants=</varname> dependencies on <filename>network-online.target</filename>,
+ and a <varname>Before=</varname> dependency on <filename>remote-fs.target</filename>, unless
+ one or more mount options among <option>nofail</option>, <option>x-systemd.wanted-by=</option>,
+ and <option>x-systemd.required-by=</option> is set.</para></listitem>
</itemizedlist>
<para>Mount units referring to local and network file systems are distinguished by their file system type
@@ -241,13 +245,13 @@
<term><option>x-systemd.wanted-by=</option></term>
<term><option>x-systemd.required-by=</option></term>
- <listitem><para>In the created mount unit, configures a
- <varname>WantedBy=</varname> or <varname>RequiredBy=</varname>
- dependency on another unit. This option may be
- specified more than once. If this is specified, the normal
- automatic dependencies on the created mount unit, e.g.,
- <filename>local-fs.target</filename>, are not automatically
- created. See <varname>WantedBy=</varname> and <varname>RequiredBy=</varname> in
+ <listitem><para>In the created mount unit, configures a <varname>WantedBy=</varname> or
+ <varname>RequiredBy=</varname> dependency on another unit. This option may be specified more than once.
+ If this is specified, the default dependencies (see above) other than <filename>umount.target</filename>
+ on the created mount unit, e.g. <filename>local-fs.target</filename>, are not automatically created.
+ Hence it is likely that some ordering dependencies need to be set up manually through
+ <option>x-systemd.before=</option> and <option>x-systemd.after=</option>. See <varname>WantedBy=</varname>
+ and <varname>RequiredBy=</varname> in
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details.</para>
@@ -255,13 +259,14 @@
</varlistentry>
<varlistentry>
+ <term><option>x-systemd.wants-mounts-for=</option></term>
<term><option>x-systemd.requires-mounts-for=</option></term>
<listitem><para>Configures a
- <varname>RequiresMountsFor=</varname> dependency between the
- created mount unit and other mount units. The argument must be
- an absolute path. This option may be specified more than once.
- See <varname>RequiresMountsFor=</varname> in
+ <varname>RequiresMountsFor=</varname> or <varname>WantsMountsFor=</varname>
+ dependency between the created mount unit and other mount units. The
+ argument must be an absolute path. This option may be specified more than
+ once. See <varname>RequiresMountsFor=</varname> or <varname>WantsMountsFor=</varname> in
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details.</para>
@@ -501,9 +506,9 @@
information about the file system mount points it supervises. A
number of options that may be used in this section are shared with
other unit types. These options are documented in
- <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- and
- <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+ <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry> and
+ <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
The options specific to the [Mount] section of mount units are the
following:</para>
@@ -511,8 +516,8 @@
<varlistentry>
<term><varname>What=</varname></term>
- <listitem><para>Takes an absolute path of a device node, file or other resource to mount. See
- <citerefentry
+ <listitem><para>Takes an absolute path or a fstab-style identifier of a device node, file or
+ other resource to mount. See <citerefentry
project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> for
details. If this refers to a device node, a dependency on the respective device unit is automatically
created. (See
@@ -537,7 +542,11 @@
<term><varname>Type=</varname></term>
<listitem><para>Takes a string for the file system type. See
<citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
- for details. This setting is optional.</para></listitem>
+ for details. This setting is optional.</para>
+
+ <para>If the type is <literal>overlay</literal>, and <literal>upperdir=</literal> or
+ <literal>workdir=</literal> are specified as options and they don't exist, they will be created.
+ </para></listitem>
</varlistentry>
<varlistentry>
@@ -637,22 +646,22 @@
<refsect1>
<title>See Also</title>
- <para>
- <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd-mount</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- </para>
+ <para><simplelist type="inline">
+ <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry project='man-pages'><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd-mount</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+ </simplelist></para>
</refsect1>
</refentry>