<?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 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.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> <refpurpose>systemd mount configuration files</refpurpose> </refnamediv> <refsynopsisdiv> <para><filename>systemd.mount</filename></para> </refsynopsisdiv> <refsect1> <title>Description</title> <para>A unit configuration file whose name ends in <filename>.mount</filename> encodes information about a file system mount point controlled and supervised by systemd.</para> <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 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, which define the execution environment the <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> binary is executed in.</para> <para>Mount units must be named after the mount point directories they control. Example: the mount point <filename>/home/lennart</filename> must be configured in a unit file <filename>home-lennart.mount</filename>. For details about the escaping logic used to convert a file system path to a unit name see <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> <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> <para>If an mount point is beneath another mount point in the file system hierarchy, a dependency between both units is created automatically.</para> <para>Mount points created at runtime independent on unit files or <filename>/etc/fstab</filename> will be monitored by systemd and appear like any other mount unit in systemd.</para> </refsect1> <refsect1> <title><filename>/etc/fstab</filename></title> <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> for details). Mounts listed in <filename>/etc/fstab</filename> will be converted into native units dynamically at boot and when the configuration of the system manager is reloaded. See <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details about the conversion.</para> <para>When reading <filename>/etc/fstab</filename> a few special mount options are understood by systemd which influence how dependencies are created for mount points from <filename>/etc/fstab</filename>. systemd will create a dependency of type <option>Wants</option> from either <filename>local-fs.target</filename> or <filename>remote-fs.target</filename>, depending whether the file system is local or remote. If <option>x-systemd.automount</option> is set, an automount unit will be created for the file system. See <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details. If <option>x-systemd.device-timeout=</option> is specified it may be used to 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 specifiy a unit as <literal>s</literal>, <literal>min</literal>, <literal>h</literal>, <literal>ms</literal>.</para> <para>If a mount point is configured in both <filename>/etc/fstab</filename> and a unit file, the configuration in the latter takes precedence.</para> </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 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The options specific to the [Mount] section of mount units are the following:</para> <variablelist> <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 device node, a dependency on the 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 the mount point is not existing at time of mounting, it is created. This string must be reflected in the unit file name. (See above.) This option is mandatory.</para></listitem> </varlistentry> <varlistentry> <term><varname>Type=</varname></term> <listitem><para>Takes a string for the filesystem type. See <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 when mounting. This takes a comma separated list of options. This setting is optional.</para></listitem> </varlistentry> <varlistentry> <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 these directories. Takes an access mode in octal notation. Defaults to 0755.</para></listitem> </varlistentry> <varlistentry> <term><varname>TimeoutSec=</varname></term> <listitem><para>Configures the time to wait for the mount command to finish. If a command does not exit within the configured time the mount will be considered failed and be shut down again. All commands still running will be terminated forcibly via SIGTERM, and after another delay of this time with SIGKILL. (See <option>KillMode=</option> below.) Takes a unit-less value in seconds, or a time span value such as "5min 20s". Pass 0 to disable the timeout logic. Defaults to 90s.</para></listitem> </varlistentry> <varlistentry> <term><varname>KillMode=</varname></term> <listitem><para>Specifies how processes of this mount shall be killed. One of <option>control-group</option>, <option>process</option>, <option>none</option>.</para> <para>This option is mostly equivalent to the <option>KillMode=</option> option of service files. See <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.</para></listitem> </varlistentry> <varlistentry> <term><varname>KillSignal=</varname></term> <listitem><para>Specifies which signal to use when killing a process of this mount. Defaults to SIGTERM. </para></listitem> </varlistentry> <varlistentry> <term><varname>SendSIGKILL=</varname></term> <listitem><para>Specifies whether to send SIGKILL to remaining processes after a timeout, if the normal shutdown procedure left processes of the mount around. Takes a boolean value. Defaults to "yes". </para></listitem> </varlistentry> </variablelist> </refsect1> <refsect1> <title>Compatibility Options</title> <para>The following option is also available in the <literal>[Mount]</literal> section, but exists purely for compatibility reasons and should not be used in newly written mount files.</para> <variablelist> <varlistentry> <term><varname>FsckPassNo=</varname></term> <listitem><para>The pass number for the file system checking service for this mount. See <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information on this setting. </para></listitem> </varlistentry> </variablelist> </refsect1> <refsect1> <title>See Also</title> <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <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>, <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> </refentry>