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 containing a file system (e.g. <literal>/dev/sdb1</literal>), which is then probed for a label and other
  87     metadata, and is mounted to a directory whose name is generated from the label. In this mode the block device must
  88     exist at the time of invocation of the command, so that it may be probed. If the device is found to be a removable
  89     block device (e.g. a USB stick) an automount point instead of a regular mount point is created (i.e. the
  90     <option>--automount=</option> option is implied, see below).</para>
  91
  92     <para>If two arguments are specified the first indicates the mount source (the <replaceable>WHAT</replaceable>) and
  93     the second indicates the path to mount it on (the <replaceable>WHERE</replaceable>). In this mode no probing of the
  94     source is attempted, and a backing device node doesn't have to exist yet. However, if this mode is combined with
  95     <option>--discover</option>, device node probing for additional metadata is enabled, and – much like in the
  96     single-argument case discussed above – the specified device has to exist at the time of invocation of the
  97     command.</para>
  98
  99     <para>Use the <option>--list</option> command to show a terse table of all local, known block devices with file
 100     systems that may be mounted with this command.</para>
 101
 102     <para><command>systemd-umount</command> can be used to unmount a mount or automount point. It is the same
 103     as <command>systemd-mount</command> <option>--unmount</option>.</para>
 104   </refsect1>
 105
 106   <refsect1>
 107     <title>Options</title>
 108
 109     <para>The following options are understood:</para>
 110
 111     <variablelist>
 112
 113       <varlistentry>
 114         <term><option>--no-block</option></term>
 115
 116         <listitem>
 117           <para>Do not synchronously wait for the requested operation to finish. If this is not specified, the job will
 118           be verified, enqueued and <command>systemd-mount</command> will wait until the mount or automount unit's
 119           start-up is completed. By passing this argument, it is only verified and enqueued.</para>
 120         </listitem>
 121       </varlistentry>
 122
 123       <xi:include href="standard-options.xml" xpointer="no-pager"/>
 124       <xi:include href="standard-options.xml" xpointer="no-ask-password"/>
 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></listitem>
 131       </varlistentry>
 132
 133       <varlistentry>
 134         <term><option>--discover</option></term>
 135
 136         <listitem><para>Enable probing of the mount source. This switch is implied if a single argument is specified on
 137         the command line. If passed, additional metadata is read from the device to enhance the unit to create. For
 138         example, a descriptive string for the transient units is generated from the file system label and device
 139         model. Moreover if a removable block device (e.g. USB stick) is detected an automount unit instead of a regular
 140         mount unit is created, with a short idle time-out, in order to ensure the file-system is placed in a clean
 141         state quickly after each access.</para></listitem>
 142       </varlistentry>
 143
 144       <varlistentry>
 145         <term><option>--type=</option></term>
 146         <term><option>-t</option></term>
 147
 148         <listitem><para>Specifies the file system type to mount (e.g. <literal>vfat</literal>, <literal>ext4</literal>,
 149         …). If omitted (or set to <literal>auto</literal>) the file system is determined automatically.</para></listitem>
 150       </varlistentry>
 151
 152       <varlistentry>
 153         <term><option>--options=</option></term>
 154         <term><option>-o</option></term>
 155
 156         <listitem><para>Additional mount options for the mount point.</para></listitem>
 157       </varlistentry>
 158
 159       <varlistentry>
 160         <term><option>--fsck=</option></term>
 161
 162         <listitem><para>Takes a boolean argument, defaults to on. Controls whether to run a file system check
 163         immediately before the mount operation. In the automount case (see <option>--automount=</option> below) the
 164         check will be run the moment the first access to the device is made, which might slightly delay the
 165         access.</para></listitem>
 166       </varlistentry>
 167
 168       <varlistentry>
 169         <term><option>--description=</option></term>
 170
 171         <listitem><para>Provide a description for the mount or automount unit. See <varname>Description=</varname> in
 172         <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 173         </para></listitem>
 174       </varlistentry>
 175
 176       <varlistentry>
 177         <term><option>--property=</option></term>
 178         <term><option>-p</option></term>
 179
 180         <listitem><para>Sets a unit property for the mount unit that is created. This takes an assignment in the same
 181         format as <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
 182         <command>set-property</command> command.</para>
 183         </listitem>
 184       </varlistentry>
 185
 186       <varlistentry>
 187         <term><option>--automount=</option></term>
 188
 189         <listitem><para>Takes a boolean argument. Controls whether to create an automount point or a regular mount
 190         point. If true an automount point is created that is backed by the actual file system at the time of first
 191         access. If false a plain mount point is created that is backed by the actual file system immediately. Automount
 192         points have the benefit that the file system stays unmounted and hence in clean state until it is first
 193         accessed. In automount mode the <option>--timeout-idle-sec=</option> switch (see below) may be used to ensure
 194         the mount point is unmounted automatically after the last access and an idle period passed.</para>
 195
 196         <para>If this switch is not specified it defaults to false. If not specified and <option>--discover</option> is
 197         used (or only a single argument passed, which implies <option>--discover</option>, see above), and the file
 198         system block device is detected to be removable, it is set to true, in order to increase the chance that the
 199         file system is in a fully clean state if the device is unplugged abruptly.</para></listitem>
 200       </varlistentry>
 201
 202       <varlistentry>
 203         <term><option>-A</option></term>
 204
 205         <listitem><para>Equivalent to <option>--automount=yes</option>.</para></listitem>
 206       </varlistentry>
 207
 208       <varlistentry>
 209         <term><option>--timeout-idle-sec=</option></term>
 210
 211         <listitem><para>Takes a time value that controls the idle timeout in automount mode. If set to
 212         <literal>infinity</literal> (the default) no automatic unmounts are done. Otherwise the file system backing the
 213         automount point is detached after the last access and the idle timeout passed. See
 214         <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details on
 215         the time syntax supported. This option has no effect if only a regular mount is established, and automounting
 216         is not used.</para>
 217
 218         <para>Note that if <option>--discover</option> is used (or only a single argument passed, which implies
 219         <option>--discover</option>, see above), and the file system block device is detected to be removable,
 220         <option>--timeout-idle-sec=1s</option> is implied.</para></listitem>
 221       </varlistentry>
 222
 223       <varlistentry>
 224         <term><option>--automount-property=</option></term>
 225
 226         <listitem><para>Similar to <option>--property=</option>, but applies additional properties to the automount
 227         unit created, instead of the mount unit.</para></listitem>
 228       </varlistentry>
 229
 230       <varlistentry>
 231         <term><option>--bind-device=</option></term>
 232
 233         <listitem><para>Takes a boolean argument, defaults to off. This option only has an effect in automount mode,
 234         and controls whether the automount unit shall be bound to the backing device's lifetime. If enabled, the
 235         automount point will be removed automatically when the backing device vanishes. If disabled the automount point
 236         stays around, and subsequent accesses will block until backing device is replugged. This option has no effect
 237         in case of non-device mounts, such as network or virtual file system mounts.</para>
 238
 239         <para>Note that if <option>--discover</option> is used (or only a single argument passed, which implies
 240         <option>--discover</option>, see above), and the file system block device is detected to be removable, this
 241         option is implied.</para></listitem>
 242       </varlistentry>
 243
 244       <varlistentry>
 245         <term><option>--list</option></term>
 246
 247         <listitem><para>Instead of establishing a mount or automount point, print a terse list of block devices
 248         containing file systems that may be mounted with <literal>systemd-mount</literal>, along with useful metadata
 249         such as labels, etc.</para></listitem>
 250       </varlistentry>
 251
 252       <varlistentry>
 253         <term><option>-u</option></term>
 254         <term><option>--umount</option></term>
 255
 256         <listitem><para>Stop the mount and automount units corresponding to the specified mount points
 257         <replaceable>WHERE</replaceable> or the devices <replaceable>WHAT</replaceable>.
 258         <command>systemd-mount</command> with this option or <command>systemd-umount</command> can take multiple arguments
 259         which can be mount points, devices, <filename>/etc/fstab</filename> style node names, or backing files
 260         corresponding to loop devices, like
 261         <command>systemd-mount --umount /path/to/umount /dev/sda1 UUID=xxxxxx-xxxx LABEL=xxxxx /path/to/disk.img</command>.
 262       </para>
 263         </listitem>
 264       </varlistentry>
 265
 266       <xi:include href="user-system-options.xml" xpointer="user" />
 267       <xi:include href="user-system-options.xml" xpointer="system" />
 268       <xi:include href="user-system-options.xml" xpointer="host" />
 269       <xi:include href="user-system-options.xml" xpointer="machine" />
 270
 271       <xi:include href="standard-options.xml" xpointer="help" />
 272       <xi:include href="standard-options.xml" xpointer="version" />
 273     </variablelist>
 274
 275   </refsect1>
 276
 277   <refsect1>
 278     <title>Exit status</title>
 279
 280     <para>On success, 0 is returned, a non-zero failure
 281     code otherwise.</para>
 282   </refsect1>
 283
 284   <refsect1>
 285     <title>The udev Database</title>
 286
 287     <para>If <option>--discover</option> is used, <command>systemd-mount</command> honors a couple of additional udev
 288     properties of block devices:</para>
 289
 290     <variablelist class='udev-directives'>
 291       <varlistentry>
 292         <term><varname>SYSTEMD_MOUNT_OPTIONS=</varname></term>
 293
 294         <listitem><para>The mount options to use, if <option>--options=</option> is not used.</para></listitem>
 295       </varlistentry>
 296
 297       <varlistentry>
 298         <term><varname>SYSTEMD_MOUNT_WHERE=</varname></term>
 299
 300         <listitem><para>The file system path to place the mount point at, instead of the automatically generated
 301         one.</para></listitem>
 302       </varlistentry>
 303     </variablelist>
 304   </refsect1>
 305
 306   <refsect1>
 307     <title>See Also</title>
 308     <para>
 309       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 310       <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 311       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 312       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 313       <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 314       <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 315       <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 316     </para>
 317   </refsect1>
 318
 319 </refentry>