[thirdparty/systemd.git] / man / systemd.mount.xml

<?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 General Public License as published by
  the Free Software Foundation; either version 2 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
  General Public License for more details.

  You should have received a copy of the GNU 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>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).</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>. If
                <option>comment=systemd.mount</option> is specified as
                mount option, then 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>comment=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.</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
                                seperated 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
                                60s.</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-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>
                </variablelist>
        </refsect1>

        <refsect1>
                  <title>See Also</title>
                  <para>
                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</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.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                          <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                  </para>
        </refsect1>

</refentry>
Commit	Line	Data
cdb788e4 LP	1	<?xml version='1.0'?> <!---nxml--->
	2	<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
	3	<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
	4	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
	5
	6	<!--
	7	This file is part of systemd.
	8
	9	Copyright 2010 Lennart Poettering
	10
	11	systemd is free software; you can redistribute it and/or modify it
	12	under the terms of the GNU General Public License as published by
	13	the Free Software Foundation; either version 2 of the License, or
	14	(at your option) any later version.
	15
	16	systemd is distributed in the hope that it will be useful, but
	17	WITHOUT ANY WARRANTY; without even the implied warranty of
	18	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	19	General Public License for more details.
	20
	21	You should have received a copy of the GNU General Public License
	22	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	23	-->
	24
	25	<refentry id="systemd.mount">
	26	<refentryinfo>
	27	<title>systemd.mount</title>
	28	<productname>systemd</productname>
	29
	30	<authorgroup>
	31	<author>
	32	<contrib>Developer</contrib>
	33	<firstname>Lennart</firstname>
	34	<surname>Poettering</surname>
	35	<email>lennart@poettering.net</email>
	36	</author>
	37	</authorgroup>
	38	</refentryinfo>
	39
	40	<refmeta>
	41	<refentrytitle>systemd.mount</refentrytitle>
	42	<manvolnum>5</manvolnum>
	43	</refmeta>
	44
	45	<refnamediv>
	46	<refname>systemd.mount</refname>
	47	<refpurpose>systemd mount configuration files</refpurpose>
	48	</refnamediv>
	49
	50	<refsynopsisdiv>
	51	<para><filename>systemd.mount</filename></para>
	52	</refsynopsisdiv>
	53
	54	<refsect1>
	55	<title>Description</title>
	56
	57	<para>A unit configuration file whose name ends in
65232ea7 LP	58	<filename>.mount</filename> encodes information about
	59	a file system mount point controlled and supervised by
	60	systemd.</para>
cdb788e4 LP	61
	62	<para>This man page lists the configuration options
	63	specific to this unit type. See
	64	<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
	65	for the common options of all unit configuration
	66	files. The common configuration items are configured
	67	in the generic [Unit] and [Install] sections. The
	68	mount specific configuration options are configured
	69	in the [Mount] section.</para>
	70
	71	<para>Additional options are listed in
ba60f905 LP	72	<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	73	which define the execution environment the
	74	<citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	75	binary is executed in.</para>
cdb788e4	76
e0cabd4b LP	77	<para>Mount units must be named after the mount point
e0cabd4b LP	78	directories they control. Example: the mount point
cdb788e4 LP	79	<filename>/home/lennart</filename> must be configured
	80	in a unit file
	81	<filename>home-lennart.mount</filename>. For details
	82	about the escaping logic used to convert a file system
	83	path to a unit name see
	84	<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
65232ea7 LP	85
	86	<para>Optionally, a mount unit may be accompanied by
	87	an automount unit, to allow on-demand or parallelized
	88	mounting. See
	89	<citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
e0cabd4b LP	90
e0cabd4b LP	91	<para>If an mount point is beneath another mount point
b439c6ee	92	in the file system hierarchy, a dependency between both
e0cabd4b	93	units is created automatically.</para>
b36b082c LP	94
	95	<para>Mount points created at runtime independent on
	96	unit files or <filename>/etc/fstab</filename> will be
	97	monitored by systemd and appear like any other mount
	98	unit in systemd.</para>
cdb788e4 LP	99	</refsect1>
	100
	101	<refsect1>
	102	<title><filename>fstab</filename></title>
	103
	104	<para>Mount units may either be configured via unit
	105	files, or via <filename>/etc/fstab</filename> (see
	106	<citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
	107	for details).</para>
	108
	109	<para>When reading <filename>/etc/fstab</filename> a
	110	few special mount options are understood by systemd
	111	which influence how dependencies are created for mount
	112	points from <filename>/etc/fstab</filename>. If
	113	<option>comment=systemd.mount</option> is specified as
