]> git.proxmox.com Git - systemd.git/blame - man/systemd.automount.html
Imported Upstream version 218
[systemd.git] / man / systemd.automount.html
CommitLineData
663996b3
MS
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>systemd.automount</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><style>
2 a.headerlink {
3 color: #c60f0f;
4 font-size: 0.8em;
5 padding: 0 4px 0 4px;
6 text-decoration: none;
7 visibility: hidden;
8 }
9
10 a.headerlink:hover {
11 background-color: #c60f0f;
12 color: white;
13 }
14
15 h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, dt:hover > a.headerlink {
16 visibility: visible;
17 }
18 </style><a href="index.html">Index </a>·
19 <a href="systemd.directives.html">Directives </a>·
20 <a href="../python-systemd/index.html">Python </a>·
21 <a href="../libudev/index.html">libudev </a>·
f47781d8 22 <a href="../libudev/index.html">gudev </a><span style="float:right">systemd 218</span><hr><div class="refentry"><a name="systemd.automount"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>systemd.automount — Automount unit configuration</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><p><code class="filename"><em class="replaceable"><code>automount</code></em>.automount</code></p></div><div class="refsect1"><a name="idm140125240939936"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description">¶</a></h2><p>A unit configuration file whose name ends in
14228c0d 23 "<code class="literal">.automount</code>" encodes information
663996b3
MS
24 about a file system automount point controlled and
25 supervised by systemd.</p><p>This man page lists the configuration options
26 specific to this unit type. See
27 <a href="systemd.unit.html"><span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span></a>
28 for the common options of all unit configuration
29 files. The common configuration items are configured
30 in the generic [Unit] and [Install] sections. The
31 automount specific configuration options are configured
32 in the [Automount] section.</p><p>Automount units must be named after the
33 automount directories they control. Example: the
34 automount point <code class="filename">/home/lennart</code>
35 must be configured in a unit file
36 <code class="filename">home-lennart.automount</code>. For
37 details about the escaping logic used to convert a
38 file system path to a unit name see
39 <a href="systemd.unit.html"><span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span></a>.</p><p>For each automount unit file a matching mount
40 unit file (see
41 <a href="systemd.mount.html"><span class="citerefentry"><span class="refentrytitle">systemd.mount</span>(5)</span></a>
42 for details) must exist which is activated when the
43 automount path is accessed. Example: if an automount
44 unit <code class="filename">home-lennart.automount</code> is
45 active and the user accesses
46 <code class="filename">/home/lennart</code> the mount unit
47 <code class="filename">home-lennart.mount</code> will be
48 activated.</p><p>Automount units may be used to implement
49 on-demand mounting as well as parallelized mounting of
50 file systems.</p><p>If an automount point is beneath another mount
14228c0d 51 point in the file system hierarchy, a dependency
f47781d8 52 between both units is created automatically.</p></div><div class="refsect1"><a name="idm140125240218656"></a><h2 id="fstab"><code class="filename">fstab</code><a class="headerlink" title="Permalink to this headline" href="#fstab">¶</a></h2><p>Automount units may either be configured via unit
663996b3
MS
53 files, or via <code class="filename">/etc/fstab</code> (see
54 <a href="fstab.html"><span class="citerefentry"><span class="refentrytitle">fstab</span>(5)</span></a>
55 for details).</p><p>For details how systemd parses
56 <code class="filename">/etc/fstab</code> see
57 <a href="systemd.mount.html"><span class="citerefentry"><span class="refentrytitle">systemd.mount</span>(5)</span></a>.</p><p>If an automount point is configured in both
14228c0d 58 <code class="filename">/etc/fstab</code> and a unit file, the
f47781d8 59 configuration in the latter takes precedence.</p></div><div class="refsect1"><a name="idm140125240212528"></a><h2 id="Options">Options<a class="headerlink" title="Permalink to this headline" href="#Options">¶</a></h2><p>Automount files must include an [Automount]
663996b3
MS
60 section, which carries information about the file
61 system automount points it supervises. The options
62 specific to the [Automount] section of automount units
63 are the following:</p><div class="variablelist"><dl class="variablelist"><dt id="Where="><span class="term"><code class="varname">Where=</code></span><a class="headerlink" title="Permalink to this term" href="#Where=">¶</a></dt><dd><p>Takes an absolute path
64 of a directory of the automount
14228c0d
MB
65 point. If the automount point does not
66 exist at time that the automount
67 point is installed, it is created. This
663996b3 68 string must be reflected in the unit
14228c0d 69 filename. (See above.) This option is
663996b3
MS
70 mandatory.</p></dd><dt id="DirectoryMode="><span class="term"><code class="varname">DirectoryMode=</code></span><a class="headerlink" title="Permalink to this term" href="#DirectoryMode=">¶</a></dt><dd><p>Directories of
71 automount points (and any parent
72 directories) are automatically created
73 if needed. This option specifies the
74 file system access mode used when
75 creating these directories. Takes an
76 access mode in octal
77 notation. Defaults to
f47781d8 78 0755.</p></dd></dl></div></div><div class="refsect1"><a name="idm140125244100704"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p>
663996b3 79 <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>,
5eef597e 80 <a href="systemctl.html"><span class="citerefentry"><span class="refentrytitle">systemctl</span>(1)</span></a>,
663996b3
MS
81 <a href="systemd.unit.html"><span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span></a>,
82 <a href="systemd.mount.html"><span class="citerefentry"><span class="refentrytitle">systemd.mount</span>(5)</span></a>,
83 <a href="mount.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a>,
84 <a href="automount.html"><span class="citerefentry"><span class="refentrytitle">automount</span>(8)</span></a>,
85 <a href="systemd.directives.html"><span class="citerefentry"><span class="refentrytitle">systemd.directives</span>(7)</span></a>
86 </p></div></div></body></html>