2010-07-02 02:29:15 +04:00
<?xml version='1.0'?> <!-- * - nxml - * -->
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
< !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 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
2012-04-12 02:20:58 +04:00
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
2010-07-02 02:29:15 +04:00
(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
2012-04-12 02:20:58 +04:00
Lesser General Public License for more details.
2010-07-02 02:29:15 +04:00
2012-04-12 02:20:58 +04:00
You should have received a copy of the GNU Lesser General Public License
2010-07-02 02:29:15 +04:00
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
<refentry id= "systemd.mount" >
<refentryinfo >
<title > systemd.mount</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.mount</refentrytitle>
<manvolnum > 5</manvolnum>
</refmeta>
<refnamediv >
<refname > systemd.mount</refname>
2012-07-16 20:08:25 +04:00
<refpurpose > Mount unit configuration</refpurpose>
2010-07-02 02:29:15 +04:00
</refnamediv>
<refsynopsisdiv >
2013-02-14 07:46:37 +04:00
<para > <filename > <replaceable > mount</replaceable> .mount</filename> </para>
2010-07-02 02:29:15 +04:00
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > A unit configuration file whose name ends in
2013-07-12 07:39:27 +04:00
<literal > .mount</literal> encodes information about
2010-07-02 03:17:55 +04:00
a file system mount point controlled and supervised by
systemd.</para>
2010-07-02 02:29:15 +04:00
<para > This man page lists the configuration options
specific to this unit type. See
<citerefentry > <refentrytitle > systemd.unit</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
for the common options of all unit configuration
files. The common configuration items are configured
in the generic [Unit] and [Install] sections. The
mount specific configuration options are configured
in the [Mount] section.</para>
<para > Additional options are listed in
2010-07-02 21:51:07 +04:00
<citerefentry > <refentrytitle > systemd.exec</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
which define the execution environment the
<citerefentry > <refentrytitle > mount</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
2012-07-20 01:47:10 +04:00
binary is executed in, and in
2013-07-10 09:25:02 +04:00
<citerefentry > <refentrytitle > systemd.kill</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
which define the way the processes are terminated, and
in
2013-09-27 02:05:07 +04:00
<citerefentry > <refentrytitle > systemd.resource-control</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
which configure resource control settings for the
2013-07-10 09:25:02 +04:00
processes of the service. Note that the User= and
Group= options are not particularly useful for mount
units specifying a <literal > Type=</literal> option or
using configuration not specified in
<filename > /etc/fstab</filename> ;
2012-11-23 21:44:49 +04:00
<citerefentry > <refentrytitle > mount</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
2013-08-25 11:01:45 +04:00
will refuse options that are not listed in
2012-11-23 21:44:49 +04:00
<filename > /etc/fstab</filename> if it is not run as
UID 0.</para>
2010-07-02 02:29:15 +04:00
2010-07-02 03:33:54 +04:00
<para > Mount units must be named after the mount point
directories they control. Example: the mount point
2013-05-03 08:55:20 +04:00
<filename noindex= 'true' > /home/lennart</filename> must be configured
2010-07-02 02:29:15 +04:00
in a unit file
<filename > home-lennart.mount</filename> . For details
about the escaping logic used to convert a file system
2013-12-26 05:47:44 +04:00
path to a unit name, see
2010-07-02 02:29:15 +04:00
<citerefentry > <refentrytitle > systemd.unit</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
2010-07-02 03:17:55 +04:00
<para > Optionally, a mount unit may be accompanied by
an automount unit, to allow on-demand or parallelized
mounting. See
<citerefentry > <refentrytitle > systemd.automount</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .</para>
2010-07-02 03:33:54 +04:00
2012-11-02 02:35:34 +04:00
<para > If a mount point is beneath another mount point
2010-07-02 11:51:25 +04:00
in the file system hierarchy, a dependency between both
2010-07-02 03:33:54 +04:00
units is created automatically.</para>
2010-07-02 04:38:30 +04:00
2013-01-15 08:10:50 +04:00
<para > Mount points created at runtime (independently of
unit files or <filename > /etc/fstab</filename> ) will be
2010-07-02 04:38:30 +04:00
monitored by systemd and appear like any other mount
2013-01-25 04:59:33 +04:00
unit in systemd.
See <filename > /proc/self/mountinfo</filename> description
in <citerefentry > <refentrytitle > proc</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .
</para>
2013-01-15 08:10:50 +04:00
<para > Some file systems have special semantics as API
file systems for kernel-to-userspace and
userspace-to-userpace interfaces. Some of them may not
be changed via mount units, and cannot be disabled.
For a longer discussion see <ulink
url="http://www.freedesktop.org/wiki/Software/systemd/APIFileSystems">API
File Systems</ulink> .</para>
2010-07-02 02:29:15 +04:00
</refsect1>
<refsect1 >
2012-02-09 04:20:09 +04:00
<title > <filename > /etc/fstab</filename> </title>
2010-07-02 02:29:15 +04:00
<para > Mount units may either be configured via unit
files, or via <filename > /etc/fstab</filename> (see
<citerefentry > <refentrytitle > fstab</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
2012-06-27 17:27:29 +04:00
for details). Mounts listed in
<filename > /etc/fstab</filename> will be converted into
native units dynamically at boot and when the
2013-12-26 08:20:57 +04:00
configuration of the system manager is reloaded. In
general, configuring mount points through
<filename > /etc/fstab</filename> is the preferred
approach. See
2012-06-27 17:27:29 +04:00
<citerefentry > <refentrytitle > systemd-fstab-generator</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
for details about the conversion.</para>
2010-07-02 02:29:15 +04:00
<para > When reading <filename > /etc/fstab</filename> a
few special mount options are understood by systemd
which influence how dependencies are created for mount
2012-05-22 04:00:53 +04:00
points from <filename > /etc/fstab</filename> . systemd
will create a dependency of type
2014-06-30 17:27:16 +04:00
<option > Wants</option> or <option > Requires</option>
(see option <option > nofail</option> below), from
either <filename > local-fs.target</filename> or
2010-07-02 02:29:15 +04:00
<filename > remote-fs.target</filename> , depending
2014-06-30 17:27:16 +04:00
whether the file system is local or remote.</para>
<variablelist class= 'fstab-options' >
<varlistentry >
<term > <option > x-systemd.automount</option> </term>
<listitem > <para > An automount unit will be created
for the file system. See
<citerefentry > <refentrytitle > systemd.automount</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
for details.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > x-systemd.device-timeout=</option> </term>
<listitem > <para > Configure how long systemd should
wait for a device to show up before giving up on
an entry from
<filename > /etc/fstab</filename> . Specify a time in
seconds or explicitly append a unit as
<literal > s</literal> , <literal > min</literal> ,
<literal > h</literal> ,
<literal > ms</literal> .</para>
<para > Note that this option can only be used in
<filename > /etc/fstab</filename> , and will be
ignored when part of <varname > Options=</varname>
setting in a unit file.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <option > nofail</option> </term>
<term > <option > fail</option> </term>
<listitem > <para > With <option > nofail</option> this
mount will be only wanted, not required, by the
<filename > local-fs.target</filename> . This means
that the boot will continue even if this mount
point is not mounted successfully. Option
<option > fail</option> has the opposite meaning and
is the default.</para>
</listitem>
</varlistentry>
<varlistentry >
<term > <option > noauto</option> </term>
<term > <option > auto</option> </term>
<listitem > <para > With <option > noauto</option> , this
mount will not be added as a dependency for
<filename > local-fs.target</filename> . This means
that it will not be mounted automatically during
boot, unless it is pulled in by some other
unit. Option <option > auto</option> has the
opposite meaning and is the default.</para>
</listitem>
</varlistentry>
</variablelist>
2013-12-26 08:20:57 +04:00
2010-07-02 02:29:15 +04:00
<para > If a mount point is configured in both
2013-01-15 21:10:11 +04:00
<filename > /etc/fstab</filename> and a unit file that
2013-09-12 23:12:49 +04:00
is stored below <filename > /usr</filename> , the former
2013-01-15 21:10:11 +04:00
will take precedence. If the unit file is stored below
2013-09-12 23:12:49 +04:00
<filename > /etc</filename> , it will take
2013-01-15 21:10:11 +04:00
precedence. This means: native unit files take
precedence over traditional configuration files, but
this is superseded by the rule that configuration in
<filename > /etc</filename> will always take precedence
over configuration in
<filename > /usr</filename> .</para>
2010-07-02 02:29:15 +04:00
</refsect1>
<refsect1 >
<title > Options</title>
<para > Mount files must include a [Mount] section,
which carries 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
2012-07-20 01:47:10 +04:00
<citerefentry > <refentrytitle > systemd.exec</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
and
<citerefentry > <refentrytitle > systemd.kill</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> . The
2010-07-02 03:17:55 +04:00
options specific to the [Mount] section of mount
2010-07-02 02:29:15 +04:00
units are the following:</para>
2013-01-26 19:47:16 +04:00
<variablelist class= 'unit-directives' >
2010-07-02 02:29:15 +04:00
<varlistentry >
<term > <varname > What=</varname> </term>
<listitem > <para > Takes an absolute path
of a device node, file or other
resource to mount. See
<citerefentry > <refentrytitle > mount</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
for details. If this refers to a
2010-07-02 11:51:25 +04:00
device node, a dependency on the
2010-07-02 02:29:15 +04:00
respective device unit is
automatically created. (See
<citerefentry > <refentrytitle > systemd.device</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> for more information.)
This option is
mandatory.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > Where=</varname> </term>
<listitem > <para > Takes an absolute path
of a directory of the mount point. If
2012-11-02 02:35:34 +04:00
the mount point does not exist at the
2010-07-02 11:51:25 +04:00
time of mounting, it is created. This
2010-07-02 02:29:15 +04:00
string must be reflected in the unit
2013-06-27 23:51:44 +04:00
filename. (See above.) This option is
2010-07-02 02:29:15 +04:00
mandatory.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > Type=</varname> </term>
<listitem > <para > Takes a string for the
2013-06-27 23:51:44 +04:00
file system type. See
2010-07-02 02:29:15 +04:00
<citerefentry > <refentrytitle > mount</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
for details. This setting is
optional.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > Options=</varname> </term>
<listitem > <para > Mount options to use
2013-06-27 23:51:44 +04:00
when mounting. This takes a
comma-separated list of options. This
2010-07-02 02:29:15 +04:00
setting is optional.</para> </listitem>
</varlistentry>
<varlistentry >
2014-06-16 03:02:27 +04:00
<term > <varname > SloppyOptions=</varname> </term>
<listitem > <para > Takes a boolean
2014-06-28 02:48:28 +04:00
argument. If true, parsing of the
2014-06-16 03:02:27 +04:00
options specified in
<varname > Options=</varname> is
relaxed, and unknown mount options are
tolerated. This corresponds with
<citerefentry > <refentrytitle > mount</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> 's
<parameter > -s</parameter>
switch. Defaults to
off.</para> </listitem>
</varlistentry>
<varlistentry >
2010-07-02 02:29:15 +04:00
<term > <varname > DirectoryMode=</varname> </term>
<listitem > <para > Directories of mount
points (and any parent directories)
are automatically created if
needed. This option specifies the file
system access mode used when creating
2010-07-03 01:24:38 +04:00
these directories. Takes an access
mode in octal notation. Defaults to
2010-07-02 02:29:15 +04:00
0755.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <varname > TimeoutSec=</varname> </term>
<listitem > <para > Configures the time to
wait for the mount command to
2010-07-02 11:51:25 +04:00
finish. If a command does not exit
2013-06-27 23:51:44 +04:00
within the configured time, the mount
2010-07-02 02:29:15 +04:00
will be considered failed and be shut
down again. All commands still running
will be terminated forcibly via
2013-06-29 20:09:14 +04:00
<constant > SIGTERM</constant> , and after another delay of
this time with <constant > SIGKILL</constant> . (See
2012-07-20 01:47:10 +04:00
<option > KillMode=</option> in
<citerefentry > <refentrytitle > systemd.kill</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> .)
2010-07-02 02:29:15 +04:00
Takes a unit-less value in seconds, or
a time span value such as "5min
20s". Pass 0 to disable the timeout
2013-11-07 04:17:48 +04:00
logic. The default value is set from the manager configuration
file's <varname > DefaultTimeoutStart=</varname> variable.</para> </listitem>
2010-07-02 02:29:15 +04:00
</varlistentry>
2012-05-30 23:42:07 +04:00
</variablelist>
2012-07-20 01:47:10 +04:00
<para > Check
<citerefentry > <refentrytitle > systemd.exec</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
and
<citerefentry > <refentrytitle > systemd.kill</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry>
for more settings.</para>
2012-05-30 23:42:07 +04:00
</refsect1>
2010-07-02 02:29:15 +04:00
<refsect1 >
<title > See Also</title>
<para >
2010-07-07 03:38:56 +04:00
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2010-07-02 02:29:15 +04:00
<citerefentry > <refentrytitle > systemctl</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.unit</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.exec</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
2012-07-20 01:47:10 +04:00
<citerefentry > <refentrytitle > systemd.kill</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
2013-09-27 02:05:07 +04:00
<citerefentry > <refentrytitle > systemd.resource-control</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
2012-05-23 06:11:29 +04:00
<citerefentry > <refentrytitle > systemd.service</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
2010-07-02 02:29:15 +04:00
<citerefentry > <refentrytitle > systemd.device</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
2013-01-25 04:59:33 +04:00
<citerefentry > <refentrytitle > proc</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ,
2012-06-27 17:27:29 +04:00
<citerefentry > <refentrytitle > mount</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> ,
2013-01-15 07:08:33 +04:00
<citerefentry > <refentrytitle > systemd-fstab-generator</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > systemd.directives</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry>
2010-07-02 02:29:15 +04:00
</para>
</refsect1>
</refentry>
