<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-<!-- SPDX-License-Identifier: LGPL-2.1+ -->
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="systemd-mount"
xmlns:xi="http://www.w3.org/2001/XInclude">
<arg choice="plain"><replaceable>WHAT</replaceable></arg>
<arg choice="opt"><replaceable>WHERE</replaceable></arg>
</cmdsynopsis>
+ <cmdsynopsis>
+ <command>systemd-mount</command>
+ <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
+ <arg choice="plain"><option>--tmpfs</option></arg>
+ <arg choice="opt"><replaceable>NAME</replaceable></arg>
+ <arg choice="plain"><replaceable>WHERE</replaceable></arg>
+ </cmdsynopsis>
<cmdsynopsis>
<command>systemd-mount</command>
<arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg>
<replaceable>WHERE</replaceable>.</para>
<para>In many ways, <command>systemd-mount</command> is similar to the lower-level
- <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> command, however instead
- of executing the mount operation directly and immediately, <command>systemd-mount</command> schedules it through
- the service manager job queue, so that it may pull in further dependencies (such as parent mounts, or a file system
- checker to execute a priori), and may make use of the auto-mounting logic.</para>
+ <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ command, however instead of executing the mount operation directly and immediately,
+ <command>systemd-mount</command> schedules it through the service manager job queue, so that it may pull
+ in further dependencies (such as parent mounts, or a file system checker to execute a priori), and may
+ make use of the auto-mounting logic.</para>
<para>The command takes either one or two arguments. If only one argument is specified it should refer to
a block device or regular file containing a file system (e.g. <literal>/dev/sdb1</literal> or
label and other metadata, and is mounted to a directory below <filename>/run/media/system/</filename>
whose name is generated from the file system label. In this mode the block device or image file must
exist at the time of invocation of the command, so that it may be probed. If the device is found to be a
- removable block device (e.g. a USB stick) an automount point instead of a regular mount point is created
- (i.e. the <option>--automount=</option> option is implied, see below).</para>
-
- <para>If two arguments are specified the first indicates the mount source (the <replaceable>WHAT</replaceable>) and
- the second indicates the path to mount it on (the <replaceable>WHERE</replaceable>). In this mode no probing of the
- source is attempted, and a backing device node doesn't have to exist yet. However, if this mode is combined with
- <option>--discover</option>, device node probing for additional metadata is enabled, and – much like in the
- single-argument case discussed above – the specified device has to exist at the time of invocation of the
- command.</para>
+ removable block device (e.g. a USB stick), an automount point is created instead of a regular mount point
+ (i.e. the <option>--automount=</option> option is implied, see below). If the option
+ <option>--tmpfs</option> is specified, then the argument is interpreted as the path where the new
+ temporary file system shall be mounted.</para>
+
+ <para>If two arguments are specified, the first indicates the mount source (the
+ <replaceable>WHAT</replaceable>) and the second indicates the path to mount it on (the
+ <replaceable>WHERE</replaceable>). In this mode no probing of the source is attempted, and a backing
+ device node doesn't have to exist. However, if this mode is combined with <option>--discover</option>,
+ device node probing for additional metadata is enabled, and – much like in the single-argument case
+ discussed above – the specified device has to exist at the time of invocation of the command.</para>
<para>Use the <option>--list</option> command to show a terse table of all local, known block devices with file
systems that may be mounted with this command.</para>
<para>Do not synchronously wait for the requested operation to finish. If this is not specified, the job will
be verified, enqueued and <command>systemd-mount</command> will wait until the mount or automount unit's
start-up is completed. By passing this argument, it is only verified and enqueued.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/>
</listitem>
</varlistentry>
<listitem>
<para>Do not ellipsize the output when <option>--list</option> is specified.</para>
+
+ <xi:include href="version-info.xml" xpointer="v245"/>
</listitem>
</varlistentry>
<term><option>--quiet</option></term>
<term><option>-q</option></term>
- <listitem><para>Suppresses additional informational output while running.</para></listitem>
+ <listitem><para>Suppresses additional informational output while running.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
example, a descriptive string for the transient units is generated from the file system label and device
model. Moreover if a removable block device (e.g. USB stick) is detected an automount unit instead of a regular
mount unit is created, with a short idle timeout, in order to ensure the file-system is placed in a clean
- state quickly after each access.</para></listitem>
+ state quickly after each access.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--type=</option></term>
<term><option>-t</option></term>
- <listitem><para>Specifies the file system type to mount (e.g. <literal>vfat</literal>, <literal>ext4</literal>,
- …). If omitted (or set to <literal>auto</literal>) the file system is determined automatically.</para></listitem>
+ <listitem><para>Specifies the file system type to mount (e.g. <literal>vfat</literal> or
+ <literal>ext4</literal>). If omitted or set to <literal>auto</literal>, the file system type is
+ determined automatically.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--options=</option></term>
<term><option>-o</option></term>
- <listitem><para>Additional mount options for the mount point.</para></listitem>
+ <listitem><para>Additional mount options for the mount point.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
<listitem><para>Let the specified user <replaceable>USER</replaceable> own the mounted file system.
This is done by appending <option>uid=</option> and <option>gid=</option> options to the list
- of mount options. Only certain file systems support this option.</para></listitem>
+ of mount options. Only certain file systems support this option.</para>
+
+ <xi:include href="version-info.xml" xpointer="v237"/></listitem>
</varlistentry>
<varlistentry>
<listitem><para>Takes a boolean argument, defaults to on. Controls whether to run a file system check
immediately before the mount operation. In the automount case (see <option>--automount=</option> below) the
check will be run the moment the first access to the device is made, which might slightly delay the
- access.</para></listitem>
+ access.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
<listitem><para>Provide a description for the mount or automount unit. See <varname>Description=</varname> in
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
- </para></listitem>
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
<listitem><para>Sets a unit property for the mount unit that is created. This takes an assignment in the same
format as <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
<command>set-property</command> command.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/>
</listitem>
</varlistentry>
<para>If this switch is not specified it defaults to false. If not specified and <option>--discover</option> is
used (or only a single argument passed, which implies <option>--discover</option>, see above), and the file
system block device is detected to be removable, it is set to true, in order to increase the chance that the
- file system is in a fully clean state if the device is unplugged abruptly.</para></listitem>
+ file system is in a fully clean state if the device is unplugged abruptly.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
<term><option>-A</option></term>
- <listitem><para>Equivalent to <option>--automount=yes</option>.</para></listitem>
+ <listitem><para>Equivalent to <option>--automount=yes</option>.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
<para>Note that if <option>--discover</option> is used (or only a single argument passed, which implies
<option>--discover</option>, see above), and the file system block device is detected to be removable,
- <option>--timeout-idle-sec=1s</option> is implied.</para></listitem>
+ <option>--timeout-idle-sec=1s</option> is implied.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--automount-property=</option></term>
<listitem><para>Similar to <option>--property=</option>, but applies additional properties to the automount
- unit created, instead of the mount unit.</para></listitem>
+ unit created, instead of the mount unit.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
<listitem><para>This option only has an effect in automount mode,
and controls whether the automount unit shall be bound to the backing device's lifetime. If set, the
- automount point will be removed automatically when the backing device vanishes. By default the automount point
+ automount unit will be stopped automatically when the backing device vanishes. By default the automount unit
stays around, and subsequent accesses will block until backing device is replugged. This option has no effect
in case of non-device mounts, such as network or virtual file system mounts.</para>
<para>Note that if <option>--discover</option> is used (or only a single argument passed, which implies
<option>--discover</option>, see above), and the file system block device is detected to be removable, this
- option is implied.</para></listitem>
+ option is implied.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
<listitem><para>Instead of establishing a mount or automount point, print a terse list of block devices
containing file systems that may be mounted with <literal>systemd-mount</literal>, along with useful metadata
- such as labels, etc.</para></listitem>
+ such as labels, etc.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
corresponding to loop devices, like
<command>systemd-mount --umount /path/to/umount /dev/sda1 UUID=xxxxxx-xxxx LABEL=xxxxx /path/to/disk.img</command>.
Note that when <option>-H</option> or <option>-M</option> is specified, only absolute paths to mount points are
- supported.</para></listitem>
+ supported.</para>
+
+ <xi:include href="version-info.xml" xpointer="v233"/></listitem>
</varlistentry>
<varlistentry>
<command>--property=CollectMode=inactive-or-failed</command>, see the explanation for
<varname>CollectMode=</varname> in
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for further
- information.</para></listitem>
+ information.</para>
+
+ <xi:include href="version-info.xml" xpointer="v236"/></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-T</option></term>
+ <term><option>--tmpfs</option></term>
+
+ <listitem>
+ <para>Create and mount a new <constant>tmpfs</constant> file system on
+ <replaceable>WHERE</replaceable>, with an optional <replaceable>NAME</replaceable> that defaults to
+ <literal>tmpfs</literal>.</para>
+
+ <para>The file system is mounted with the top-level directory mode determined by the
+ <citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry> setting
+ of the caller, i.e. <constant>rwxrwxrwx</constant> masked by the umask of the caller. This matches
+ what
+ <citerefentry project='man-pages'><refentrytitle>mkdir</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ does, but is different from the kernel default of <literal>rwxrwxrwxt</literal>, i.e. a
+ world-writable directory with the sticky bit set.</para>
+
+ <xi:include href="version-info.xml" xpointer="v255"/>
+ </listitem>
</varlistentry>
<xi:include href="user-system-options.xml" xpointer="user" />
<varlistentry>
<term><varname>SYSTEMD_MOUNT_OPTIONS=</varname></term>
- <listitem><para>The mount options to use, if <option>--options=</option> is not used.</para></listitem>
+ <listitem><para>The mount options to use, if <option>--options=</option> is not used.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
<varlistentry>
<term><varname>SYSTEMD_MOUNT_WHERE=</varname></term>
<listitem><para>The file system path to place the mount point at, instead of the automatically generated
- one.</para></listitem>
+ one.</para>
+
+ <xi:include href="version-info.xml" xpointer="v232"/></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
- <para>
- <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- </para>
+ <para><simplelist type="inline">
+ <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+ <member><citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
+ </simplelist></para>
</refsect1>
</refentry>
projects / thirdparty / systemd.git / blobdiff