man/systemd-mount.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="systemd-mount"
   7           xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>systemd-mount</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-mount</refentrytitle>
  16     <manvolnum>1</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-mount</refname>
  21     <refname>systemd-umount</refname>
  22     <refpurpose>Establish and destroy transient mount or auto-mount points</refpurpose>
  23   </refnamediv>
  24
  25   <refsynopsisdiv>
  26     <cmdsynopsis>
  27       <command>systemd-mount</command>
  28       <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
  29       <arg choice="plain"><replaceable>WHAT</replaceable></arg>
  30       <arg choice="opt"><replaceable>WHERE</replaceable></arg>
  31     </cmdsynopsis>
  32     <cmdsynopsis>
  33       <command>systemd-mount</command>
  34       <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
  35       <arg choice="plain"><option>--tmpfs</option></arg>
  36       <arg choice="opt"><replaceable>NAME</replaceable></arg>
  37       <arg choice="plain"><replaceable>WHERE</replaceable></arg>
  38     </cmdsynopsis>
  39     <cmdsynopsis>
  40       <command>systemd-mount</command>
  41       <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
  42       <arg choice="plain"><option>--list</option></arg>
  43     </cmdsynopsis>
  44     <cmdsynopsis>
  45       <command>systemd-mount</command>
  46       <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
  47       <arg choice="plain"><option>--umount</option></arg>
  48       <arg choice="plain" rep="repeat"><replaceable>WHAT|WHERE</replaceable></arg>
  49     </cmdsynopsis>
  50   </refsynopsisdiv>
  51
  52   <refsect1>
  53     <title>Description</title>
  54
  55     <para><command>systemd-mount</command> may be used to create and start a transient <filename>.mount</filename> or
  56     <filename>.automount</filename> unit of the file system <replaceable>WHAT</replaceable> on the mount point
  57     <replaceable>WHERE</replaceable>.</para>
  58
  59     <para>In many ways, <command>systemd-mount</command> is similar to the lower-level
  60     <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  61     command, however instead of executing the mount operation directly and immediately,
  62     <command>systemd-mount</command> schedules it through the service manager job queue, so that it may pull
  63     in further dependencies (such as parent mounts, or a file system checker to execute a priori), and may
  64     make use of the auto-mounting logic.</para>
  65
  66     <para>The command takes either one or two arguments. If only one argument is specified it should refer to
  67     a block device or regular file containing a file system (e.g. <literal>/dev/sdb1</literal> or
  68     <literal>/path/to/disk.img</literal>). The block device or image file is then probed for a file system
  69     label and other metadata, and is mounted to a directory below <filename>/run/media/system/</filename>
  70     whose name is generated from the file system label. In this mode the block device or image file must
  71     exist at the time of invocation of the command, so that it may be probed. If the device is found to be a
  72     removable block device (e.g. a USB stick), an automount point is created instead of a regular mount point
  73     (i.e. the <option>--automount=</option> option is implied, see below). If the option
  74     <option>--tmpfs</option> is specified, then the argument is interpreted as the path where the new
  75     temporary file system shall be mounted.</para>
  76
  77     <para>If two arguments are specified, the first indicates the mount source (the
  78     <replaceable>WHAT</replaceable>) and the second indicates the path to mount it on (the
  79     <replaceable>WHERE</replaceable>). In this mode no probing of the source is attempted, and a backing
  80     device node does not have to exist. However, if this mode is combined with <option>--discover</option>,
  81     device node probing for additional metadata is enabled, and – much like in the single-argument case
  82     discussed above – the specified device has to exist at the time of invocation of the command.</para>
  83
  84     <para>Use the <option>--list</option> command to show a terse table of all local, known block devices with file
  85     systems that may be mounted with this command.</para>
  86
  87     <para><command>systemd-umount</command> can be used to unmount a mount or automount point. It is the same
  88     as <command>systemd-mount</command> <option>--umount</option>.</para>
  89   </refsect1>
  90
  91   <refsect1>
  92     <title>Options</title>
  93
  94     <para>The following options are understood:</para>
  95
  96     <variablelist>
  97
  98       <varlistentry>
  99         <term><option>--no-block</option></term>
 100
 101         <listitem>
 102           <para>Do not synchronously wait for the requested operation to finish. If this is not specified, the job will
 103           be verified, enqueued and <command>systemd-mount</command> will wait until the mount or automount unit's
 104           start-up is completed. By passing this argument, it is only verified and enqueued.</para>
 105
 106           <xi:include href="version-info.xml" xpointer="v232"/>
 107         </listitem>
 108       </varlistentry>
 109
 110       <varlistentry>
 111         <term><option>-l</option></term>
 112         <term><option>--full</option></term>
 113
 114         <listitem>
 115           <para>Do not ellipsize the output when <option>--list</option> is specified.</para>
 116
 117         <xi:include href="version-info.xml" xpointer="v245"/>
 118         </listitem>
 119       </varlistentry>
 120
 121       <xi:include href="standard-options.xml" xpointer="no-pager"/>
 122       <xi:include href="standard-options.xml" xpointer="no-legend" />
 123       <xi:include href="standard-options.xml" xpointer="no-ask-password"/>
 124       <xi:include href="standard-options.xml" xpointer="json"/>
 125
 126       <varlistentry>
 127         <term><option>--quiet</option></term>
 128         <term><option>-q</option></term>
 129
 130         <listitem><para>Suppresses additional informational output while running.</para>
 131
 132         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 133       </varlistentry>
 134
 135       <varlistentry>
 136         <term><option>--discover</option></term>
 137
 138         <listitem><para>Enable probing of the mount source. This switch is implied if a single argument is specified on
 139         the command line. If passed, additional metadata is read from the device to enhance the unit to create. For
 140         example, a descriptive string for the transient units is generated from the file system label and device
 141         model. Moreover, if a removable block device (e.g. USB stick) is detected an automount unit instead of a regular
 142         mount unit is created, with a short idle timeout, in order to ensure the file-system is placed in a clean
 143         state quickly after each access.</para>
 144
 145         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 146       </varlistentry>
 147
 148       <varlistentry>
 149         <term><option>--type=</option></term>
 150         <term><option>-t</option></term>
 151
 152         <listitem><para>Specifies the file system type to mount (e.g. <literal>vfat</literal> or
 153         <literal>ext4</literal>). If omitted or set to <literal>auto</literal>, the file system type is
 154         determined automatically.</para>
 155
 156         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 157       </varlistentry>
 158
 159       <varlistentry>
 160         <term><option>--options=</option></term>
 161         <term><option>-o</option></term>
 162
 163         <listitem><para>Additional mount options for the mount point.</para>
 164
 165         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 166       </varlistentry>
 167
 168       <varlistentry>
 169         <term><option>--owner=<replaceable>USER</replaceable></option></term>
 170
 171         <listitem><para>Let the specified user <replaceable>USER</replaceable> own the mounted file system.
 172         This is done by appending <option>uid=</option> and <option>gid=</option> options to the list
 173         of mount options. Only certain file systems support this option.</para>
 174
 175         <xi:include href="version-info.xml" xpointer="v237"/></listitem>
 176       </varlistentry>
 177
 178       <varlistentry>
 179         <term><option>--fsck=</option></term>
 180
 181         <listitem><para>Takes a boolean argument, defaults to on. Controls whether to run a file system check
 182         immediately before the mount operation. In the automount case (see <option>--automount=</option> below) the
 183         check will be run the moment the first access to the device is made, which might slightly delay the
 184         access.</para>
 185
 186         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 187       </varlistentry>
 188
 189       <varlistentry>
 190         <term><option>--description=</option></term>
 191
 192         <listitem><para>Provide a description for the mount or automount unit. See <varname>Description=</varname> in
 193         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 194         </para>
 195
 196         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 197       </varlistentry>
 198
 199       <varlistentry>
 200         <term><option>--property=</option></term>
 201         <term><option>-p</option></term>
 202
 203         <listitem><para>Sets a unit property for the mount unit that is created. This takes an assignment in the same
 204         format as <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
 205         <command>set-property</command> command.</para>
 206
 207         <xi:include href="version-info.xml" xpointer="v232"/>
 208         </listitem>
 209       </varlistentry>
 210
 211       <varlistentry>
 212         <term><option>--automount=</option></term>
 213
 214         <listitem><para>Takes a boolean argument. Controls whether to create an automount point or a regular mount
 215         point. If true an automount point is created that is backed by the actual file system at the time of first
 216         access. If false a plain mount point is created that is backed by the actual file system immediately. Automount
 217         points have the benefit that the file system stays unmounted and hence in clean state until it is first
 218         accessed. In automount mode the <option>--timeout-idle-sec=</option> switch (see below) may be used to ensure
 219         the mount point is unmounted automatically after the last access and an idle period passed.</para>
 220
 221         <para>If this switch is not specified, it defaults to false. If not specified and <option>--discover</option> is
 222         used (or only a single argument passed, which implies <option>--discover</option>, see above), and the file
 223         system block device is detected to be removable, it is set to true, in order to increase the chance that the
 224         file system is in a fully clean state if the device is unplugged abruptly.</para>
 225
 226         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 227       </varlistentry>
 228
 229       <varlistentry>
 230         <term><option>-A</option></term>
 231
 232         <listitem><para>Equivalent to <option>--automount=yes</option>.</para>
 233
 234         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 235       </varlistentry>
 236
 237       <varlistentry>
 238         <term><option>--timeout-idle-sec=</option></term>
 239
 240         <listitem><para>Takes a time value that controls the idle timeout in automount mode. If set to
 241         <literal>infinity</literal> (the default) no automatic unmounts are done. Otherwise, the file system backing the
 242         automount point is detached after the last access and the idle timeout passed. See
 243         <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details on
 244         the time syntax supported. This option has no effect if only a regular mount is established, and automounting
 245         is not used.</para>
 246
 247         <para>Note that if <option>--discover</option> is used (or only a single argument passed, which implies
 248         <option>--discover</option>, see above), and the file system block device is detected to be removable,
 249         <option>--timeout-idle-sec=1s</option> is implied.</para>
 250
 251         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 252       </varlistentry>
 253
 254       <varlistentry>
 255         <term><option>--automount-property=</option></term>
 256
 257         <listitem><para>Similar to <option>--property=</option>, but applies additional properties to the automount
 258         unit created, instead of the mount unit.</para>
 259
 260         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 261       </varlistentry>
 262
 263       <varlistentry>
 264         <term><option>--bind-device</option></term>
 265
 266         <listitem><para>This option only has an effect in automount mode,
 267         and controls whether the automount unit shall be bound to the backing device's lifetime. If set, the
 268         automount unit will be stopped automatically when the backing device vanishes. By default, the automount unit
 269         stays around, and subsequent accesses will block until backing device is replugged. This option has no effect
 270         in case of non-device mounts, such as network or virtual file system mounts.</para>
 271
 272         <para>Note that if <option>--discover</option> is used (or only a single argument passed, which implies
 273         <option>--discover</option>, see above), and the file system block device is detected to be removable, this
 274         option is implied.</para>
 275
 276         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 277       </varlistentry>
 278
 279       <varlistentry>
 280         <term><option>--list</option></term>
 281
 282         <listitem><para>Instead of establishing a mount or automount point, print a terse list of block devices
 283         containing file systems that may be mounted with <literal>systemd-mount</literal>, along with useful metadata
 284         such as labels, etc.</para>
 285
 286         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 287       </varlistentry>
 288
 289       <varlistentry>
 290         <term><option>-u</option></term>
 291         <term><option>--umount</option></term>
 292
 293         <listitem><para>Stop the mount and automount units corresponding to the specified mount points
 294         <replaceable>WHERE</replaceable> or the devices <replaceable>WHAT</replaceable>.
 295         <command>systemd-mount</command> with this option or <command>systemd-umount</command> can take multiple arguments
 296         which can be mount points, devices, <filename>/etc/fstab</filename> style node names, or backing files
 297         corresponding to loop devices, like
 298         <command>systemd-mount --umount /path/to/umount /dev/sda1 UUID=xxxxxx-xxxx LABEL=xxxxx /path/to/disk.img</command>.
 299         Note that when <option>-H</option> or <option>-M</option> is specified, only absolute paths to mount points are
 300         supported.</para>
 301
 302         <xi:include href="version-info.xml" xpointer="v233"/></listitem>
 303       </varlistentry>
 304
 305       <varlistentry>
 306         <term><option>-G</option></term>
 307         <term><option>--collect</option></term>
 308
 309         <listitem><para>Unload the transient unit after it completed, even if it failed. Normally, without this option,
 310         all mount units that mount and failed are kept in memory until the user explicitly resets their failure state with
 311         <command>systemctl reset-failed</command> or an equivalent command. On the other hand, units that stopped
 312         successfully are unloaded immediately. If this option is turned on the "garbage collection" of units is more
 313         aggressive, and unloads units regardless of whether they exited successfully or failed. This option is a shortcut for
 314         <command>--property=CollectMode=inactive-or-failed</command>, see the explanation for
 315         <varname>CollectMode=</varname> in
 316         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for further
 317         information.</para>
 318
 319         <xi:include href="version-info.xml" xpointer="v236"/></listitem>
 320       </varlistentry>
 321
 322       <varlistentry>
 323         <term><option>-T</option></term>
 324         <term><option>--tmpfs</option></term>
 325
 326         <listitem>
 327           <para>Create and mount a new <constant>tmpfs</constant> file system on
 328           <replaceable>WHERE</replaceable>, with an optional <replaceable>NAME</replaceable> that defaults to
 329           <literal>tmpfs</literal>.</para>
 330
 331           <para>The file system is mounted with the top-level directory mode determined by the
 332           <citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry> setting
 333           of the caller, i.e. <constant>rwxrwxrwx</constant> masked by the umask of the caller. This matches
 334           what
 335           <citerefentry project='man-pages'><refentrytitle>mkdir</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 336           does, but is different from the kernel default of <literal>rwxrwxrwxt</literal>, i.e. a
 337           world-writable directory with the sticky bit set.</para>
 338
 339         <xi:include href="version-info.xml" xpointer="v255"/>
 340         </listitem>
 341       </varlistentry>
 342
 343       <xi:include href="user-system-options.xml" xpointer="user" />
 344       <xi:include href="user-system-options.xml" xpointer="system" />
 345       <xi:include href="user-system-options.xml" xpointer="host" />
 346       <xi:include href="user-system-options.xml" xpointer="machine" />
 347
 348       <xi:include href="standard-options.xml" xpointer="help" />
 349       <xi:include href="standard-options.xml" xpointer="version" />
 350     </variablelist>
 351
 352   </refsect1>
 353
 354   <refsect1>
 355     <title>Exit status</title>
 356
 357     <para>On success, 0 is returned, a non-zero failure
 358     code otherwise.</para>
 359   </refsect1>
 360
 361   <refsect1>
 362     <title>The udev Database</title>
 363
 364     <para>If <option>--discover</option> is used, <command>systemd-mount</command> honors a couple of additional udev
 365     properties of block devices:</para>
 366
 367     <variablelist class='udev-directives'>
 368       <varlistentry>
 369         <term><varname>SYSTEMD_MOUNT_OPTIONS=</varname></term>
 370
 371         <listitem><para>The mount options to use, if <option>--options=</option> is not used.</para>
 372
 373         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 374       </varlistentry>
 375
 376       <varlistentry>
 377         <term><varname>SYSTEMD_MOUNT_WHERE=</varname></term>
 378
 379         <listitem><para>The file system path to place the mount point at, instead of the automatically generated
 380         one.</para>
 381
 382         <xi:include href="version-info.xml" xpointer="v232"/></listitem>
 383       </varlistentry>
 384     </variablelist>
 385   </refsect1>
 386
 387   <refsect1>
 388     <title>Example</title>
 389
 390     <para>Use a udev rule like the following to automatically mount all USB storage plugged in:</para>
 391
 392     <programlisting>ACTION=="add", SUBSYSTEMS=="usb", SUBSYSTEM=="block", ENV{ID_FS_USAGE}=="filesystem", \
 393         RUN{program}+="/usr/bin/systemd-mount --no-block --automount=yes --collect $devnode"</programlisting>
 394   </refsect1>
 395
 396   <refsect1>
 397     <title>See Also</title>
 398     <para><simplelist type="inline">
 399       <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
 400       <member><citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
 401       <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
 402       <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
 403       <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
 404       <member><citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
 405       <member><citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
 406     </simplelist></para>
 407   </refsect1>
 408
 409 </refentry>