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">
7 This file is part of systemd.
9 Copyright 2010 Lennart Poettering
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.
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.
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/>.
25 <refentry id="systemd.mount">
27 <title>systemd.mount</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
41 <refentrytitle>systemd.mount</refentrytitle>
42 <manvolnum>5</manvolnum>
46 <refname>systemd.mount</refname>
47 <refpurpose>systemd mount configuration files</refpurpose>
51 <para><filename>systemd.mount</filename></para>
55 <title>Description</title>
57 <para>A unit configuration file whose name ends in
58 <filename>.mount</filename> encodes information about
59 a file system mount point controlled and supervised by
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>
71 <para>Additional options are listed in
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>
77 <para>Mount units must be named after the mount point
78 directories they control. Example: the mount point
79 <filename>/home/lennart</filename> must be configured
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>
86 <para>Optionally, a mount unit may be accompanied by
87 an automount unit, to allow on-demand or parallelized
89 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
91 <para>If an mount point is beneath another mount point
92 in the file system hierarchy, a dependency between both
93 units is created automatically.</para>
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>
102 <title><filename>/etc/fstab</filename></title>
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>
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>x-systemd.mount</option> is specified as mount
114 option, then systemd will create a dependency of type
115 <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>x-systemd.automount</option> is set, an
120 automount unit will be created for the file
122 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
124 <option>x-systemd-device-timeout=</option> is
125 specified it may be used to configure how long systemd
126 should wait for a device to show up before giving up
128 <filename>/etc/fstab</filename>. Specify a time in
129 seconds or explicitly specifiy a unit as
130 <literal>s</literal>, <literal>min</literal>,
131 <literal>h</literal>, <literal>ms</literal>.</para>
133 <para>If a mount point is configured in both
134 <filename>/etc/fstab</filename> and a unit file, the
135 configuration in the latter takes precedence.</para>
139 <title>Options</title>
141 <para>Mount files must include a [Mount] section,
142 which carries information about the file system mount points it
143 supervises. A number of options that may be used in
144 this section are shared with other unit types. These
145 options are documented in
146 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
147 options specific to the [Mount] section of mount
148 units are the following:</para>
153 <term><varname>What=</varname></term>
154 <listitem><para>Takes an absolute path
155 of a device node, file or other
156 resource to mount. See
157 <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
158 for details. If this refers to a
159 device node, a dependency on the
160 respective device unit is
161 automatically created. (See
162 <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.)
164 mandatory.</para></listitem>
168 <term><varname>Where=</varname></term>
169 <listitem><para>Takes an absolute path
170 of a directory of the mount point. If
171 the mount point is not existing at
172 time of mounting, it is created. This
173 string must be reflected in the unit
174 file name. (See above.) This option is
175 mandatory.</para></listitem>
179 <term><varname>Type=</varname></term>
180 <listitem><para>Takes a string for the
182 <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
183 for details. This setting is
184 optional.</para></listitem>
188 <term><varname>Options=</varname></term>
190 <listitem><para>Mount options to use
191 when mounting. This takes a comma
192 separated list of options. This
193 setting is optional.</para></listitem>
197 <term><varname>DirectoryMode=</varname></term>
198 <listitem><para>Directories of mount
199 points (and any parent directories)
200 are automatically created if
201 needed. This option specifies the file
202 system access mode used when creating
203 these directories. Takes an access
204 mode in octal notation. Defaults to
205 0755.</para></listitem>
209 <term><varname>TimeoutSec=</varname></term>
210 <listitem><para>Configures the time to
211 wait for the mount command to
212 finish. If a command does not exit
213 within the configured time the mount
214 will be considered failed and be shut
215 down again. All commands still running
216 will be terminated forcibly via
217 SIGTERM, and after another delay of
218 this time with SIGKILL. (See
219 <option>KillMode=</option> below.)
220 Takes a unit-less value in seconds, or
221 a time span value such as "5min
222 20s". Pass 0 to disable the timeout
224 90s.</para></listitem>
228 <term><varname>KillMode=</varname></term>
229 <listitem><para>Specifies how
230 processes of this mount shall be
232 <option>control-group</option>,
233 <option>process</option>,
234 <option>none</option>.</para>
236 <para>This option is mostly equivalent
237 to the <option>KillMode=</option>
238 option of service files. See
239 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
240 for details.</para></listitem>
244 <term><varname>KillSignal=</varname></term>
245 <listitem><para>Specifies which signal
246 to use when killing a process of this
247 mount. Defaults to SIGTERM.
252 <term><varname>SendSIGKILL=</varname></term>
253 <listitem><para>Specifies whether to
254 send SIGKILL to remaining processes
255 after a timeout, if the normal
256 shutdown procedure left processes of
257 the mount around. Takes a boolean
258 value. Defaults to "yes".
265 <title>See Also</title>
267 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
268 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
269 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
270 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
271 <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
272 <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>