projects / systemd.git / blame
| Commit | Line | Data |
|---|---|---|
| 663996b3 MS |
1 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>systemd.mount</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>· | |
| 22 | <a href="../libudev/index.html">gudev </a><span style="float:right">systemd 204</span><hr><div class="refentry"><a name="systemd.mount"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>systemd.mount — Mount unit configuration</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><p><code class="filename"><em class="replaceable"><code>mount</code></em>.mount</code></p></div><div class="refsect1"><a name="idm259770088336"></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="filename">.mount</code> encodes information about | |
| 24 | a file system mount point controlled and supervised by | |
| 25 | 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 | mount specific configuration options are configured | |
| 32 | in the [Mount] section.</p><p>Additional options are listed in | |
| 33 | <a href="systemd.exec.html"><span class="citerefentry"><span class="refentrytitle">systemd.exec</span>(5)</span></a>, | |
| 34 | which define the execution environment the | |
| 35 | <a href="mount.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a> | |
| 36 | binary is executed in, and in | |
| 37 | <a href="systemd.kill.html"><span class="citerefentry"><span class="refentrytitle">systemd.kill</span>(5)</span></a> | |
| 38 | which define the way the processes are | |
| 39 | terminated. Note that the User= and Group= options are | |
| 40 | not particularly useful for mount units specifying a | |
| 41 | <code class="literal">Type=</code> option or using configuration | |
| 42 | not specified in <code class="filename">/etc/fstab</code>; | |
| 43 | <a href="mount.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a> | |
| 44 | will refuse options that aren't listed in | |
| 45 | <code class="filename">/etc/fstab</code> if it is not run as | |
| 46 | UID 0.</p><p>Mount units must be named after the mount point | |
| 47 | directories they control. Example: the mount point | |
| 48 | <code class="filename">/home/lennart</code> must be configured | |
| 49 | in a unit file | |
| 50 | <code class="filename">home-lennart.mount</code>. For details | |
| 51 | about the escaping logic used to convert a file system | |
| 52 | path to a unit name see | |
| 53 | <a href="systemd.unit.html"><span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span></a>.</p><p>Optionally, a mount unit may be accompanied by | |
| 54 | an automount unit, to allow on-demand or parallelized | |
| 55 | mounting. See | |
| 56 | <a href="systemd.automount.html"><span class="citerefentry"><span class="refentrytitle">systemd.automount</span>(5)</span></a>.</p><p>If a mount point is beneath another mount point | |
| 57 | in the file system hierarchy, a dependency between both | |
| 58 | units is created automatically.</p><p>Mount points created at runtime (independently of | |
| 59 | unit files or <code class="filename">/etc/fstab</code>) will be | |
| 60 | monitored by systemd and appear like any other mount | |
| 61 | unit in systemd. | |
| 62 | See <code class="filename">/proc/self/mountinfo</code> description | |
| 63 | in <a href="proc.html"><span class="citerefentry"><span class="refentrytitle">proc</span>(5)</span></a>. | |
| 64 | </p><p>Some file systems have special semantics as API | |
| 65 | file systems for kernel-to-userspace and | |
| 66 | userspace-to-userpace interfaces. Some of them may not | |
| 67 | be changed via mount units, and cannot be disabled. | |
| 68 | For a longer discussion see <a class="ulink" href="http://www.freedesktop.org/wiki/Software/systemd/APIFileSystems" target="_top">API | |
| 69 | File Systems</a>.</p></div><div class="refsect1"><a name="idm259774020688"></a><h2 id="/etc/fstab"><code class="filename">/etc/fstab</code><a class="headerlink" title="Permalink to this headline" href="#/etc/fstab">¶</a></h2><p>Mount units may either be configured via unit | |
| 70 | files, or via <code class="filename">/etc/fstab</code> (see | |
| 71 | <a href="fstab.html"><span class="citerefentry"><span class="refentrytitle">fstab</span>(5)</span></a> | |
| 72 | for details). Mounts listed in | |
| 73 | <code class="filename">/etc/fstab</code> will be converted into | |
| 74 | native units dynamically at boot and when the | |
| 75 | configuration of the system manager is reloaded. See | |
| 76 | <a href="systemd-fstab-generator.html"><span class="citerefentry"><span class="refentrytitle">systemd-fstab-generator</span>(8)</span></a> | |
| 77 | for details about the conversion.</p><p>When reading <code class="filename">/etc/fstab</code> a | |
| 78 | few special mount options are understood by systemd | |
| 79 | which influence how dependencies are created for mount | |
| 80 | points from <code class="filename">/etc/fstab</code>. systemd | |
| 81 | will create a dependency of type | |
| 82 | <code class="option">Wants</code> from either | |
| 83 | <code class="filename">local-fs.target</code> or | |
| 84 | <code class="filename">remote-fs.target</code>, depending | |
| 85 | whether the file system is local or remote. If | |
| 86 | <code class="option">x-systemd.automount</code> is set, an | |
| 87 | automount unit will be created for the file | |
| 88 | system. See | |
| 89 | <a href="systemd.automount.html"><span class="citerefentry"><span class="refentrytitle">systemd.automount</span>(5)</span></a> | |
| 90 | for details. If | |
| 91 | <code class="option">x-systemd.device-timeout=</code> is | |
| 92 | specified it may be used to configure how long systemd | |
| 93 | should wait for a device to show up before giving up | |
| 94 | on an entry from | |
| 95 | <code class="filename">/etc/fstab</code>. Specify a time in | |
| 96 | seconds or explicitly specify a unit as | |
| 97 | <code class="literal">s</code>, <code class="literal">min</code>, | |
| 98 | <code class="literal">h</code>, <code class="literal">ms</code>.</p><p>If a mount point is configured in both | |
| 99 | <code class="filename">/etc/fstab</code> and a unit file that | |
| 100 | is stored below <code class="filename">/usr</code> the former | |
| 101 | will take precedence. If the unit file is stored below | |
| 102 | <code class="filename">/etc</code> it will take | |
| 103 | precedence. This means: native unit files take | |
| 104 | precedence over traditional configuration files, but | |
| 105 | this is superseded by the rule that configuration in | |
| 106 | <code class="filename">/etc</code> will always take precedence | |
| 107 | over configuration in | |
| 108 | <code class="filename">/usr</code>.</p></div><div class="refsect1"><a name="idm259773995008"></a><h2 id="Options">Options<a class="headerlink" title="Permalink to this headline" href="#Options">¶</a></h2><p>Mount files must include a [Mount] section, | |
| 109 | which carries information about the file system mount points it | |
| 110 | supervises. A number of options that may be used in | |
| 111 | this section are shared with other unit types. These | |
| 112 | options are documented in | |
| 113 | <a href="systemd.exec.html"><span class="citerefentry"><span class="refentrytitle">systemd.exec</span>(5)</span></a> | |
| 114 | and | |
| 115 | <a href="systemd.kill.html"><span class="citerefentry"><span class="refentrytitle">systemd.kill</span>(5)</span></a>. The | |
| 116 | options specific to the [Mount] section of mount | |
| 117 | units are the following:</p><div class="variablelist"><dl class="variablelist"><dt id="What="><span class="term"><code class="varname">What=</code></span><a class="headerlink" title="Permalink to this term" href="#What=">¶</a></dt><dd><p>Takes an absolute path | |
| 118 | of a device node, file or other | |
| 119 | resource to mount. See | |
| 120 | <a href="mount.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a> | |
| 121 | for details. If this refers to a | |
| 122 | device node, a dependency on the | |
| 123 | respective device unit is | |
| 124 | automatically created. (See | |
| 125 | <a href="systemd.device.html"><span class="citerefentry"><span class="refentrytitle">systemd.device</span>(5)</span></a> for more information.) | |
| 126 | This option is | |
| 127 | mandatory.</p></dd><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 | |
| 128 | of a directory of the mount point. If | |
| 129 | the mount point does not exist at the | |
| 130 | time of mounting, it is created. This | |
| 131 | string must be reflected in the unit | |
| 132 | file name. (See above.) This option is | |
| 133 | mandatory.</p></dd><dt id="Type="><span class="term"><code class="varname">Type=</code></span><a class="headerlink" title="Permalink to this term" href="#Type=">¶</a></dt><dd><p>Takes a string for the | |
| 134 | filesystem type. See | |
| 135 | <a href="mount.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a> | |
| 136 | for details. This setting is | |
| 137 | optional.</p></dd><dt id="Options="><span class="term"><code class="varname">Options=</code></span><a class="headerlink" title="Permalink to this term" href="#Options=">¶</a></dt><dd><p>Mount options to use | |
| 138 | when mounting. This takes a comma | |
| 139 | separated list of options. This | |
| 140 | setting is optional.</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 mount | |
| 141 | points (and any parent directories) | |
| 142 | are automatically created if | |
| 143 | needed. This option specifies the file | |
| 144 | system access mode used when creating | |
| 145 | these directories. Takes an access | |
| 146 | mode in octal notation. Defaults to | |
| 147 | 0755.</p></dd><dt id="TimeoutSec="><span class="term"><code class="varname">TimeoutSec=</code></span><a class="headerlink" title="Permalink to this term" href="#TimeoutSec=">¶</a></dt><dd><p>Configures the time to | |
| 148 | wait for the mount command to | |
| 149 | finish. If a command does not exit | |
| 150 | within the configured time the mount | |
| 151 | will be considered failed and be shut | |
| 152 | down again. All commands still running | |
| 153 | will be terminated forcibly via | |
| 154 | SIGTERM, and after another delay of | |
| 155 | this time with SIGKILL. (See | |
| 156 | <code class="option">KillMode=</code> in | |
| 157 | <a href="systemd.kill.html"><span class="citerefentry"><span class="refentrytitle">systemd.kill</span>(5)</span></a>.) | |
| 158 | Takes a unit-less value in seconds, or | |
| 159 | a time span value such as "5min | |
| 160 | 20s". Pass 0 to disable the timeout | |
| 161 | logic. Defaults to | |
| 162 | 90s.</p></dd></dl></div><p>Check | |
| 163 | <a href="systemd.exec.html"><span class="citerefentry"><span class="refentrytitle">systemd.exec</span>(5)</span></a> | |
| 164 | and | |
| 165 | <a href="systemd.kill.html"><span class="citerefentry"><span class="refentrytitle">systemd.kill</span>(5)</span></a> | |
| 166 | for more settings.</p></div><div class="refsect1"><a name="idm259769011792"></a><h2 id="Compatibility Options">Compatibility Options<a class="headerlink" title="Permalink to this headline" href="#Compatibility%20Options">¶</a></h2><p>The following option is also available in the | |
| 167 | <code class="literal">[Mount]</code> section, but exists purely | |
| 168 | for compatibility reasons and should not be used in | |
| 169 | newly written mount files.</p><div class="variablelist"><dl class="variablelist"><dt id="FsckPassNo="><span class="term"><code class="varname">FsckPassNo=</code></span><a class="headerlink" title="Permalink to this term" href="#FsckPassNo=">¶</a></dt><dd><p>The pass number for | |
| 170 | the file system checking service for | |
| 171 | this mount. See | |
| 172 | <a href="systemd.service.html"><span class="citerefentry"><span class="refentrytitle">systemd.service</span>(5)</span></a> | |
| 173 | for more information on this setting. | |
| 174 | </p></dd></dl></div></div><div class="refsect1"><a name="idm259769006752"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p> | |
| 175 | <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>, | |
| 176 | <a href="systemctl.html"><span class="citerefentry"><span class="refentrytitle">systemctl</span>(8)</span></a>, | |
| 177 | <a href="systemd.unit.html"><span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span></a>, | |
| 178 | <a href="systemd.exec.html"><span class="citerefentry"><span class="refentrytitle">systemd.exec</span>(5)</span></a>, | |
| 179 | <a href="systemd.kill.html"><span class="citerefentry"><span class="refentrytitle">systemd.kill</span>(5)</span></a>, | |
| 180 | <a href="systemd.service.html"><span class="citerefentry"><span class="refentrytitle">systemd.service</span>(5)</span></a>, | |
| 181 | <a href="systemd.device.html"><span class="citerefentry"><span class="refentrytitle">systemd.device</span>(5)</span></a>, | |
| 182 | <a href="proc.html"><span class="citerefentry"><span class="refentrytitle">proc</span>(5)</span></a>, | |
| 183 | <a href="mount.html"><span class="citerefentry"><span class="refentrytitle">mount</span>(8)</span></a>, | |
| 184 | <a href="systemd-fstab-generator.html"><span class="citerefentry"><span class="refentrytitle">systemd-fstab-generator</span>(8)</span></a>, | |
| 185 | <a href="systemd.directives.html"><span class="citerefentry"><span class="refentrytitle">systemd.directives</span>(7)</span></a> | |
| 186 | </p></div></div></body></html> |