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 file paths
  75                 they reflect. 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         </refsect1>
  88
  89         <refsect1>
  90                 <title><filename>fstab</filename></title>
  91
  92                 <para>Mount units may either be configured via unit
  93                 files, or via <filename>/etc/fstab</filename> (see
  94                 <citerefentry><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  95                 for details).</para>
  96
  97                 <para>When reading <filename>/etc/fstab</filename> a
  98                 few special mount options are understood by systemd
  99                 which influence how dependencies are created for mount
 100                 points from <filename>/etc/fstab</filename>. If
 101                 <option>comment=systemd.mount</option> is specified as
 102                 mount option then systemd will create a dependency of
 103                 type <option>Wants</option> from either
 104                 <filename>local-fs.target</filename> or
 105                 <filename>remote-fs.target</filename>, depending
 106                 whether the file system is local or remote. If
 107                 <option>comment=systemd.automount</option> is set, an
 108                 automount unit will be created for the file system. See
 109                 <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 110                 for details.</para>
 111
 112                 <para>If a mount point is configured in both
 113                 <filename>/etc/fstab</filename> and a unit file the
 114                 configuration in the latter takes precedence.</para>
 115         </refsect1>
 116
 117         <refsect1>
 118                 <title>Options</title>
 119
 120                 <para>Mount files must include a [Mount] section,
 121                 which carries information about the file system mount points it
 122                 supervises. A number of options that may be used in
 123                 this section are shared with other unit types. These
 124                 options are documented in
 125                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
 126                 options specific to the [Mount] section of mount
 127                 units are the following:</para>
 128
 129                 <variablelist>
 130
 131                         <varlistentry>
 132                                 <term><varname>What=</varname></term>
 133                                 <listitem><para>Takes an absolute path
 134                                 of a device node, file or other
 135                                 resource to mount. See
 136                                 <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 137                                 for details. If this refers to a
 138                                 device node a dependency on the
 139                                 respective device unit is
 140                                 automatically created. (See
 141                                 <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.)
 142                                 This option is
 143                                 mandatory.</para></listitem>
 144                         </varlistentry>
 145
 146                         <varlistentry>
 147                                 <term><varname>Where=</varname></term>
 148                                 <listitem><para>Takes an absolute path
 149                                 of a directory of the mount point. If
 150                                 the mount point is not existing at
 151                                 time of mounting it is created. This
 152                                 string must be reflected in the unit
 153                                 file name. (See above.) This option is
 154                                 mandatory.</para></listitem>
 155                         </varlistentry>
 156
 157                         <varlistentry>
 158                                 <term><varname>Type=</varname></term>
 159                                 <listitem><para>Takes a string for the
 160                                 filesystem type. See
 161                                 <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 162                                 for details. This setting is
 163                                 optional.</para></listitem>
 164                         </varlistentry>
 165
 166                         <varlistentry>
 167                                 <term><varname>Options=</varname></term>
 168
 169                                 <listitem><para>Mount options to use
 170                                 when mounting. This takes a comma
 171                                 seperated list of options. This
 172                                 setting is optional.</para></listitem>
 173                         </varlistentry>
 174
 175                         <varlistentry>
 176                                 <term><varname>DirectoryMode=</varname></term>
 177                                 <listitem><para>Directories of mount
 178                                 points (and any parent directories)
 179                                 are automatically created if
 180                                 needed. This option specifies the file
 181                                 system access mode used when creating
 182                                 these directories. Defaults to
 183                                 0755.</para></listitem>
 184                         </varlistentry>
 185
 186                         <varlistentry>
 187                                 <term><varname>TimeoutSec=</varname></term>
 188                                 <listitem><para>Configures the time to
 189                                 wait for the mount command to
 190                                 finish. If a comand does not exit
 191                                 within the configured time the mount
 192                                 will be considered failed and be shut
 193                                 down again. All commands still running
 194                                 will be terminated forcibly via
 195                                 SIGTERM, and after another delay of
 196                                 this time with SIGKILL. (See
 197                                 <option>KillMode=</option> below.)
 198                                 Takes a unit-less value in seconds, or
 199                                 a time span value such as "5min
 200                                 20s". Pass 0 to disable the timeout
 201                                 logic. Defaults to
 202                                 60s.</para></listitem>
 203                         </varlistentry>
 204
 205                         <varlistentry>
 206                                 <term><varname>KillMode=</varname></term>
 207                                 <listitem><para>Specifies how
 208                                 processes of this mount shall be
 209                                 killed. One of
 210                                 <option>control-group</option>,
 211                                 <option>process-group</option>,
 212                                 <option>process</option>,
 213                                 <option>none</option>.</para>
 214
 215                                 <para>This option is mostly equivalent
 216                                 to the <option>KillMode=</option>
 217                                 option of service files. See
 218                                 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 219                                 for details.</para></listitem>
 220                         </varlistentry>
 221                 </variablelist>
 222         </refsect1>
 223
 224         <refsect1>
 225                   <title>See Also</title>
 226                   <para>
 227                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 228                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 229                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 230                           <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 231                           <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 232                           <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 233                   </para>
 234         </refsect1>
 235
 236 </refentry>