1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id=
"systemd.automount">
26 <title>systemd.automount
</title>
27 <productname>systemd
</productname>
31 <contrib>Developer
</contrib>
32 <firstname>Lennart
</firstname>
33 <surname>Poettering
</surname>
34 <email>lennart@poettering.net
</email>
40 <refentrytitle>systemd.automount
</refentrytitle>
41 <manvolnum>5</manvolnum>
45 <refname>systemd.automount
</refname>
46 <refpurpose>Automount unit configuration
</refpurpose>
50 <para><filename><replaceable>automount
</replaceable>.automount
</filename></para>
54 <title>Description
</title>
56 <para>A unit configuration file whose name ends in
57 <literal>.automount
</literal> encodes information about a file
58 system automount point controlled and supervised by
61 <para>This man page lists the configuration options specific to
63 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
64 for the common options of all unit configuration files. The common
65 configuration items are configured in the generic [Unit] and
66 [Install] sections. The automount specific configuration options
67 are configured in the [Automount] section.
</para>
69 <para>Automount units must be named after the automount directories they control. Example: the automount point
70 <filename noindex='true'
>/home/lennart
</filename> must be configured in a unit file
71 <filename>home-lennart.automount
</filename>. For details about the escaping logic used to convert a file system
72 path to a unit name see
73 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note that
74 automount units cannot be templated, nor is it possible to add multiple names to an automount unit by creating
75 additional symlinks to its unit file.
</para>
77 <para>For each automount unit file a matching mount unit file (see
78 <citerefentry><refentrytitle>systemd.mount
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
79 for details) must exist which is activated when the automount path
80 is accessed. Example: if an automount unit
81 <filename>home-lennart.automount
</filename> is active and the user
82 accesses
<filename>/home/lennart
</filename> the mount unit
83 <filename>home-lennart.mount
</filename> will be activated.
</para>
85 <para>Automount units may be used to implement on-demand mounting
86 as well as parallelized mounting of file systems.
</para>
90 <title>Automatic Dependencies
</title>
92 <para>If an automount unit is beneath another mount unit in the
93 file system hierarchy, both a requirement and an ordering
94 dependency between both units are created automatically.
</para>
96 <para>An implicit
<varname>Before=
</varname> dependency is created
97 between an automount unit and the mount unit it activates.
</para>
99 <para>Automount units acquire automatic
<varname>Before=
</varname> and
<varname>Conflicts=
</varname> on
100 <filename>umount.target
</filename> in order to be stopped during shutdown, unless
101 <varname>DefaultDependencies=no
</varname> is set in the
<literal>[Unit]
</literal> section.
</para>
106 <title><filename>fstab
</filename></title>
108 <para>Automount units may either be configured via unit files, or
109 via
<filename>/etc/fstab
</filename> (see
110 <citerefentry project='man-pages'
><refentrytitle>fstab
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
113 <para>For details how systemd parses
114 <filename>/etc/fstab
</filename> see
115 <citerefentry><refentrytitle>systemd.mount
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
117 <para>If an automount point is configured in both
118 <filename>/etc/fstab
</filename> and a unit file, the configuration
119 in the latter takes precedence.
</para>
123 <title>Options
</title>
125 <para>Automount files must include an [Automount] section, which
126 carries information about the file system automount points it
127 supervises. The options specific to the [Automount] section of
128 automount units are the following:
</para>
130 <variablelist class='unit-directives'
>
133 <term><varname>Where=
</varname></term>
134 <listitem><para>Takes an absolute path of a directory of the
135 automount point. If the automount point does not exist at time
136 that the automount point is installed, it is created. This
137 string must be reflected in the unit filename. (See above.)
138 This option is mandatory.
</para></listitem>
142 <term><varname>DirectoryMode=
</varname></term>
143 <listitem><para>Directories of automount points (and any
144 parent directories) are automatically created if needed. This
145 option specifies the file system access mode used when
146 creating these directories. Takes an access mode in octal
147 notation. Defaults to
0755.
</para></listitem>
150 <term><varname>TimeoutIdleSec=
</varname></term>
151 <listitem><para>Configures an idle timeout. Once the mount has been
152 idle for the specified time, systemd will attempt to unmount. Takes a
153 unit-less value in seconds, or a time span value such as
"5min 20s".
154 Pass
0 to disable the timeout logic. The timeout is disabled by
155 default.
</para></listitem>
161 <title>See Also
</title>
163 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
164 <citerefentry><refentrytitle>systemctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
165 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
166 <citerefentry><refentrytitle>systemd.mount
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
167 <citerefentry project='man-pages'
><refentrytitle>mount
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
168 <citerefentry project='die-net'
><refentrytitle>automount
</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
169 <citerefentry><refentrytitle>systemd.directives
</refentrytitle><manvolnum>7</manvolnum></citerefentry>