man/systemd.mount.5

   1 '\" t
   2 .\"     Title: systemd.mount
   3 .\"    Author: Lennart Poettering <lennart@poettering.net>
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 02/15/2012
   6 .\"    Manual: systemd.mount
   7 .\"    Source: systemd
   8 .\"  Language: English
   9 .\"
  10 .TH "SYSTEMD\&.MOUNT" "5" "02/15/2012" "systemd" "systemd.mount"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 systemd.mount \- systemd mount configuration files
  32 .SH "SYNOPSIS"
  33 .PP
  34 systemd\&.mount
  35 .SH "DESCRIPTION"
  36 .PP
  37 A unit configuration file whose name ends in
  38 \&.mount
  39 encodes information about a file system mount point controlled and supervised by systemd\&.
  40 .PP
  41 This man page lists the configuration options specific to this unit type\&. See
  42 \fBsystemd.unit\fR(5)
  43 for the common options of all unit configuration files\&. The common configuration items are configured in the generic [Unit] and [Install] sections\&. The mount specific configuration options are configured in the [Mount] section\&.
  44 .PP
  45 Additional options are listed in
  46 \fBsystemd.exec\fR(5), which define the execution environment the
  47 \fBmount\fR(8)
  48 binary is executed in\&.
  49 .PP
  50 Mount units must be named after the mount point directories they control\&. Example: the mount point
  51 /home/lennart
  52 must be configured in a unit file
  53 home\-lennart\&.mount\&. For details about the escaping logic used to convert a file system path to a unit name see
  54 \fBsystemd.unit\fR(5)\&.
  55 .PP
  56 Optionally, a mount unit may be accompanied by an automount unit, to allow on\-demand or parallelized mounting\&. See
  57 \fBsystemd.automount\fR(5)\&.
  58 .PP
  59 If an mount point is beneath another mount point in the file system hierarchy, a dependency between both units is created automatically\&.
  60 .PP
  61 Mount points created at runtime independent on unit files or
  62 /etc/fstab
  63 will be monitored by systemd and appear like any other mount unit in systemd\&.
  64 .SH "/ETC/FSTAB"
  65 .PP
  66 Mount units may either be configured via unit files, or via
  67 /etc/fstab
  68 (see
  69 \fBfstab\fR(5)
  70 for details)\&.
  71 .PP
  72 When reading
  73 /etc/fstab
  74 a few special mount options are understood by systemd which influence how dependencies are created for mount points from
  75 /etc/fstab\&. If
  76 \fBMountAuto=yes\fR
  77 is set in
  78 system\&.conf
  79 (which is the default), or if
  80 \fBx\-systemd\&.mount\fR
  81 is specified as mount option, then systemd will create a dependency of type
  82 \fBWants\fR
  83 from either
  84 local\-fs\&.target
  85 or
  86 remote\-fs\&.target, depending whether the file system is local or remote\&. If
  87 \fBx\-systemd\&.automount\fR
  88 is set, an automount unit will be created for the file system\&. See
  89 \fBsystemd.automount\fR(5)
  90 for details\&. If
  91 \fBx\-systemd\-device\-timeout=\fR
  92 is specified it may be used to configure how long systemd should wait for a device to show up before giving up on an entry from
  93 /etc/fstab\&. Specify a time in seconds or explicitly specifiy a unit as
  94 s,
  95 min,
  96 h,
  97 ms\&.
  98 .PP
  99 If a mount point is configured in both
 100 /etc/fstab
 101 and a unit file, the configuration in the latter takes precedence\&.
 102 .SH "OPTIONS"
 103 .PP
 104 Mount files must include a [Mount] section, which carries information about the file system mount points it supervises\&. A number of options that may be used in this section are shared with other unit types\&. These options are documented in
 105 \fBsystemd.exec\fR(5)\&. The options specific to the [Mount] section of mount units are the following:
 106 .PP
 107 \fIWhat=\fR
 108 .RS 4
 109 Takes an absolute path of a device node, file or other resource to mount\&. See
 110 \fBmount\fR(8)
 111 for details\&. If this refers to a device node, a dependency on the respective device unit is automatically created\&. (See
 112 \fBsystemd.device\fR(5)
 113 for more information\&.) This option is mandatory\&.
 114 .RE
 115 .PP
 116 \fIWhere=\fR
 117 .RS 4
 118 Takes an absolute path of a directory of the mount point\&. If the mount point is not existing at time of mounting, it is created\&. This string must be reflected in the unit file name\&. (See above\&.) This option is mandatory\&.
 119 .RE
 120 .PP
 121 \fIType=\fR
 122 .RS 4
 123 Takes a string for the filesystem type\&. See
 124 \fBmount\fR(8)
 125 for details\&. This setting is optional\&.
 126 .RE
 127 .PP
 128 \fIOptions=\fR
 129 .RS 4
 130 Mount options to use when mounting\&. This takes a comma separated list of options\&. This setting is optional\&.
 131 .RE
 132 .PP
 133 \fIDirectoryMode=\fR
 134 .RS 4
 135 Directories of mount points (and any parent directories) are automatically created if needed\&. This option specifies the file system access mode used when creating these directories\&. Takes an access mode in octal notation\&. Defaults to 0755\&.
 136 .RE
 137 .PP
 138 \fITimeoutSec=\fR
 139 .RS 4
 140 Configures the time to wait for the mount command to finish\&. If a command does not exit within the configured time the mount will be considered failed and be shut down again\&. All commands still running will be terminated forcibly via SIGTERM, and after another delay of this time with SIGKILL\&. (See
 141 \fBKillMode=\fR
 142 below\&.) Takes a unit\-less value in seconds, or a time span value such as "5min 20s"\&. Pass 0 to disable the timeout logic\&. Defaults to 90s\&.
 143 .RE
 144 .PP
 145 \fIKillMode=\fR
 146 .RS 4
 147 Specifies how processes of this mount shall be killed\&. One of
 148 \fBcontrol\-group\fR,
 149 \fBprocess\fR,
 150 \fBnone\fR\&.
 151 .sp
 152 This option is mostly equivalent to the
 153 \fBKillMode=\fR
 154 option of service files\&. See
 155 \fBsystemd.service\fR(5)
 156 for details\&.
 157 .RE
 158 .PP
 159 \fIKillSignal=\fR
 160 .RS 4
 161 Specifies which signal to use when killing a process of this mount\&. Defaults to SIGTERM\&.
 162 .RE
 163 .PP
 164 \fISendSIGKILL=\fR
 165 .RS 4
 166 Specifies whether to send SIGKILL to remaining processes after a timeout, if the normal shutdown procedure left processes of the mount around\&. Takes a boolean value\&. Defaults to "yes"\&.
 167 .RE
 168 .SH "SEE ALSO"
 169 .PP
 170
 171 \fBsystemd\fR(1),
 172 \fBsystemctl\fR(8),
 173 \fBsystemd.unit\fR(5),
 174 \fBsystemd.exec\fR(5),
 175 \fBsystemd.device\fR(5),
 176 \fBmount\fR(8)
 177 .SH "AUTHOR"
 178 .PP
 179 \fBLennart Poettering\fR <\&lennart@poettering\&.net\&>
 180 .RS 4
 181 Developer
 182 .RE