]>
Commit | Line | Data |
---|---|---|
65232ea7 | 1 | <?xml version='1.0'?> <!--*-nxml-*--> |
65232ea7 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
65232ea7 LP |
4 | |
5 | <!-- | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2010 Lennart Poettering | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
5430f7f2 LP |
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 | |
65232ea7 LP |
13 | (at your option) any later version. |
14 | ||
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 | |
5430f7f2 | 18 | Lesser General Public License for more details. |
65232ea7 | 19 | |
5430f7f2 | 20 | You should have received a copy of the GNU Lesser General Public License |
65232ea7 LP |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
22 | --> | |
23 | ||
24 | <refentry id="systemd.automount"> | |
798d3a52 ZJS |
25 | <refentryinfo> |
26 | <title>systemd.automount</title> | |
27 | <productname>systemd</productname> | |
28 | ||
29 | <authorgroup> | |
30 | <author> | |
31 | <contrib>Developer</contrib> | |
32 | <firstname>Lennart</firstname> | |
33 | <surname>Poettering</surname> | |
34 | <email>lennart@poettering.net</email> | |
35 | </author> | |
36 | </authorgroup> | |
37 | </refentryinfo> | |
38 | ||
39 | <refmeta> | |
40 | <refentrytitle>systemd.automount</refentrytitle> | |
41 | <manvolnum>5</manvolnum> | |
42 | </refmeta> | |
43 | ||
44 | <refnamediv> | |
45 | <refname>systemd.automount</refname> | |
46 | <refpurpose>Automount unit configuration</refpurpose> | |
47 | </refnamediv> | |
48 | ||
49 | <refsynopsisdiv> | |
50 | <para><filename><replaceable>automount</replaceable>.automount</filename></para> | |
51 | </refsynopsisdiv> | |
52 | ||
53 | <refsect1> | |
54 | <title>Description</title> | |
55 | ||
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 | |
59 | systemd.</para> | |
60 | ||
61 | <para>This man page lists the configuration options specific to | |
62 | this unit type. See | |
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> | |
68 | ||
69 | <para>Automount units must be named after the automount | |
70 | directories they control. Example: the automount point | |
71 | <filename noindex='true'>/home/lennart</filename> must be | |
72 | configured in a unit file | |
73 | <filename>home-lennart.automount</filename>. For details about the | |
74 | escaping logic used to convert a file system path to a unit name | |
75 | see | |
76 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
77 | ||
78 | <para>For each automount unit file a matching mount unit file (see | |
79 | <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
80 | for details) must exist which is activated when the automount path | |
81 | is accessed. Example: if an automount unit | |
82 | <filename>home-lennart.automount</filename> is active and the user | |
83 | accesses <filename>/home/lennart</filename> the mount unit | |
84 | <filename>home-lennart.mount</filename> will be activated.</para> | |
85 | ||
86 | <para>Automount units may be used to implement on-demand mounting | |
87 | as well as parallelized mounting of file systems.</para> | |
c129bd5d LP |
88 | </refsect1> |
89 | ||
90 | <refsect1> | |
91 | <title>Automatic Dependencies</title> | |
92 | ||
93 | <para>If an automount unit is beneath another mount unit in the | |
94 | file system hierarchy, both a requirement and an ordering | |
95 | dependency between both units are created automatically.</para> | |
96 | ||
97 | <para>An implicit <varname>Before=</varname> dependency is created | |
98 | between an automount unit and the mount unit it activates.</para> | |
99 | ||
100 | <para>Automount units acquire automatic <varname>Before=</varname> | |
101 | and <varname>Conflicts=</varname> on | |
102 | <filename>umount.target</filename> in order to be stopped during | |
103 | shutdown, unless <varname>DefaultDependencies=no</varname> is | |
104 | set.</para> | |
798d3a52 | 105 | |
798d3a52 ZJS |
106 | </refsect1> |
107 | ||
108 | <refsect1> | |
109 | <title><filename>fstab</filename></title> | |
110 | ||
111 | <para>Automount units may either be configured via unit files, or | |
112 | via <filename>/etc/fstab</filename> (see | |
3ba3a79d | 113 | <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> |
798d3a52 ZJS |
114 | for details).</para> |
115 | ||
116 | <para>For details how systemd parses | |
117 | <filename>/etc/fstab</filename> see | |
118 | <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> | |
119 | ||
120 | <para>If an automount point is configured in both | |
121 | <filename>/etc/fstab</filename> and a unit file, the configuration | |
122 | in the latter takes precedence.</para> | |
123 | </refsect1> | |
124 | ||
125 | <refsect1> | |
126 | <title>Options</title> | |
127 | ||
128 | <para>Automount files must include an [Automount] section, which | |
129 | carries information about the file system automount points it | |
130 | supervises. The options specific to the [Automount] section of | |
131 | automount units are the following:</para> | |
132 | ||
133 | <variablelist class='unit-directives'> | |
134 | ||
135 | <varlistentry> | |
136 | <term><varname>Where=</varname></term> | |
137 | <listitem><para>Takes an absolute path of a directory of the | |
138 | automount point. If the automount point does not exist at time | |
139 | that the automount point is installed, it is created. This | |
140 | string must be reflected in the unit filename. (See above.) | |
141 | This option is mandatory.</para></listitem> | |
142 | </varlistentry> | |
143 | ||
144 | <varlistentry> | |
145 | <term><varname>DirectoryMode=</varname></term> | |
146 | <listitem><para>Directories of automount points (and any | |
147 | parent directories) are automatically created if needed. This | |
148 | option specifies the file system access mode used when | |
149 | creating these directories. Takes an access mode in octal | |
150 | notation. Defaults to 0755.</para></listitem> | |
151 | </varlistentry> | |
deb0a77c MO |
152 | <varlistentry> |
153 | <term><varname>TimeoutIdleSec=</varname></term> | |
a8eaaee7 | 154 | <listitem><para>Configures an idle timeout. Once the mount has been |
deb0a77c MO |
155 | idle for the specified time, systemd will attempt to unmount. Takes a |
156 | unit-less value in seconds, or a time span value such as "5min 20s". | |
157 | Pass 0 to disable the timeout logic. The timeout is disabled by | |
158 | default.</para></listitem> | |
159 | </varlistentry> | |
798d3a52 ZJS |
160 | </variablelist> |
161 | </refsect1> | |
162 | ||
163 | <refsect1> | |
164 | <title>See Also</title> | |
165 | <para> | |
166 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
167 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
168 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
169 | <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
3ba3a79d ZJS |
170 | <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
171 | <citerefentry project='die-net'><refentrytitle>automount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
798d3a52 ZJS |
172 | <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> |
173 | </para> | |
174 | </refsect1> | |
65232ea7 LP |
175 | |
176 | </refentry> |