]>
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 | |
5430f7f2 LP |
12 | under the terms of the GNU Lesser General Public License as published by |
13 | the Free Software Foundation; either version 2.1 of the License, or | |
cdb788e4 LP |
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 | |
5430f7f2 | 19 | Lesser General Public License for more details. |
cdb788e4 | 20 | |
5430f7f2 | 21 | You should have received a copy of the GNU Lesser General Public License |
cdb788e4 LP |
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 |
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 | |
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> | |
fa4ab997 | 102 | <title><filename>/etc/fstab</filename></title> |
cdb788e4 LP |
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 | |
92a39ae1 LP |
112 | points from <filename>/etc/fstab</filename>. systemd |
113 | will create a dependency of type | |
114 | <option>Wants</option> from either | |
cdb788e4 LP |
115 | <filename>local-fs.target</filename> or |
116 | <filename>remote-fs.target</filename>, depending | |
117 | whether the file system is local or remote. If | |
fa4ab997 LP |
118 | <option>x-systemd.automount</option> is set, an |
119 | automount unit will be created for the file | |
120 | system. See | |
cdb788e4 | 121 | <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry> |
fa4ab997 | 122 | for details. If |
92a39ae1 | 123 | <option>x-systemd.device-timeout=</option> is |
fa4ab997 LP |
124 | specified it may be used to configure how long systemd |
125 | should wait for a device to show up before giving up | |
126 | on an entry from | |
127 | <filename>/etc/fstab</filename>. Specify a time in | |
128 | seconds or explicitly specifiy a unit as | |
129 | <literal>s</literal>, <literal>min</literal>, | |
130 | <literal>h</literal>, <literal>ms</literal>.</para> | |
cdb788e4 LP |
131 | |
132 | <para>If a mount point is configured in both | |
b439c6ee | 133 | <filename>/etc/fstab</filename> and a unit file, the |
cdb788e4 LP |
134 | configuration in the latter takes precedence.</para> |
135 | </refsect1> | |
136 | ||
137 | <refsect1> | |
138 | <title>Options</title> | |
139 | ||
140 | <para>Mount files must include a [Mount] section, | |
141 | which carries information about the file system mount points it | |
142 | supervises. A number of options that may be used in | |
143 | this section are shared with other unit types. These | |
144 | options are documented in | |
145 | <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The | |
65232ea7 | 146 | options specific to the [Mount] section of mount |
cdb788e4 LP |
147 | units are the following:</para> |
148 | ||
149 | <variablelist> | |
150 | ||
151 | <varlistentry> | |
152 | <term><varname>What=</varname></term> | |
153 | <listitem><para>Takes an absolute path | |
154 | of a device node, file or other | |
155 | resource to mount. See | |
156 | <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
157 | for details. If this refers to a | |
b439c6ee | 158 | device node, a dependency on the |
cdb788e4 LP |
159 | respective device unit is |
160 | automatically created. (See | |
161 | <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.) | |
162 | This option is | |
163 | mandatory.</para></listitem> | |
164 | </varlistentry> | |
165 | ||
166 | <varlistentry> | |
167 | <term><varname>Where=</varname></term> | |
168 | <listitem><para>Takes an absolute path | |
169 | of a directory of the mount point. If | |
170 | the mount point is not existing at | |
b439c6ee | 171 | time of mounting, it is created. This |
cdb788e4 LP |
172 | string must be reflected in the unit |
173 | file name. (See above.) This option is | |
174 | mandatory.</para></listitem> | |
175 | </varlistentry> | |
176 | ||
177 | <varlistentry> | |
178 | <term><varname>Type=</varname></term> | |
179 | <listitem><para>Takes a string for the | |
180 | filesystem type. See | |
181 | <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
182 | for details. This setting is | |
183 | optional.</para></listitem> | |
184 | </varlistentry> | |
185 | ||
186 | <varlistentry> | |
187 | <term><varname>Options=</varname></term> | |
188 | ||
189 | <listitem><para>Mount options to use | |
190 | when mounting. This takes a comma | |
96d4ce01 | 191 | separated list of options. This |
cdb788e4 LP |
192 | setting is optional.</para></listitem> |
193 | </varlistentry> | |
194 | ||
195 | <varlistentry> | |
196 | <term><varname>DirectoryMode=</varname></term> | |
197 | <listitem><para>Directories of mount | |
198 | points (and any parent directories) | |
199 | are automatically created if | |
200 | needed. This option specifies the file | |
201 | system access mode used when creating | |
dd1eb43b LP |
202 | these directories. Takes an access |
203 | mode in octal notation. Defaults to | |
cdb788e4 LP |
204 | 0755.</para></listitem> |
205 | </varlistentry> | |
206 | ||
207 | <varlistentry> | |
208 | <term><varname>TimeoutSec=</varname></term> | |
209 | <listitem><para>Configures the time to | |
210 | wait for the mount command to | |
b439c6ee | 211 | finish. If a command does not exit |
cdb788e4 LP |
212 | within the configured time the mount |
213 | will be considered failed and be shut | |
214 | down again. All commands still running | |
215 | will be terminated forcibly via | |
216 | SIGTERM, and after another delay of | |
217 | this time with SIGKILL. (See | |
218 | <option>KillMode=</option> below.) | |
219 | Takes a unit-less value in seconds, or | |
220 | a time span value such as "5min | |
221 | 20s". Pass 0 to disable the timeout | |
222 | logic. Defaults to | |
ecb963cc | 223 | 90s.</para></listitem> |
cdb788e4 LP |
224 | </varlistentry> |
225 | ||
226 | <varlistentry> | |
227 | <term><varname>KillMode=</varname></term> | |
228 | <listitem><para>Specifies how | |
229 | processes of this mount shall be | |
230 | killed. One of | |
231 | <option>control-group</option>, | |
cdb788e4 LP |
232 | <option>process</option>, |
233 | <option>none</option>.</para> | |
234 | ||
235 | <para>This option is mostly equivalent | |
236 | to the <option>KillMode=</option> | |
237 | option of service files. See | |
238 | <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
239 | for details.</para></listitem> | |
240 | </varlistentry> | |
2292707d LP |
241 | |
242 | <varlistentry> | |
243 | <term><varname>KillSignal=</varname></term> | |
244 | <listitem><para>Specifies which signal | |
245 | to use when killing a process of this | |
246 | mount. Defaults to SIGTERM. | |
247 | </para></listitem> | |
248 | </varlistentry> | |
249 | ||
ba035df2 LP |
250 | <varlistentry> |
251 | <term><varname>SendSIGKILL=</varname></term> | |
252 | <listitem><para>Specifies whether to | |
253 | send SIGKILL to remaining processes | |
254 | after a timeout, if the normal | |
255 | shutdown procedure left processes of | |
256 | the mount around. Takes a boolean | |
257 | value. Defaults to "yes". | |
258 | </para></listitem> | |
259 | </varlistentry> | |
cdb788e4 LP |
260 | </variablelist> |
261 | </refsect1> | |
262 | ||
263 | <refsect1> | |
264 | <title>See Also</title> | |
265 | <para> | |
f3e219a2 | 266 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
cdb788e4 LP |
267 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
268 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
269 | <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
270 | <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
271 | <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
272 | </para> | |
273 | </refsect1> | |
274 | ||
275 | </refentry> |