man/systemd.mount.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   4         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   5
   6 <!--
   7   This file is part of systemd.
   8
   9   Copyright 2010 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU General Public License as published by
  13   the Free Software Foundation; either version 2 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 -->
  24
  25 <refentry id="systemd.mount">
  26         <refentryinfo>
  27                 <title>systemd.mount</title>
  28                 <productname>systemd</productname>
  29
  30                 <authorgroup>
  31                         <author>
  32                                 <contrib>Developer</contrib>
  33                                 <firstname>Lennart</firstname>
  34                                 <surname>Poettering</surname>
  35                                 <email>lennart@poettering.net</email>
  36                         </author>
  37                 </authorgroup>
  38         </refentryinfo>
  39
  40         <refmeta>
  41                 <refentrytitle>systemd.mount</refentrytitle>
  42                 <manvolnum>5</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>systemd.mount</refname>
  47                 <refpurpose>systemd mount configuration files</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <para><filename>systemd.mount</filename></para>
  52         </refsynopsisdiv>
  53
  54         <refsect1>
  55                 <title>Description</title>
  56
  57                 <para>A unit configuration file whose name ends in
  58                 <filename>.mount</filename> encodes information about
  59                 a file system mount point controlled and supervised by
  60                 systemd.</para>
  61
  62                 <para>This man page lists the configuration options
  63                 specific to this unit type. See
  64                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  65                 for the common options of all unit configuration
  66                 files. The common configuration items are configured
  67                 in the generic [Unit] and [Install] sections. The
  68                 mount specific configuration options are configured
  69                 in the [Mount] section.</para>
  70
  71                 <para>Additional options are listed in
  72                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  73
  74                 <para>Mount units must be named after the mount point
  75                 directories they control. Example: the mount point
  76                 <filename>/home/lennart</filename> must be configured
  77                 in a unit file
  78                 <filename>home-lennart.mount</filename>. For details
  79                 about the escaping logic used to convert a file system
  80                 path to a unit name see
  81                 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  82
  83                 <para>Optionally, a mount unit may be accompanied by
  84                 an automount unit, to allow on-demand or parallelized
  85                 mounting. See
  86                 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  87
  88                 <para>If an mount point is beneath another mount point
  89                 in the file system hierarchy a dependency between both
  90                 units is created automatically.</para>
  91         </refsect1>
  92
  93         <refsect1>
  94                 <title><filename>fstab</filename></title>
  95
  96                 <para>Mount units may either be configured via unit
  97                 files, or via <filename>/etc/fstab</filename> (see
  98                 <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  99                 for details).</para>
 100
 101                 <para>When reading <filename>/etc/fstab</filename> a
 102                 few special mount options are understood by systemd
 103                 which influence how dependencies are created for mount
 104                 points from <filename>/etc/fstab</filename>. If
 105                 <option>comment=systemd.mount</option> is specified as
 106                 mount option then systemd will create a dependency of
 107                 type <option>Wants</option> from either
 108                 <filename>local-fs.target</filename> or
 109                 <filename>remote-fs.target</filename>, depending
 110                 whether the file system is local or remote. If
 111                 <option>comment=systemd.automount</option> is set, an
 112                 automount unit will be created for the file system. See
 113                 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 114                 for details.</para>
 115
 116                 <para>If a mount point is configured in both
 117                 <filename>/etc/fstab</filename> and a unit file the
 118                 configuration in the latter takes precedence.</para>
 119         </refsect1>
 120
 121         <refsect1>
 122                 <title>Options</title>
 123
 124                 <para>Mount files must include a [Mount] section,
 125                 which carries information about the file system mount points it
 126                 supervises. A number of options that may be used in
 127                 this section are shared with other unit types. These
 128                 options are documented in
 129                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
 130                 options specific to the [Mount] section of mount
 131                 units are the following:</para>
 132
 133                 <variablelist>
 134
 135                         <varlistentry>
 136                                 <term><varname>What=</varname></term>
 137                                 <listitem><para>Takes an absolute path
 138                                 of a device node, file or other
 139                                 resource to mount. See
 140                                 <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 141                                 for details. If this refers to a
 142                                 device node a dependency on the
 143                                 respective device unit is
 144                                 automatically created. (See
 145                                 <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.)
 146                                 This option is
 147                                 mandatory.</para></listitem>
 148                         </varlistentry>
 149
 150                         <varlistentry>
 151                                 <term><varname>Where=</varname></term>
 152                                 <listitem><para>Takes an absolute path
 153                                 of a directory of the mount point. If
 154                                 the mount point is not existing at
 155                                 time of mounting it is created. This
 156                                 string must be reflected in the unit
 157                                 file name. (See above.) This option is
 158                                 mandatory.</para></listitem>
 159                         </varlistentry>
 160
 161                         <varlistentry>
 162                                 <term><varname>Type=</varname></term>
 163                                 <listitem><para>Takes a string for the
 164                                 filesystem type. See
 165                                 <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 166                                 for details. This setting is
 167                                 optional.</para></listitem>
 168                         </varlistentry>
 169
 170                         <varlistentry>
 171                                 <term><varname>Options=</varname></term>
 172
 173                                 <listitem><para>Mount options to use
 174                                 when mounting. This takes a comma
 175                                 seperated list of options. This
 176                                 setting is optional.</para></listitem>
 177                         </varlistentry>
 178
 179                         <varlistentry>
 180                                 <term><varname>DirectoryMode=</varname></term>
 181                                 <listitem><para>Directories of mount
 182                                 points (and any parent directories)
 183                                 are automatically created if
 184                                 needed. This option specifies the file
 185                                 system access mode used when creating
 186                                 these directories. Defaults to
 187                                 0755.</para></listitem>
 188                         </varlistentry>
 189
 190                         <varlistentry>
 191                                 <term><varname>TimeoutSec=</varname></term>
 192                                 <listitem><para>Configures the time to
 193                                 wait for the mount command to
 194                                 finish. If a comand does not exit
 195                                 within the configured time the mount
 196                                 will be considered failed and be shut
 197                                 down again. All commands still running
 198                                 will be terminated forcibly via
 199                                 SIGTERM, and after another delay of
 200                                 this time with SIGKILL. (See
 201                                 <option>KillMode=</option> below.)
 202                                 Takes a unit-less value in seconds, or
 203                                 a time span value such as "5min
 204                                 20s". Pass 0 to disable the timeout
 205                                 logic. Defaults to
 206                                 60s.</para></listitem>
 207                         </varlistentry>
 208
 209                         <varlistentry>
 210                                 <term><varname>KillMode=</varname></term>
 211                                 <listitem><para>Specifies how
 212                                 processes of this mount shall be
 213                                 killed. One of
 214                                 <option>control-group</option>,
 215                                 <option>process-group</option>,
 216                                 <option>process</option>,
 217                                 <option>none</option>.</para>
 218
 219                                 <para>This option is mostly equivalent
 220                                 to the <option>KillMode=</option>
 221                                 option of service files. See
 222                                 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 223                                 for details.</para></listitem>
 224                         </varlistentry>
 225                 </variablelist>
 226         </refsect1>
 227
 228         <refsect1>
 229                   <title>See Also</title>
 230                   <para>
 231                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 232                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 233                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 234                           <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 235                           <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 236                           <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 237                   </para>
 238         </refsect1>
 239
 240 </refentry>