man/systemd-dissect.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   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-dissect" conditional='HAVE_BLKID'
   7     xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>systemd-dissect</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-dissect</refentrytitle>
  16     <manvolnum>1</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-dissect</refname>
  21     <refname>mount.ddi</refname>
  22     <refpurpose>Dissect Discoverable Disk Images (DDIs)</refpurpose>
  23   </refnamediv>
  24
  25   <refsynopsisdiv>
  26     <cmdsynopsis>
  27       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg>
  28     </cmdsynopsis>
  29     <cmdsynopsis>
  30       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--mount</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="plain"><replaceable>PATH</replaceable></arg>
  31     </cmdsynopsis>
  32     <cmdsynopsis>
  33       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--umount</arg> <arg choice="plain"><replaceable>PATH</replaceable></arg>
  34     </cmdsynopsis>
  35     <cmdsynopsis>
  36       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--attach</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg>
  37     </cmdsynopsis>
  38     <cmdsynopsis>
  39       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--detach</arg> <arg choice="plain"><replaceable>PATH</replaceable></arg>
  40     </cmdsynopsis>
  41     <cmdsynopsis>
  42       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--list</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg>
  43     </cmdsynopsis>
  44     <cmdsynopsis>
  45       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--mtree</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg>
  46     </cmdsynopsis>
  47     <cmdsynopsis>
  48       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--with</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="opt" rep="repeat"><replaceable>COMMAND</replaceable></arg>
  49     </cmdsynopsis>
  50     <cmdsynopsis>
  51       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--copy-from</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="plain"><replaceable>PATH</replaceable></arg> <arg choice="opt"><replaceable>TARGET</replaceable></arg>
  52     </cmdsynopsis>
  53     <cmdsynopsis>
  54       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--copy-to</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="opt"><replaceable>SOURCE</replaceable></arg> <arg choice="plain"><replaceable>PATH</replaceable></arg>
  55     </cmdsynopsis>
  56     <cmdsynopsis>
  57       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--make-archive</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="opt"><replaceable>TARGET</replaceable></arg>
  58     </cmdsynopsis>
  59     <cmdsynopsis>
  60       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--discover</arg>
  61     </cmdsynopsis>
  62     <cmdsynopsis>
  63       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--validate</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg>
  64     </cmdsynopsis>
  65     <cmdsynopsis>
  66       <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--shift</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="plain"><replaceable>UIDBASE</replaceable></arg>
  67     </cmdsynopsis>
  68   </refsynopsisdiv>
  69
  70   <refsect1>
  71     <title>Description</title>
  72
  73     <para><command>systemd-dissect</command> is a tool for introspecting and interacting with file system OS
  74     disk images, specifically Discoverable Disk Images (DDIs). It supports four different operations:</para>
  75
  76     <orderedlist>
  77       <listitem><para>Show general OS image information, including the image's
  78       <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry> data,
  79       machine ID, partition information and more.</para></listitem>
  80
  81       <listitem><para>Mount an OS image to a local directory. In this mode it will dissect the OS image and
  82       mount the included partitions according to their designation onto a directory and possibly
  83       sub-directories.</para></listitem>
  84
  85       <listitem><para>Unmount an OS image from a local directory. In this mode it will recursively unmount
  86       the mounted partitions and remove the underlying loop device, including all the partition sub-devices.
  87       </para></listitem>
  88
  89       <listitem><para>Copy files and directories in and out of an OS image.</para></listitem>
  90     </orderedlist>
  91
  92     <para>The tool may operate on three types of OS images:</para>
  93
  94     <orderedlist>
  95       <listitem><para>OS disk images containing a GPT partition table envelope, with partitions marked
  96       according to the <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions
  97       Specification</ulink>.</para></listitem>
  98
  99       <listitem><para>OS disk images containing just a plain file-system without an enveloping partition
 100       table. (This file system is assumed to be the root file system of the OS.)</para></listitem>
 101
 102       <listitem><para>OS disk images containing a GPT or MBR partition table, with a single
 103       partition only. (This partition is assumed to contain the root file system of the OS.)</para></listitem>
 104     </orderedlist>
 105
 106     <para>OS images may use any kind of Linux-supported file systems. In addition they may make use of LUKS
 107     disk encryption, and contain Verity integrity information. Note that qualifying OS images may be booted
 108     with <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
 109     <option>--image=</option> switch, and be used as root file system for system service using the
 110     <varname>RootImage=</varname> unit file setting, see
 111     <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
 112
 113     <para>Note that the partition table shown when invoked without command switch (as listed below) does not
 114     necessarily show all partitions included in the image, but just the partitions that are understood and
 115     considered part of an OS disk image. Specifically, partitions of unknown types are ignored, as well as
 116     duplicate partitions (i.e. more than one per partition type), as are root and <filename>/usr/</filename>
 117     partitions of architectures not compatible with the local system. In other words: this tool will display
 118     what it operates with when mounting the image. To display the complete list of partitions use a tool such
 119     as <citerefentry
 120     project='man-pages'><refentrytitle>fdisk</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 121
 122     <para>The <command>systemd-dissect</command> command may be invoked as <command>mount.ddi</command> in
 123     which case it implements the <citerefentry
 124     project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> "external
 125     helper" interface. This ensures disk images compatible with <command>systemd-dissect</command> can be
 126     mounted directly by <command>mount</command> and <citerefentry
 127     project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For
 128     details see below.</para>
 129
 130     <xi:include href="vpick.xml" xpointer="image"/>
 131   </refsect1>
 132
 133   <refsect1>
 134     <title>Commands</title>
 135
 136     <para>If neither of the command switches listed below are passed the specified disk image is opened and
 137     general information about the image and the contained partitions and their use is shown.</para>
 138
 139     <variablelist>
 140       <varlistentry>
 141         <term><option>--mount</option></term>
 142         <term><option>-m</option></term>
 143
 144         <listitem><para>Mount the specified OS image to the specified directory. This will dissect the image,
 145         determine the OS root file system — as well as possibly other partitions — and mount them to the
 146         specified directory. If the OS image contains multiple partitions marked with the <ulink
 147         url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink>
 148         multiple nested mounts are established. This command expects two arguments: a path to an image file
 149         and a path to a directory where to mount the image.</para>
 150
 151         <para>To unmount an OS image mounted like this use the <option>--umount</option> operation.</para>
 152
 153         <para>When the OS image contains LUKS encrypted or Verity integrity protected file systems
 154         appropriate volumes are automatically set up and marked for automatic disassembly when the image is
 155         unmounted.</para>
 156
 157         <para>The OS image may either be specified as path to an OS image stored in a regular file or may
 158         refer to block device node (in the latter case, the block device must be the "whole" device, i.e. not
 159         a partition device). (The other supported commands described here support this, too.)</para>
 160
 161         <para>All mounted file systems are checked with the appropriate <citerefentry
 162         project='man-pages'><refentrytitle>fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 163         implementation in automatic fixing mode, unless explicitly turned off (<option>--fsck=no</option>) or
 164         read-only operation is requested (<option>--read-only</option>).</para>
 165
 166         <para>Note that this functionality is also available in <citerefentry
 167         project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> via a
 168         command such as <command>mount -t ddi myimage.raw targetdir/</command>, as well as in <citerefentry
 169         project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For
 170         details, see below.</para>
 171
 172         <xi:include href="version-info.xml" xpointer="v247"/></listitem>
 173       </varlistentry>
 174
 175       <varlistentry>
 176         <term><option>-M</option></term>
 177
 178         <listitem><para>This is a shortcut for <option>--mount --mkdir</option>.</para>
 179
 180         <xi:include href="version-info.xml" xpointer="v247"/></listitem>
 181       </varlistentry>
 182
 183       <varlistentry>
 184         <term><option>--umount</option></term>
 185         <term><option>-u</option></term>
 186
 187         <listitem><para>Unmount an OS image from the specified directory. This command expects one argument:
 188         a directory where an OS image was mounted.</para>
 189
 190         <para>All mounted partitions will be recursively unmounted, and the underlying loop device will be
 191         removed, along with all its partition sub-devices.</para>
 192
 193         <xi:include href="version-info.xml" xpointer="v252"/></listitem>
 194       </varlistentry>
 195
 196       <varlistentry>
 197         <term><option>-U</option></term>
 198
 199         <listitem><para>This is a shortcut for <option>--umount --rmdir</option>.</para>
 200
 201         <xi:include href="version-info.xml" xpointer="v252"/></listitem>
 202       </varlistentry>
 203
 204       <varlistentry>
 205         <term><option>--attach</option></term>
 206
 207         <listitem><para>Attach the specified disk image to an automatically allocated loopback block device,
 208         and print the path to the loopback block device to standard output. This is similar to an invocation
 209         of <command>losetup --find --show</command>, but will validate the image as DDI before attaching, and
 210         derive the correct sector size to use automatically. Moreover, it ensures the per-partition block
 211         devices are created before returning. Takes a path to a disk image file.</para>
 212
 213         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
 214       </varlistentry>
 215
 216       <varlistentry>
 217         <term><option>--detach</option></term>
 218
 219         <listitem><para>Detach the specified disk image from a loopback block device. This undoes the effect
 220         of <option>--attach</option> above. This expects either a path to a loopback block device as an
 221         argument, or the path to the backing image file. In the latter case, it will automatically determine
 222         the right device to detach.</para>
 223
 224         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
 225       </varlistentry>
 226
 227       <varlistentry>
 228         <term><option>--list</option></term>
 229         <term><option>-l</option></term>
 230
 231         <listitem><para>Prints the paths of all the files and directories in the specified OS image or
 232         directory to standard output.</para>
 233
 234         <xi:include href="version-info.xml" xpointer="v253"/></listitem>
 235       </varlistentry>
 236
 237       <varlistentry>
 238         <term><option>--mtree</option></term>
 239
 240         <listitem><para>Generates a BSD
 241         <citerefentry project='die-net'><refentrytitle>mtree</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 242         compatible file manifest of the specified disk image or directory. This is useful for comparing image
 243         contents in detail, including inode information and other metadata. While the generated manifest will
 244         contain detailed inode information, it currently excludes extended attributes, file system
 245         capabilities, MAC labels,
 246         <citerefentry project='man-pages'><refentrytitle>chattr</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 247         file flags,
 248         <citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/btrfs-man5.html'>btrfs</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 249         subvolume information, and various other file metadata. File content information is shown via a
 250         SHA256 digest. Additional fields might be added in future. Note that inode information such as link
 251         counts, inode numbers and timestamps is excluded from the output on purpose, as it typically
 252         complicates reproducibility.</para>
 253
 254         <xi:include href="version-info.xml" xpointer="v253"/></listitem>
 255       </varlistentry>
 256
 257       <varlistentry>
 258         <term><option>--with</option></term>
 259
 260         <listitem><para>Runs the specified command with the specified OS image mounted. This will mount the
 261         image to a temporary directory, switch the current working directory to it, and invoke the specified
 262         command line as child process. Once the process ends it will unmount the image again, and remove the
 263         temporary directory. If no command is specified a shell is invoked. The image is mounted writable,
 264         use <option>--read-only</option> to switch to read-only operation. The invoked process will have the
 265         <varname>$SYSTEMD_DISSECT_ROOT</varname> environment variable set, containing the absolute path name
 266         of the temporary mount point, i.e. the same directory that is set as the current working
 267         directory. It will also have the <varname>$SYSTEMD_DISSECT_DEVICE</varname> environment variable set,
 268         containing the absolute path name of the loop device the image was attached to.</para>
 269
 270         <xi:include href="version-info.xml" xpointer="v253"/></listitem>
 271       </varlistentry>
 272
 273       <varlistentry>
 274         <term><option>--copy-from</option></term>
 275         <term><option>-x</option></term>
 276
 277         <listitem><para>Copies a file or directory from the specified OS image or directory into the
 278         specified location on the host file system. Expects three arguments: a path to an image file or
 279         directory, a source path (relative to the image's root directory) and a destination path (relative to
 280         the current working directory, or an absolute path, both outside of the image). If the destination
 281         path is omitted or specified as dash (<literal>-</literal>), the specified file is written to
 282         standard output. If the source path in the image file system refers to a regular file it is copied to
 283         the destination path. In this case, access mode, extended attributes and timestamps are copied as
 284         well, but file ownership is not. If the source path in the image refers to a directory, it is copied
 285         to the destination path, recursively with all containing files and directories, merging into existing
 286         directories and updating already existing files. In this case, the file ownership is copied too.</para>
 287
 288         <xi:include href="version-info.xml" xpointer="v247"/></listitem>
 289       </varlistentry>
 290
 291       <varlistentry>
 292         <term><option>--copy-to</option></term>
 293         <term><option>-a</option></term>
 294
 295         <listitem><para>Copies a file or directory from the specified location in the host file system into
 296         the specified OS image or directory. Expects three arguments: a path to an image file or directory, a
 297         source path (relative to the current working directory, or an absolute path, both outside of the
 298         image) and a destination path (relative to the image's root directory). If the source path is omitted
 299         or specified as dash (<literal>-</literal>), the data to write is read from standard input. If the
 300         source path in the host file system refers to a regular file, it is copied to the destination path.
 301         In this case, access mode, extended attributes and timestamps are copied as well, but file ownership
 302         is not. If the source path in the host file system refers to a directory it is copied to the
 303         destination path, recursively with all containing files and directories, merging into existing
 304         directories and updating already existing files.. In this case, the file ownership is copied too.</para>
 305
 306         <para>As with <option>--mount</option> file system checks are implicitly run before the copy
 307         operation begins.</para>
 308
 309         <xi:include href="version-info.xml" xpointer="v247"/></listitem>
 310       </varlistentry>
 311
 312       <varlistentry>
 313         <term><option>--make-archive</option></term>
 314
 315         <listitem><para>Generates an archive file from the specified disk image. Expects two arguments: the
 316         path to the disk image and optionally the output archive file path. If the latter is omitted the
 317         archive is written to standard output. The archive file format is determined automatically from the
 318         specified output archive file name, e.g. any path suffixed with <literal>.tar.xz</literal> will
 319         result in an xz compressed UNIX tarball (if the path is omitted an uncompressed UNIX tarball is
 320         created). See
 321         <citerefentry><refentrytitle>libarchive</refentrytitle><manvolnum>3</manvolnum></citerefentry> for a
 322         list of supported archive formats and compression schemes.</para>
 323
 324         <xi:include href="version-info.xml" xpointer="v256"/></listitem>
 325       </varlistentry>
 326
 327       <varlistentry>
 328         <term><option>--discover</option></term>
 329
 330         <listitem><para>Show a list of DDIs in well-known directories. This will show machine, portable
 331         service and system/configuration extension disk images in the usual directories
 332         <filename>/usr/lib/machines/</filename>, <filename>/usr/lib/portables/</filename>,
 333         <filename>/usr/lib/confexts/</filename>, <filename>/var/lib/machines/</filename>,
 334         <filename>/var/lib/portables/</filename>, <filename>/var/lib/extensions/</filename> and so
 335         on.</para>
 336
 337         <xi:include href="version-info.xml" xpointer="v253"/></listitem>
 338       </varlistentry>
 339
 340       <varlistentry>
 341         <term><option>--validate</option></term>
 342
 343         <listitem><para>Validates the partition arrangement of a disk image (DDI), and ensures it matches the
 344         image policy specified via <option>--image-policy=</option>, if one is specified. This parses the
 345         partition table and probes the file systems in the image, but does not attempt to mount them (nor to
 346         set up disk encryption/authentication via LUKS/Verity). It does this taking the configured image
 347         dissection policy into account. Since this operation does not mount file systems, this command –
 348         unlike all other commands implemented by this tool – requires no privileges other than the ability to
 349         access the specified file. Prints "OK" and returns zero if the image appears to be in order and
 350         matches the specified image dissection policy. Otherwise, prints an error message and returns
 351         non-zero.</para>
 352
 353         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
 354       </varlistentry>
 355
 356       <varlistentry>
 357         <term><option>--shift</option></term>
 358
 359         <listitem><para>Recursively iterates through all inodes of the specified image and shifts the UIDs
 360         and GIDs the inodes are owned by into the specified UID range. Takes an image path and a UID base as
 361         parameter. The UID base can be specified numerically (in which case it must be a multiple of 65536,
 362         and either 0 or within the container or foreign UID range, as per <ulink
 363         url="https://systemd.io/UIDS-GIDS/">Users, Groups, UIDs and GIDs on systemd Systems</ulink>), or as
 364         the symbolic identifier <literal>foreign</literal> which is shorthand to the foreign UID base. This
 365         command is useful for preparing directory container images for unprivileged use. Note that this
 366         command is intended for images that use the 16bit UIDs/GIDs range only, and it always ignores the
 367         upper 16bit of the current UID/GID ownership, combining the lower 16 bit with the target UID
 368         base.</para>
 369
 370         <para>Use <command>systemd-dissect --shift /some/container/tree foreign</command> to shift a
 371         container image into the foreign UID range, or <command>systemd-dissect --shift /some/container/tree
 372         0</command> to shift it to host UID range.</para>
 373
 374         <xi:include href="version-info.xml" xpointer="v258"/></listitem>
 375       </varlistentry>
 376
 377       <xi:include href="standard-options.xml" xpointer="help" />
 378       <xi:include href="standard-options.xml" xpointer="version" />
 379     </variablelist>
 380
 381   </refsect1>
 382
 383   <refsect1>
 384     <title>Options</title>
 385
 386     <para>The following options are understood:</para>
 387
 388     <variablelist>
 389       <varlistentry>
 390         <term><option>--read-only</option></term>
 391         <term><option>-r</option></term>
 392
 393         <listitem><para>Operate in read-only mode. By default, <option>--mount</option> will establish
 394         writable mount points. If this option is specified they are established in read-only mode
 395         instead.</para>
 396
 397         <xi:include href="version-info.xml" xpointer="v247"/></listitem>
 398       </varlistentry>
 399
 400       <varlistentry>
 401         <term><option>--fsck=no</option></term>
 402
 403         <listitem><para>Turn off automatic file system checking. By default, when an image is accessed for
 404         writing (by <option>--mount</option> or <option>--copy-to</option>) the file systems contained in the
 405         OS image are automatically checked using the appropriate <citerefentry
 406         project='man-pages'><refentrytitle>fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 407         command, in automatic fixing mode. This behavior may be switched off using
 408         <option>--fsck=no</option>.</para>
 409
 410         <xi:include href="version-info.xml" xpointer="v247"/></listitem>
 411       </varlistentry>
 412
 413       <varlistentry>
 414         <term><option>--growfs=no</option></term>
 415
 416         <listitem><para>Turn off automatic growing of accessed file systems to their partition size, if
 417         marked for that in the GPT partition table. By default, when an image is accessed for writing (by
 418         <option>--mount</option> or <option>--copy-to</option>) the file systems contained in the OS image
 419         are automatically grown to their partition sizes, if bit 59 in the GPT partition flags is set for
 420         partition types that are defined by the <ulink
 421         url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink>. This
 422         behavior may be switched off using <option>--growfs=no</option>. File systems are grown automatically
 423         on access if all of the following conditions are met:</para>
 424         <orderedlist>
 425           <listitem><para>The file system is mounted writable</para></listitem>
 426           <listitem><para>The file system currently is smaller than the partition it is contained in (and thus can be grown)</para></listitem>
 427           <listitem><para>The image contains a GPT partition table</para></listitem>
 428           <listitem><para>The file system is stored on a partition defined by the Discoverable Partitions Specification</para></listitem>
 429           <listitem><para>Bit 59 of the GPT partition flags for this partition is set, as per specification</para></listitem>
 430           <listitem><para>The <option>--growfs=no</option> option is not passed.</para></listitem>
 431         </orderedlist>
 432
 433           <xi:include href="version-info.xml" xpointer="v249"/>
 434         </listitem>
 435       </varlistentry>
 436
 437       <varlistentry>
 438         <term><option>--mkdir</option></term>
 439
 440         <listitem><para>If combined with <option>--mount</option> the directory to mount the OS image to is
 441         created if it is missing. Note that the directory is not automatically removed when the disk image is
 442         unmounted again.</para>
 443
 444         <xi:include href="version-info.xml" xpointer="v247"/></listitem>
 445       </varlistentry>
 446
 447       <varlistentry>
 448         <term><option>--rmdir</option></term>
 449
 450         <listitem><para>If combined with <option>--umount</option> the specified directory where the OS image
 451         is mounted is removed after unmounting the OS image.</para>
 452
 453         <xi:include href="version-info.xml" xpointer="v252"/></listitem>
 454       </varlistentry>
 455
 456       <varlistentry>
 457         <term><option>--discard=</option></term>
 458
 459         <listitem><para>Takes one of <literal>disabled</literal>, <literal>loop</literal>,
 460         <literal>all</literal>, <literal>crypto</literal>. If <literal>disabled</literal> the image is
 461         accessed with empty block discarding turned off. If <literal>loop</literal> discarding is enabled if
 462         operating on a regular file. If <literal>crypt</literal> discarding is enabled even on encrypted file
 463         systems. If <literal>all</literal> discarding is unconditionally enabled.</para>
 464
 465         <xi:include href="version-info.xml" xpointer="v247"/></listitem>
 466       </varlistentry>
 467
 468       <varlistentry>
 469         <term><option>--in-memory</option></term>
 470
 471         <listitem><para>If specified an in-memory copy of the specified disk image is used. This may be used
 472         to operate with write-access on a (possibly read-only) image, without actually modifying the original
 473         file. This may also be used in order to operate on a disk image without keeping the originating file
 474         system busy, in order to allow it to be unmounted.</para>
 475
 476         <xi:include href="version-info.xml" xpointer="v253"/></listitem>
 477       </varlistentry>
 478
 479       <varlistentry>
 480         <term><option>--root-hash=</option></term>
 481         <term><option>--root-hash-sig=</option></term>
 482         <term><option>--verity-data=</option></term>
 483
 484         <listitem><para>Configure various aspects of Verity data integrity for the OS image. Option
 485         <option>--root-hash=</option> specifies a hex-encoded top-level Verity hash to use for setting up the
 486         Verity integrity protection. Option <option>--root-hash-sig=</option> specifies the path to a file
 487         containing a PKCS#7 signature for the hash. This signature is passed to the kernel during activation,
 488         which will match it against signature keys available in the kernel keyring.  Option
 489         <option>--verity-data=</option> specifies a path to a file with the Verity data to use for the OS
 490         image, in case it is stored in a detached file. It is recommended to embed the Verity data directly
 491         in the image, using the Verity mechanisms in the <ulink
 492         url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink>.
 493         </para>
 494
 495         <xi:include href="version-info.xml" xpointer="v247"/></listitem>
 496       </varlistentry>
 497
 498       <varlistentry>
 499         <term><option>--loop-ref=</option></term>
 500
 501         <listitem><para>Configures the "reference" string the kernel shall report as backing file for the
 502         loopback block device. While this is supposed to be a path or filename referencing the backing file,
 503         this is not enforced and the kernel accepts arbitrary free-form strings, chosen by the user. Accepts
 504         arbitrary strings up to a length of 63 characters. This sets the kernel's
 505         <literal>.lo_file_name</literal> field for the block device. Note this is distinct from the
 506         <filename>/sys/class/block/loopX/loop/backing_file</filename> attribute file that always reports a
 507         path referring to the actual backing file. The latter is subject to mount namespace translation, the
 508         former is not.</para>
 509
 510         <para>This setting is particularly useful in combination with the <option>--attach</option> command,
 511         as it allows later referencing the allocated loop device via
 512         <filename>/dev/disk/by-loop-ref/…</filename> symlinks. Example: first, set up the loopback device
 513         via <command>systemd-dissect attach --loop-ref=quux foo.raw</command>, and then reference it in a
 514         command via the specified filename: <command>cfdisk /dev/disk/by-loop-ref/quux</command>.
 515         </para>
 516
 517         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
 518       </varlistentry>
 519
 520       <varlistentry>
 521         <term><option>--mtree-hash=no</option></term>
 522
 523         <listitem><para>If combined with <option>--mtree</option>, turns off inclusion of file hashes in the
 524         mtree output. This makes the <option>--mtree</option> faster when operating on large images.
 525         </para>
 526
 527         <xi:include href="version-info.xml" xpointer="v254"/></listitem>
 528       </varlistentry>
 529
 530       <varlistentry>
 531         <term><option>--system</option></term>
 532         <term><option>--user</option></term>
 533
 534         <listitem><para>When used together with <option>--discover</option> controls whether to search for
 535         images installed system-wide or in the user's directories in <varname>$HOME</varname>. If neither
 536         switch is specified, will search within both scopes.</para>
 537
 538         <xi:include href="version-info.xml" xpointer="v258"/></listitem>
 539       </varlistentry>
 540
 541       <varlistentry>
 542         <term><option>--all</option></term>
 543
 544         <listitem><para>If combined with <option>--discover</option>, also shows images that start with a
 545         dot, i.e. hidden images.</para>
 546
 547         <xi:include href="version-info.xml" xpointer="v258"/></listitem>
 548       </varlistentry>
 549
 550       <xi:include href="standard-options.xml" xpointer="image-policy-open" />
 551       <xi:include href="standard-options.xml" xpointer="no-pager" />
 552       <xi:include href="standard-options.xml" xpointer="no-legend" />
 553       <xi:include href="standard-options.xml" xpointer="json" />
 554     </variablelist>
 555   </refsect1>
 556
 557   <refsect1>
 558     <title>Exit status</title>
 559
 560     <para>On success, 0 is returned, a non-zero failure code otherwise. If the <option>--with</option>
 561     command is used the exit status of the invoked command is propagated.</para>
 562   </refsect1>
 563
 564   <refsect1>
 565     <title>Invocation as <command>/sbin/mount.ddi</command></title>
 566
 567     <para>The <command>systemd-dissect</command> executable may be symlinked to
 568     <filename>/sbin/mount.ddi</filename>. If invoked through that it implements <citerefentry
 569     project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>'s
 570     "external helper" interface for the (pseudo) file system type <literal>ddi</literal>. This means
 571     conformant disk images may be mounted directly via</para>
 572
 573     <programlisting># mount -t ddi myimage.raw targetdir/</programlisting>
 574
 575     <para>in a fashion mostly equivalent to:</para>
 576
 577     <programlisting># systemd-dissect --mount myimage.raw targetdir/</programlisting>
 578
 579     <para>Note that since a single DDI may contain multiple file systems it should later be unmounted with
 580     <command>umount -R targetdir/</command>, for recursive operation.</para>
 581
 582     <para>This functionality is particularly useful to mount DDIs automatically at boot via simple
 583     <filename>/etc/fstab</filename> entries. For example:</para>
 584
 585     <programlisting>/path/to/myimage.raw /images/myimage/ ddi defaults 0 0</programlisting>
 586
 587     <para>When invoked this way the mount options <literal>ro</literal>, <literal>rw</literal>,
 588     <literal>discard</literal>, <literal>nodiscard</literal> map to the corresponding options listed above
 589     (i.e. <option>--read-only</option>, <option>--discard=all</option>,
 590     <option>--discard=disabled</option>). Mount options are <emphasis>not</emphasis> generically passed on to
 591     the file systems inside the images.</para>
 592   </refsect1>
 593
 594   <refsect1>
 595     <title>Examples</title>
 596
 597     <example>
 598       <title>Generate a tarball from an OS disk image (<option>--with</option>)</title>
 599
 600       <programlisting># systemd-dissect --with foo.raw tar cz . >foo.tar.gz</programlisting>
 601     </example>
 602
 603     <para>or alternatively just:</para>
 604
 605     <example>
 606       <title>Generate a tarball from an OS disk image (<option>--make-archive</option>)</title>
 607
 608       <programlisting># systemd-dissect --make-archive foo.raw foo.tar.gz</programlisting>
 609     </example>
 610   </refsect1>
 611
 612   <refsect1>
 613     <title>See Also</title>
 614     <para><simplelist type="inline">
 615       <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
 616       <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
 617       <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
 618       <member><citerefentry><refentrytitle>systemd.v</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
 619       <member><ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink></member>
 620       <member><citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
 621       <member><citerefentry project='man-pages'><refentrytitle>umount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
 622       <member><citerefentry project='man-pages'><refentrytitle>fdisk</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
 623     </simplelist></para>
 624   </refsect1>
 625
 626 </refentry>