man/systemd-mount.xml

   1 <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   This file is part of systemd.
   7
   8   Copyright 2016 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="systemd-mount"
  25           xmlns:xi="http://www.w3.org/2001/XInclude">
  26
  27   <refentryinfo>
  28     <title>systemd-mount</title>
  29     <productname>systemd</productname>
  30
  31     <authorgroup>
  32       <author>
  33         <contrib>Developer</contrib>
  34         <firstname>Lennart</firstname>
  35         <surname>Poettering</surname>
  36         <email>lennart@poettering.net</email>
  37       </author>
  38     </authorgroup>
  39   </refentryinfo>
  40
  41   <refmeta>
  42     <refentrytitle>systemd-mount</refentrytitle>
  43     <manvolnum>1</manvolnum>
  44   </refmeta>
  45
  46   <refnamediv>
  47     <refname>systemd-mount</refname>
  48     <refname>systemd-umount</refname>
  49     <refpurpose>Establish and destroy transient mount or auto-mount points</refpurpose>
  50   </refnamediv>
  51
  52   <refsynopsisdiv>
  53     <cmdsynopsis>
  54       <command>systemd-mount</command>
  55       <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
  56       <arg choice="plain"><replaceable>WHAT</replaceable></arg>
  57       <arg choice="opt"><replaceable>WHERE</replaceable></arg>
  58     </cmdsynopsis>
  59     <cmdsynopsis>
  60       <command>systemd-mount</command>
  61       <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
  62       <arg choice="plain"><option>--list</option></arg>
  63     </cmdsynopsis>
  64     <cmdsynopsis>
  65       <command>systemd-mount</command>
  66       <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
  67       <arg choice="plain"><option>--umount</option></arg>
  68       <arg choice="plain" rep="repeat"><replaceable>WHAT|WHERE</replaceable></arg>
  69     </cmdsynopsis>
  70   </refsynopsisdiv>
  71
  72   <refsect1>
  73     <title>Description</title>
  74
  75     <para><command>systemd-mount</command> may be used to create and start a transient <filename>.mount</filename> or
  76     <filename>.automount</filename> unit of the file system <replaceable>WHAT</replaceable> on the mount point
  77     <replaceable>WHERE</replaceable>.</para>
  78
  79     <para>In many ways, <command>systemd-mount</command> is similar to the lower-level
  80     <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> command, however instead
  81     of executing the mount operation directly and immediately, <command>systemd-mount</command> schedules it through
  82     the service manager job queue, so that it may pull in further dependencies (such as parent mounts, or a file system
  83     checker to execute a priori), and may make use of the auto-mounting logic.</para>
  84
  85     <para>The command takes either one or two arguments. If only one argument is specified it should refer to a block
  86     device or regular file containing a file system (e.g. <literal>/dev/sdb1</literal> or
  87     <literal>/path/to/disk.img</literal>). If it is a block device, which is then probed for a label and other
  88     metadata, and is mounted to a directory whose name is generated from the label. In this mode the block device must
  89     exist at the time of invocation of the command, so that it may be probed. If the device is found to be a removable
  90     block device (e.g. a USB stick) an automount point instead of a regular mount point is created (i.e. the
  91     <option>--automount=</option> option is implied, see below).</para>
  92
  93     <para>If two arguments are specified the first indicates the mount source (the <replaceable>WHAT</replaceable>) and
  94     the second indicates the path to mount it on (the <replaceable>WHERE</replaceable>). In this mode no probing of the
  95     source is attempted, and a backing device node doesn't have to exist yet. However, if this mode is combined with
  96     <option>--discover</option>, device node probing for additional metadata is enabled, and – much like in the
  97     single-argument case discussed above – the specified device has to exist at the time of invocation of the
  98     command.</para>
  99
 100     <para>Use the <option>--list</option> command to show a terse table of all local, known block devices with file
 101     systems that may be mounted with this command.</para>
 102
 103     <para><command>systemd-umount</command> can be used to unmount a mount or automount point. It is the same
 104     as <command>systemd-mount</command> <option>--umount</option>.</para>
 105   </refsect1>
 106
 107   <refsect1>
 108     <title>Options</title>
 109
 110     <para>The following options are understood:</para>
 111
 112     <variablelist>
 113
 114       <varlistentry>
 115         <term><option>--no-block</option></term>
 116
 117         <listitem>
 118           <para>Do not synchronously wait for the requested operation to finish. If this is not specified, the job will
 119           be verified, enqueued and <command>systemd-mount</command> will wait until the mount or automount unit's
 120           start-up is completed. By passing this argument, it is only verified and enqueued.</para>
 121         </listitem>
 122       </varlistentry>
 123
 124       <xi:include href="standard-options.xml" xpointer="no-pager"/>
 125       <xi:include href="standard-options.xml" xpointer="no-ask-password"/>
 126
 127       <varlistentry>
 128         <term><option>--quiet</option></term>
 129         <term><option>-q</option></term>
 130
 131         <listitem><para>Suppresses additional informational output while running.</para></listitem>
 132       </varlistentry>
 133
 134       <varlistentry>
 135         <term><option>--discover</option></term>
 136
 137         <listitem><para>Enable probing of the mount source. This switch is implied if a single argument is specified on
 138         the command line. If passed, additional metadata is read from the device to enhance the unit to create. For
 139         example, a descriptive string for the transient units is generated from the file system label and device
 140         model. Moreover if a removable block device (e.g. USB stick) is detected an automount unit instead of a regular
 141         mount unit is created, with a short idle time-out, in order to ensure the file-system is placed in a clean
 142         state quickly after each access.</para></listitem>
 143       </varlistentry>
 144
 145       <varlistentry>
 146         <term><option>--type=</option></term>
 147         <term><option>-t</option></term>
 148
 149         <listitem><para>Specifies the file system type to mount (e.g. <literal>vfat</literal>, <literal>ext4</literal>,
 150         …). If omitted (or set to <literal>auto</literal>) the file system is determined automatically.</para></listitem>
 151       </varlistentry>
 152
 153       <varlistentry>
 154         <term><option>--options=</option></term>
 155         <term><option>-o</option></term>
 156
 157         <listitem><para>Additional mount options for the mount point.</para></listitem>
 158       </varlistentry>
 159
 160       <varlistentry>
 161         <term><option>--fsck=</option></term>
 162
 163         <listitem><para>Takes a boolean argument, defaults to on. Controls whether to run a file system check
 164         immediately before the mount operation. In the automount case (see <option>--automount=</option> below) the
 165         check will be run the moment the first access to the device is made, which might slightly delay the
 166         access.</para></listitem>
 167       </varlistentry>
 168
 169       <varlistentry>
 170         <term><option>--description=</option></term>
 171
 172         <listitem><para>Provide a description for the mount or automount unit. See <varname>Description=</varname> in
 173         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 174         </para></listitem>
 175       </varlistentry>
 176
 177       <varlistentry>
 178         <term><option>--property=</option></term>
 179         <term><option>-p</option></term>
 180
 181         <listitem><para>Sets a unit property for the mount unit that is created. This takes an assignment in the same
 182         format as <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
 183         <command>set-property</command> command.</para>
 184         </listitem>
 185       </varlistentry>
 186
 187       <varlistentry>
 188         <term><option>--automount=</option></term>
 189
 190         <listitem><para>Takes a boolean argument. Controls whether to create an automount point or a regular mount
 191         point. If true an automount point is created that is backed by the actual file system at the time of first
 192         access. If false a plain mount point is created that is backed by the actual file system immediately. Automount
 193         points have the benefit that the file system stays unmounted and hence in clean state until it is first
 194         accessed. In automount mode the <option>--timeout-idle-sec=</option> switch (see below) may be used to ensure
 195         the mount point is unmounted automatically after the last access and an idle period passed.</para>
 196
 197         <para>If this switch is not specified it defaults to false. If not specified and <option>--discover</option> is
 198         used (or only a single argument passed, which implies <option>--discover</option>, see above), and the file
 199         system block device is detected to be removable, it is set to true, in order to increase the chance that the
 200         file system is in a fully clean state if the device is unplugged abruptly.</para></listitem>
 201       </varlistentry>
 202
 203       <varlistentry>
 204         <term><option>-A</option></term>
 205
 206         <listitem><para>Equivalent to <option>--automount=yes</option>.</para></listitem>
 207       </varlistentry>
 208
 209       <varlistentry>
 210         <term><option>--timeout-idle-sec=</option></term>
 211
 212         <listitem><para>Takes a time value that controls the idle timeout in automount mode. If set to
 213         <literal>infinity</literal> (the default) no automatic unmounts are done. Otherwise the file system backing the
 214         automount point is detached after the last access and the idle timeout passed. See
 215         <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details on
 216         the time syntax supported. This option has no effect if only a regular mount is established, and automounting
 217         is not used.</para>
 218
 219         <para>Note that if <option>--discover</option> is used (or only a single argument passed, which implies
 220         <option>--discover</option>, see above), and the file system block device is detected to be removable,
 221         <option>--timeout-idle-sec=1s</option> is implied.</para></listitem>
 222       </varlistentry>
 223
 224       <varlistentry>
 225         <term><option>--automount-property=</option></term>
 226
 227         <listitem><para>Similar to <option>--property=</option>, but applies additional properties to the automount
 228         unit created, instead of the mount unit.</para></listitem>
 229       </varlistentry>
 230
 231       <varlistentry>
 232         <term><option>--bind-device=</option></term>
 233
 234         <listitem><para>Takes a boolean argument, defaults to off. This option only has an effect in automount mode,
 235         and controls whether the automount unit shall be bound to the backing device's lifetime. If enabled, the
 236         automount point will be removed automatically when the backing device vanishes. If disabled the automount point
 237         stays around, and subsequent accesses will block until backing device is replugged. This option has no effect
 238         in case of non-device mounts, such as network or virtual file system mounts.</para>
 239
 240         <para>Note that if <option>--discover</option> is used (or only a single argument passed, which implies
 241         <option>--discover</option>, see above), and the file system block device is detected to be removable, this
 242         option is implied.</para></listitem>
 243       </varlistentry>
 244
 245       <varlistentry>
 246         <term><option>--list</option></term>
 247
 248         <listitem><para>Instead of establishing a mount or automount point, print a terse list of block devices
 249         containing file systems that may be mounted with <literal>systemd-mount</literal>, along with useful metadata
 250         such as labels, etc.</para></listitem>
 251       </varlistentry>
 252
 253       <varlistentry>
 254         <term><option>-u</option></term>
 255         <term><option>--umount</option></term>
 256
 257         <listitem><para>Stop the mount and automount units corresponding to the specified mount points
 258         <replaceable>WHERE</replaceable> or the devices <replaceable>WHAT</replaceable>.
 259         <command>systemd-mount</command> with this option or <command>systemd-umount</command> can take multiple arguments
 260         which can be mount points, devices, <filename>/etc/fstab</filename> style node names, or backing files
 261         corresponding to loop devices, like
 262         <command>systemd-mount --umount /path/to/umount /dev/sda1 UUID=xxxxxx-xxxx LABEL=xxxxx /path/to/disk.img</command>.
 263         Note that when <option>-H</option> or <option>-M</option> is specified, only absolute paths to mount points are
 264         supported.</para></listitem>
 265       </varlistentry>
 266
 267       <varlistentry>
 268         <term><option>-G</option></term>
 269         <term><option>--collect</option></term>
 270
 271         <listitem><para>Unload the transient unit after it completed, even if it failed. Normally, without this option,
 272         all mount units that mount and failed are kept in memory until the user explicitly resets their failure state with
 273         <command>systemctl reset-failed</command> or an equivalent command. On the other hand, units that stopped
 274         successfully are unloaded immediately. If this option is turned on the "garbage collection" of units is more
 275         agressive, and unloads units regardless if they exited successfully or failed. This option is a shortcut for
 276         <command>--property=CollectMode=inactive-or-failed</command>, see the explanation for
 277         <varname>CollectMode=</varname> in
 278         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for further
 279         information.</para></listitem>
 280       </varlistentry>
 281
 282       <xi:include href="user-system-options.xml" xpointer="user" />
 283       <xi:include href="user-system-options.xml" xpointer="system" />
 284       <xi:include href="user-system-options.xml" xpointer="host" />
 285       <xi:include href="user-system-options.xml" xpointer="machine" />
 286
 287       <xi:include href="standard-options.xml" xpointer="help" />
 288       <xi:include href="standard-options.xml" xpointer="version" />
 289     </variablelist>
 290
 291   </refsect1>
 292
 293   <refsect1>
 294     <title>Exit status</title>
 295
 296     <para>On success, 0 is returned, a non-zero failure
 297     code otherwise.</para>
 298   </refsect1>
 299
 300   <refsect1>
 301     <title>The udev Database</title>
 302
 303     <para>If <option>--discover</option> is used, <command>systemd-mount</command> honors a couple of additional udev
 304     properties of block devices:</para>
 305
 306     <variablelist class='udev-directives'>
 307       <varlistentry>
 308         <term><varname>SYSTEMD_MOUNT_OPTIONS=</varname></term>
 309
 310         <listitem><para>The mount options to use, if <option>--options=</option> is not used.</para></listitem>
 311       </varlistentry>
 312
 313       <varlistentry>
 314         <term><varname>SYSTEMD_MOUNT_WHERE=</varname></term>
 315
 316         <listitem><para>The file system path to place the mount point at, instead of the automatically generated
 317         one.</para></listitem>
 318       </varlistentry>
 319     </variablelist>
 320   </refsect1>
 321
 322   <refsect1>
 323     <title>See Also</title>
 324     <para>
 325       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 326       <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 327       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 328       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 329       <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 330       <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 331       <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 332     </para>
 333   </refsect1>
 334
 335 </refentry>