chiark / gitweb /
man: fix specification of default timeouts
[elogind.git] / man / systemd.mount.xml
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
58                 <filename>.mount</filename> encodes information about
59                 a file system mount point controlled and supervised by
60                 systemd.</para>
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
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>
76
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
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>
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>
90
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>
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>
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
114                 mount option, then systemd will create a dependency of
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
125                 <filename>/etc/fstab</filename> and a unit file, the
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
138                 options specific to the [Mount] section of mount
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
150                                 device node, a dependency on the
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
163                                 time of mounting, it is created. This
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                                 separated 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
194                                 these directories. Takes an access
195                                 mode in octal notation. Defaults to
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
203                                 finish. If a command does not exit
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                                 3min.</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</option>,
225                                 <option>none</option>.</para>
226
227                                 <para>This option is mostly equivalent
228                                 to the <option>KillMode=</option>
229                                 option of service files. See
230                                 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
231                                 for details.</para></listitem>
232                         </varlistentry>
233
234                         <varlistentry>
235                                 <term><varname>KillSignal=</varname></term>
236                                 <listitem><para>Specifies which signal
237                                 to use when killing a process of this
238                                 mount. Defaults to SIGTERM.
239                                 </para></listitem>
240                         </varlistentry>
241
242                         <varlistentry>
243                                 <term><varname>SendSIGKILL=</varname></term>
244                                 <listitem><para>Specifies whether to
245                                 send SIGKILL to remaining processes
246                                 after a timeout, if the normal
247                                 shutdown procedure left processes of
248                                 the mount around. Takes a boolean
249                                 value. Defaults to "yes".
250                                 </para></listitem>
251                         </varlistentry>
252                 </variablelist>
253         </refsect1>
254
255         <refsect1>
256                   <title>See Also</title>
257                   <para>
258                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
259                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
260                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
261                           <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
262                           <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
263                           <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
264                   </para>
265         </refsect1>
266
267 </refentry>