man/elogind-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 elogind.
   7
   8   Copyright 2016 Lennart Poettering
   9
  10   elogind 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   elogind 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 elogind; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="elogind-mount"
  25           xmlns:xi="http://www.w3.org/2001/XInclude">
  26
  27   <refentryinfo>
  28     <title>elogind-mount</title>
  29     <productname>elogind</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>elogind-mount</refentrytitle>
  43     <manvolnum>1</manvolnum>
  44   </refmeta>
  45
  46   <refnamediv>
  47     <refname>elogind-mount</refname>
  48     <refpurpose>Establish a mount or auto-mount point transiently</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <cmdsynopsis>
  53       <command>elogind-mount</command>
  54       <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
  55       <arg choice="plain"><replaceable>WHAT</replaceable></arg>
  56       <arg choice="opt"><replaceable>WHERE</replaceable></arg>
  57     </cmdsynopsis>
  58     <cmdsynopsis>
  59       <command>elogind-mount</command>
  60       <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
  61       <arg choice="plain"><option>--list</option></arg>
  62     </cmdsynopsis>
  63   </refsynopsisdiv>
  64
  65   <refsect1>
  66     <title>Description</title>
  67
  68     <para><command>elogind-mount</command> may be used to create and start a transient <filename>.mount</filename> or
  69     <filename>.automount</filename> unit of the file system <replaceable>WHAT</replaceable> on the mount point
  70     <replaceable>WHERE</replaceable>.</para>
  71
  72     <para>In many ways, <command>elogind-mount</command> is similar to the lower-level
  73     <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> command, however instead
  74     of executing the mount operation directly and immediately, <command>elogind-mount</command> schedules it through
  75     the service manager job queue, so that it may pull in further dependencies (such as parent mounts, or a file system
  76     checker to execute a priori), and may make use of the auto-mounting logic.</para>
  77
  78     <para>The command takes either one or two arguments. If only one argument is specified it should refer to a block
  79     device containing a file system (e.g. <literal>/dev/sdb1</literal>), which is then probed for a label and other
  80     metadata, and is mounted to a directory whose name is generated from the label. In this mode the block device must
  81     exist at the time of invocation of the command, so that it may be probed. If the device is found to be a removable
  82     block device (e.g. a USB stick) an automount point instead of a regular mount point is created (i.e. the
  83     <option>--automount=</option> option is implied, see below).</para>
  84
  85     <para>If two arguments are specified the first indicates the mount source (the <replaceable>WHAT</replaceable>) and
  86     the second indicates the path to mount it on (the <replaceable>WHERE</replaceable>). In this mode no probing of the
  87     source is attempted, and a backing device node doesn't have to exist yet. However, if this mode is combined with
  88     <option>--discover</option>, device node probing for additional metadata is enabled, and – much like in the
  89     single-argument case discussed above – the specified device has to exist at the time of invocation of the
  90     command.</para>
  91
  92     <para>Use the <option>--list</option> command to show a terse table of all local, known block devices with file
  93     systems that may be mounted with this command.</para>
  94   </refsect1>
  95
  96   <refsect1>
  97     <title>Options</title>
  98
  99     <para>The following options are understood:</para>
 100
 101     <variablelist>
 102
 103       <varlistentry>
 104         <term><option>--no-block</option></term>
 105
 106         <listitem>
 107           <para>Do not synchronously wait for the requested operation to finish. If this is not specified, the job will
 108           be verified, enqueued and <command>elogind-mount</command> will wait until the mount or automount unit's
 109           start-up is completed. By passing this argument, it is only verified and enqueued.</para>
 110         </listitem>
 111       </varlistentry>
 112
 113       <xi:include href="standard-options.xml" xpointer="no-pager"/>
 114       <xi:include href="standard-options.xml" xpointer="no-ask-password"/>
 115
 116       <varlistentry>
 117         <term><option>--quiet</option></term>
 118         <term><option>-q</option></term>
 119
 120         <listitem><para>Suppresses additional informational output while running.</para></listitem>
 121       </varlistentry>
 122
 123       <varlistentry>
 124         <term><option>--discover</option></term>
 125
 126         <listitem><para>Enable probing of the mount source. This switch is implied if a single argument is specified on
 127         the command line. If passed, additional metadata is read from the device to enhance the unit to create. For
 128         example, a descriptive string for the transient units is generated from the file system label and device
 129         model. Moreover if a removable block device (e.g. USB stick) is detected an automount unit instead of a regular
 130         mount unit is created, with a short idle time-out, in order to ensure the file-system is placed in a clean
 131         state quickly after each access.</para></listitem>
 132       </varlistentry>
 133
 134       <varlistentry>
 135         <term><option>--type=</option></term>
 136         <term><option>-t</option></term>
 137
 138         <listitem><para>Specifies the file system type to mount (e.g. <literal>vfat</literal>, <literal>ext4</literal>,
 139         …). If omitted (or set to <literal>auto</literal>) the file system is determined automatically.</para></listitem>
 140       </varlistentry>
 141
 142       <varlistentry>
 143         <term><option>--options=</option></term>
 144         <term><option>-o</option></term>
 145
 146         <listitem><para>Additional mount options for the mount point.</para></listitem>
 147       </varlistentry>
 148
 149       <varlistentry>
 150         <term><option>--fsck=</option></term>
 151
 152         <listitem><para>Takes a boolean argument, defaults to on. Controls whether to run a file system check
 153         immediately before the mount operation. In the automount case (see <option>--automount=</option> below) the
 154         check will be run the moment the first access to the device is made, which might slightly delay the
 155         access.</para></listitem>
 156       </varlistentry>
 157
 158       <varlistentry>
 159         <term><option>--description=</option></term>
 160
 161         <listitem><para>Provide a description for the mount or automount unit. See <varname>Description=</varname> in
 162         <citerefentry><refentrytitle>elogind.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
 163         </para></listitem>
 164       </varlistentry>
 165
 166       <varlistentry>
 167         <term><option>--property=</option></term>
 168         <term><option>-p</option></term>
 169
 170         <listitem><para>Sets a unit property for the mount unit that is created. This takes an assignment in the same
 171         format as <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
 172         <command>set-property</command> command.</para>
 173         </listitem>
 174       </varlistentry>
 175
 176       <varlistentry>
 177         <term><option>--automount=</option></term>
 178
 179         <listitem><para>Takes a boolean argument. Controls whether to create an automount point or a regular mount
 180         point. If true an automount point is created that is backed by the actual file system at the time of first
 181         access. If false a plain mount point is created that is backed by the actual file system immediately. Automount
 182         points have the benefit that the file system stays unmounted and hence in clean state until it is first
 183         accessed. In automount mode the <option>--timeout-idle-sec=</option> switch (see below) may be used to ensure
 184         the mount point is unmounted automatically after the last access and an idle period passed.</para>
 185
 186         <para>If this switch is not specified it defaults to false. If not specified and <option>--discover</option> is
 187         used (or only a single argument passed, which implies <option>--discover</option>, see above), and the file
 188         system block device is detected to be removable, it is set to true, in order to increase the chance that the
 189         file system is in a fully clean state if the device is unplugged abruptly.</para></listitem>
 190       </varlistentry>
 191
 192       <varlistentry>
 193         <term><option>-A</option></term>
 194
 195         <listitem><para>Equivalent to <option>--automount=yes</option>.</para></listitem>
 196       </varlistentry>
 197
 198       <varlistentry>
 199         <term><option>--timeout-idle-sec=</option></term>
 200
 201         <listitem><para>Takes a time value that controls the idle timeout in automount mode. If set to
 202         <literal>infinity</literal> (the default) no automatic unmounts are done. Otherwise the file system backing the
 203         automount point is detached after the last access and the idle timeout passed. See
 204         <citerefentry><refentrytitle>elogind.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details on
 205         the time syntax supported. This option has no effect if only a regular mount is established, and automounting
 206         is not used.</para>
 207
 208         <para>Note that if <option>--discover</option> is used (or only a single argument passed, which implies
 209         <option>--discover</option>, see above), and the file system block device is detected to be removable,
 210         <option>--timeout-idle-sec=1s</option> is implied.</para></listitem>
 211       </varlistentry>
 212
 213       <varlistentry>
 214         <term><option>--automount-property=</option></term>
 215
 216         <listitem><para>Similar to <option>--property=</option>, but applies additional properties to the automount
 217         unit created, instead of the mount unit.</para></listitem>
 218       </varlistentry>
 219
 220       <varlistentry>
 221         <term><option>--bind-device=</option></term>
 222
 223         <listitem><para>Takes a boolean argument, defaults to off. This option only has an effect in automount mode,
 224         and controls whether the automount unit shall be bound to the backing device's lifetime. If enabled, the
 225         automount point will be removed automatically when the backing device vanishes. If disabled the automount point
 226         stays around, and subsequent accesses will block until backing device is replugged. This option has no effect
 227         in case of non-device mounts, such as network or virtual file system mounts.</para>
 228
 229         <para>Note that if <option>--discover</option> is used (or only a single argument passed, which implies
 230         <option>--discover</option>, see above), and the file system block device is detected to be removable, this
 231         option is implied.</para></listitem>
 232       </varlistentry>
 233
 234       <varlistentry>
 235         <term><option>--list</option></term>
 236
 237         <listitem><para>Instead of establishing a mount or automount point, print a terse list of block devices
 238         containing file systems that may be mounted with <literal>elogind-mount</literal>, along with useful metadata
 239         such as labels, etc.</para></listitem>
 240       </varlistentry>
 241
 242       <xi:include href="user-system-options.xml" xpointer="user" />
 243       <xi:include href="user-system-options.xml" xpointer="system" />
 244       <xi:include href="user-system-options.xml" xpointer="host" />
 245       <xi:include href="user-system-options.xml" xpointer="machine" />
 246
 247       <xi:include href="standard-options.xml" xpointer="help" />
 248       <xi:include href="standard-options.xml" xpointer="version" />
 249     </variablelist>
 250
 251   </refsect1>
 252
 253   <refsect1>
 254     <title>Exit status</title>
 255
 256     <para>On success, 0 is returned, a non-zero failure
 257     code otherwise.</para>
 258   </refsect1>
 259
 260   <refsect1>
 261     <title>The udev Database</title>
 262
 263     <para>If <option>--discover</option> is used, <command>elogind-mount</command> honours a couple of additional udev
 264     properties of block devices:</para>
 265
 266     <variablelist class='udev-directives'>
 267       <varlistentry>
 268         <term><varname>SYSTEMD_MOUNT_OPTIONS=</varname></term>
 269
 270         <listitem><para>The mount options to use, if <option>--options=</option> is not used.</para></listitem>
 271       </varlistentry>
 272
 273       <varlistentry>
 274         <term><varname>SYSTEMD_MOUNT_WHERE=</varname></term>
 275
 276         <listitem><para>The file system path to place the mount point at, instead of the automatically generated
 277         one.</para></listitem>
 278       </varlistentry>
 279     </variablelist>
 280   </refsect1>
 281
 282   <refsect1>
 283     <title>See Also</title>
 284     <para>
 285       <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 286       <citerefentry><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 287       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 288       <citerefentry><refentrytitle>elogind.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 289       <citerefentry><refentrytitle>elogind.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 290       <citerefentry><refentrytitle>elogind.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 291       <citerefentry><refentrytitle>elogind-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 292     </para>
 293   </refsect1>
 294
 295 </refentry>