b439c6ee	114	mount option, then systemd will create a dependency of
cdb788e4 LP	115	type <option>Wants</option> from either
	116	<filename>local-fs.target</filename> or
	117	<filename>remote-fs.target</filename>, depending
	118	whether the file system is local or remote. If
	119	<option>comment=systemd.automount</option> is set, an
	120	automount unit will be created for the file system. See
	121	<citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
	122	for details.</para>
	123
	124	<para>If a mount point is configured in both
b439c6ee	125	<filename>/etc/fstab</filename> and a unit file, the
cdb788e4 LP	126	configuration in the latter takes precedence.</para>
	127	</refsect1>
	128
	129	<refsect1>
	130	<title>Options</title>
	131
	132	<para>Mount files must include a [Mount] section,
	133	which carries information about the file system mount points it
	134	supervises. A number of options that may be used in
	135	this section are shared with other unit types. These
	136	options are documented in
	137	<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
65232ea7	138	options specific to the [Mount] section of mount
cdb788e4 LP	139	units are the following:</para>
	140
	141	<variablelist>
	142
	143	<varlistentry>
	144	<term><varname>What=</varname></term>
	145	<listitem><para>Takes an absolute path
	146	of a device node, file or other
	147	resource to mount. See
	148	<citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	149	for details. If this refers to a
b439c6ee	150	device node, a dependency on the
cdb788e4 LP	151	respective device unit is
	152	automatically created. (See
	153	<citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.)
	154	This option is
	155	mandatory.</para></listitem>
	156	</varlistentry>
	157
	158	<varlistentry>
	159	<term><varname>Where=</varname></term>
	160	<listitem><para>Takes an absolute path
	161	of a directory of the mount point. If
	162	the mount point is not existing at
b439c6ee	163	time of mounting, it is created. This
cdb788e4 LP	164	string must be reflected in the unit
	165	file name. (See above.) This option is
	166	mandatory.</para></listitem>
	167	</varlistentry>
	168
	169	<varlistentry>
	170	<term><varname>Type=</varname></term>
	171	<listitem><para>Takes a string for the
	172	filesystem type. See
	173	<citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	174	for details. This setting is
	175	optional.</para></listitem>
	176	</varlistentry>
	177
	178	<varlistentry>
	179	<term><varname>Options=</varname></term>
	180
	181	<listitem><para>Mount options to use
	182	when mounting. This takes a comma
	183	seperated list of options. This
	184	setting is optional.</para></listitem>
	185	</varlistentry>
	186
	187	<varlistentry>
	188	<term><varname>DirectoryMode=</varname></term>
	189	<listitem><para>Directories of mount
	190	points (and any parent directories)
	191	are automatically created if
	192	needed. This option specifies the file
	193	system access mode used when creating
dd1eb43b LP	194	these directories. Takes an access
dd1eb43b LP	195	mode in octal notation. Defaults to
cdb788e4 LP	196	0755.</para></listitem>
	197	</varlistentry>
	198
	199	<varlistentry>
	200	<term><varname>TimeoutSec=</varname></term>
	201	<listitem><para>Configures the time to
	202	wait for the mount command to
b439c6ee	203	finish. If a command does not exit
cdb788e4 LP	204	within the configured time the mount
	205	will be considered failed and be shut
	206	down again. All commands still running
	207	will be terminated forcibly via
	208	SIGTERM, and after another delay of
	209	this time with SIGKILL. (See
	210	<option>KillMode=</option> below.)
	211	Takes a unit-less value in seconds, or
	212	a time span value such as "5min
	213	20s". Pass 0 to disable the timeout
	214	logic. Defaults to
	215	60s.</para></listitem>
	216	</varlistentry>
	217
	218	<varlistentry>
	219	<term><varname>KillMode=</varname></term>
	220	<listitem><para>Specifies how
	221	processes of this mount shall be
	222	killed. One of
	223	<option>control-group</option>,
	224	<option>process-group</option>,
	225	<option>process</option>,
	226	<option>none</option>.</para>
	227
	228	<para>This option is mostly equivalent
	229	to the <option>KillMode=</option>
	230	option of service files. See
	231	<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
	232	for details.</para></listitem>
	233	</varlistentry>
	234	</variablelist>
	235	</refsect1>
	236
	237	<refsect1>
	238	<title>See Also</title>
	239	<para>
	240	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
	241	<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
	242	<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	243	<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	244	<citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	245	<citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
	246	</para>
	247	</refsect1>
	248
	249	</refentry>