]> git.proxmox.com Git - systemd.git/blame - man/systemd.automount.html
Imported Upstream version 219
[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>·
e735f4d4
MP
22 <a href="../libudev/index.html">gudev </a><span style="float:right">systemd 219</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="idm140603572960848"></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
23 "<code class="literal">.automount</code>" encodes information about a file
24 system automount point controlled and supervised by
25 systemd.</p><p>This man page lists the configuration options specific to
26 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 files. The common
29 configuration items are configured in the generic [Unit] and
30 [Install] sections. The automount specific configuration options
31 are configured in the [Automount] section.</p><p>Automount units must be named after the automount
32 directories they control. Example: the automount point
33 <code class="filename">/home/lennart</code> must be
34 configured in a unit file
35 <code class="filename">home-lennart.automount</code>. For details about the
36 escaping logic used to convert a file system path to a unit name
37 see
38 <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 unit file (see
39 <a href="systemd.mount.html"><span class="citerefentry"><span class="refentrytitle">systemd.mount</span>(5)</span></a>
40 for details) must exist which is activated when the automount path
41 is accessed. Example: if an automount unit
42 <code class="filename">home-lennart.automount</code> is active and the user
43 accesses <code class="filename">/home/lennart</code> the mount unit
44 <code class="filename">home-lennart.mount</code> will be activated.</p><p>Automount units may be used to implement on-demand mounting
45 as well as parallelized mounting of file systems.</p><p>If an automount point is beneath another mount point in the
46 file system hierarchy, a dependency between both units is created
47 automatically.</p></div><div class="refsect1"><a name="idm140603569402144"></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 files, or
48 via <code class="filename">/etc/fstab</code> (see
49 <a href="fstab.html"><span class="citerefentry"><span class="refentrytitle">fstab</span>(5)</span></a>
50 for details).</p><p>For details how systemd parses
51 <code class="filename">/etc/fstab</code> see
52 <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
53 <code class="filename">/etc/fstab</code> and a unit file, the configuration
54 in the latter takes precedence.</p></div><div class="refsect1"><a name="idm140603569395984"></a><h2 id="Options">Options<a class="headerlink" title="Permalink to this headline" href="#Options">¶</a></h2><p>Automount files must include an [Automount] section, which
55 carries information about the file system automount points it
56 supervises. The options specific to the [Automount] section of
57 automount units 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 of a directory of the
58 automount point. If the automount point does not exist at time
59 that the automount point is installed, it is created. This
60 string must be reflected in the unit filename. (See above.)
61 This option is 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 automount points (and any
62 parent directories) are automatically created if needed. This
63 option specifies the file system access mode used when
64 creating these directories. Takes an access mode in octal
65 notation. Defaults to 0755.</p></dd></dl></div></div><div class="refsect1"><a name="idm140603573107840"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p>
66 <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>,
67 <a href="systemctl.html"><span class="citerefentry"><span class="refentrytitle">systemctl</span>(1)</span></a>,
68 <a href="systemd.unit.html"><span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span></a>,
69 <a href="systemd.mount.html"><span class="citerefentry"><span class="refentrytitle">systemd.mount</span>(5)</span></a>,
70 <a href="mount.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a>,
71 <a href="automount.html"><span class="citerefentry"><span class="refentrytitle">automount</span>(8)</span></a>,
72 <a href="systemd.directives.html"><span class="citerefentry"><span class="refentrytitle">systemd.directives</span>(7)</span></a>
73 </p></div></div></body></html>