systemd.mount.xml revision e0cabd4bb536bce3a9636a12b8dbc512c28c2395
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye This file is part of systemd.
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye Copyright 2010 Lennart Poettering
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye systemd is free software; you can redistribute it and/or modify it
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye under the terms of the GNU General Public License as published by
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye the Free Software Foundation; either version 2 of the License, or
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye (at your option) any later version.
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye systemd is distributed in the hope that it will be useful, but
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye WITHOUT ANY WARRANTY; without even the implied warranty of
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye General Public License for more details.
fe80b749cd764b1f0f72b2f913b1fe10581911c3Knut Anders Hatlen You should have received a copy of the GNU General Public License
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye along with systemd; If not, see <http://www.gnu.org/licenses/>.
d4ce228a333ba2daa19ad8b0672a704c8e42a2dcTrond Norbye <refentryinfo>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <authorgroup>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye </authorgroup>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye </refentryinfo>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <refnamediv>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <refpurpose>systemd mount configuration files</refpurpose>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye </refnamediv>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <refsynopsisdiv>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <para><filename>systemd.mount</filename></para>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye </refsynopsisdiv>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <para>A unit configuration file whose name ends in
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <filename>.mount</filename> encodes information about
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye a file system mount point controlled and supervised by
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye systemd.</para>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <para>This man page lists the configuration options
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye specific to this unit type. See
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye for the common options of all unit configuration
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye files. The common configuration items are configured
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye in the generic [Unit] and [Install] sections. The
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye mount specific configuration options are configured
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye in the [Mount] section.</para>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <para>Additional options are listed in
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <para>Mount units must be named after the mount point
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye directories they control. Example: the mount point
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <filename>/home/lennart</filename> must be configured
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye in a unit file
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <filename>home-lennart.mount</filename>. For details
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye about the escaping logic used to convert a file system
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye path to a unit name see
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <para>Optionally, a mount unit may be accompanied by
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye an automount unit, to allow on-demand or parallelized
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye mounting. See
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye <para>If an mount point is beneath another mount point
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye in the file system hierarchy a dependency between both
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye units is created automatically.</para>
7e33e87b7d6c9a61ff11d23e37c02274b1223ce1Jens Elkner <para>Mount units may either be configured via unit
7e33e87b7d6c9a61ff11d23e37c02274b1223ce1Jens Elkner files, or via <filename>/etc/fstab</filename> (see
c7eb123c8b2081a261deff3c401fbf92ddba1b58Jorgen Austvik <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
c7eb123c8b2081a261deff3c401fbf92ddba1b58Jorgen Austvik for details).</para>
945f4c3c36a15447913781dfb1894b34f2941c57Jorgen Austvik <para>When reading <filename>/etc/fstab</filename> a
5a0c5ad4116f5a4dd0dd5a0a4e6d02973cd5eef9Lubos Kosco few special mount options are understood by systemd
780cc7d1b57609ff15fb283201e93cb501ebe9e6Jorgen Austvik which influence how dependencies are created for mount
780cc7d1b57609ff15fb283201e93cb501ebe9e6Jorgen Austvik points from <filename>/etc/fstab</filename>. If
f754dd2bbc98a89a613ab4f76dad5534dc13e929Vladimir Kotal <option>comment=systemd.mount</option> is specified as
d3d2404f9a49bf70b124053feabe666f85ef5361Knut Anders Hatlen mount option then systemd will create a dependency of
5dd7583c971e0c2c9e99378930d83df43de56098Lubos Kosco <filename>remote-fs.target</filename>, depending
780cc7d1b57609ff15fb283201e93cb501ebe9e6Jorgen Austvik whether the file system is local or remote. If
7b9f9a1761f76744fc3772181877d5e301f122adKnut Anders Hatlen <option>comment=systemd.automount</option> is set, an
5a0c5ad4116f5a4dd0dd5a0a4e6d02973cd5eef9Lubos Kosco automount unit will be created for the file system. See
0466de7c67573e1ce5e0733325c1e5383270f5d5Knut Anders Hatlen <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
0466de7c67573e1ce5e0733325c1e5383270f5d5Knut Anders Hatlen for details.</para>
d4ce228a333ba2daa19ad8b0672a704c8e42a2dcTrond Norbye <para>If a mount point is configured in both
d4ce228a333ba2daa19ad8b0672a704c8e42a2dcTrond Norbye <filename>/etc/fstab</filename> and a unit file the
5a0c5ad4116f5a4dd0dd5a0a4e6d02973cd5eef9Lubos Kosco configuration in the latter takes precedence.</para>
d4ce228a333ba2daa19ad8b0672a704c8e42a2dcTrond Norbye <para>Mount files must include a [Mount] section,
d4ce228a333ba2daa19ad8b0672a704c8e42a2dcTrond Norbye which carries information about the file system mount points it
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco supervises. A number of options that may be used in
7ecd52b03dc1f0b03ff8f522b4891c8531896c3dJorgen Austvik this section are shared with other unit types. These
7ecd52b03dc1f0b03ff8f522b4891c8531896c3dJorgen Austvik options are documented in
7ecd52b03dc1f0b03ff8f522b4891c8531896c3dJorgen Austvik <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
c7eb123c8b2081a261deff3c401fbf92ddba1b58Jorgen Austvik options specific to the [Mount] section of mount
5a0c5ad4116f5a4dd0dd5a0a4e6d02973cd5eef9Lubos Kosco units are the following:</para>
7ecd52b03dc1f0b03ff8f522b4891c8531896c3dJorgen Austvik <variablelist>
49f592091468eac515dde6139fbc8efa26056b0aJorgen Austvik <varlistentry>
49f592091468eac515dde6139fbc8efa26056b0aJorgen Austvik of a device node, file or other
49f592091468eac515dde6139fbc8efa26056b0aJorgen Austvik resource to mount. See
945f4c3c36a15447913781dfb1894b34f2941c57Jorgen Austvik <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
945f4c3c36a15447913781dfb1894b34f2941c57Jorgen Austvik for details. If this refers to a
5a0c5ad4116f5a4dd0dd5a0a4e6d02973cd5eef9Lubos Kosco device node a dependency on the
945f4c3c36a15447913781dfb1894b34f2941c57Jorgen Austvik respective device unit is
945f4c3c36a15447913781dfb1894b34f2941c57Jorgen Austvik automatically created. (See
945f4c3c36a15447913781dfb1894b34f2941c57Jorgen Austvik <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.)
b411dcdf67df825303fcb366759169c881936ac9Vladimir Kotal This option is
b411dcdf67df825303fcb366759169c881936ac9Vladimir Kotal </varlistentry>
b411dcdf67df825303fcb366759169c881936ac9Vladimir Kotal <varlistentry>
b411dcdf67df825303fcb366759169c881936ac9Vladimir Kotal of a directory of the mount point. If
b411dcdf67df825303fcb366759169c881936ac9Vladimir Kotal the mount point is not existing at
b411dcdf67df825303fcb366759169c881936ac9Vladimir Kotal time of mounting it is created. This
b411dcdf67df825303fcb366759169c881936ac9Vladimir Kotal string must be reflected in the unit
b411dcdf67df825303fcb366759169c881936ac9Vladimir Kotal file name. (See above.) This option is
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco </varlistentry>
f9fd2b96d1c5ea62664f74da0e34a04b6511a8ffLubos Kosco <varlistentry>
b34561d2c3d92fac37dbced05ba6a8738e3d20e9Lubos Kosco filesystem type. See
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco for details. This setting is
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco </varlistentry>
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco <varlistentry>
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco when mounting. This takes a comma
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco seperated list of options. This
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco </varlistentry>
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco <varlistentry>
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco points (and any parent directories)
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco are automatically created if
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco needed. This option specifies the file
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco system access mode used when creating
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco these directories. Defaults to
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco </varlistentry>
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco <varlistentry>
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco wait for the mount command to
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco finish. If a comand does not exit
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco within the configured time the mount
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco will be considered failed and be shut
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco down again. All commands still running
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco will be terminated forcibly via
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco SIGTERM, and after another delay of
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco this time with SIGKILL. (See
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco Takes a unit-less value in seconds, or
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco a time span value such as "5min
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco 20s". Pass 0 to disable the timeout
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Kosco logic. Defaults to
64b763950bf11e9357facbd2b5666631a895c085Trond Norbye </varlistentry>
a5cc1506d5c0704805c6733a46c7f1f8f91ae724Knut Anders Hatlen <varlistentry>
a5cc1506d5c0704805c6733a46c7f1f8f91ae724Knut Anders Hatlen <term><varname>KillMode=</varname></term>
a5cc1506d5c0704805c6733a46c7f1f8f91ae724Knut Anders Hatlen processes of this mount shall be
a5cc1506d5c0704805c6733a46c7f1f8f91ae724Knut Anders Hatlen killed. One of
9cf771c10c134cc953a502f895eaf321ec927f13Lubos Kosco <para>This option is mostly equivalent
7b046969a1b2565787df8ae3a8126359e8cd6fafTrond Norbye option of service files. See
7b046969a1b2565787df8ae3a8126359e8cd6fafTrond Norbye <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
9cf771c10c134cc953a502f895eaf321ec927f13Lubos Kosco </varlistentry>
a5cc1506d5c0704805c6733a46c7f1f8f91ae724Knut Anders Hatlen </variablelist>
0e633a1629c696cc57f02d620a8be7a118fd7956Vladimir Kotal <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
0e633a1629c696cc57f02d620a8be7a118fd7956Vladimir Kotal <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
0e633a1629c696cc57f02d620a8be7a118fd7956Vladimir Kotal <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
a5cc1506d5c0704805c6733a46c7f1f8f91ae724Knut Anders Hatlen <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
a5cc1506d5c0704805c6733a46c7f1f8f91ae724Knut Anders Hatlen <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
9cf771c10c134cc953a502f895eaf321ec927f13Lubos Kosco <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>