From: Lennart Poettering <lennart@poettering.net>
Date: Wed, 9 Nov 2022 11:12:02 +0000 (+0100)
Subject: man: document new systemd-dissect --mtree switch
X-Git-Tag: v253-rc1~562^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=b5b40106c7a733d8a88268a91fd08a2edb395cae;p=thirdparty%2Fsystemd.git

man: document new systemd-dissect --mtree switch
---

diff --git a/man/systemd-dissect.xml b/man/systemd-dissect.xml
index f857ecacc7c..0b6bf793cea 100644
--- a/man/systemd-dissect.xml
+++ b/man/systemd-dissect.xml
@@ -34,6 +34,9 @@
     <cmdsynopsis>
       <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--list</option> <arg choice="plain"><replaceable>IMAGE</replaceable></arg></command>
     </cmdsynopsis>
+    <cmdsynopsis>
+      <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--mtree</option> <arg choice="plain"><replaceable>IMAGE</replaceable></arg></command>
+    </cmdsynopsis>
     <cmdsynopsis>
       <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--with</option> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="opt" rep="repeat"><replaceable>COMMAND</replaceable></arg></command>
     </cmdsynopsis>
@@ -163,6 +166,23 @@
         standard output.</para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><option>--mtree</option></term>
+        <term><option>-l</option></term>
+
+        <listitem><para>Generates a BSD <citerefentry
+        project='die-net'><refentrytitle>mtree</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+        compatible file manifest of the specified disk image. This is useful for comparing disk image
+        contents in detail, including inode information and other metadata. While the generated manifest will
+        contain detailed inode information, it currently excludes extended attributes, file system
+        capabilities, MAC labels, <citerefentry
+        project='man-pages'><refentrytitle>chattr</refentrytitle><manvolnum>1</manvolnum></citerefentry> file
+        flags, btrfs subvolume information, and various other file metadata. File content information is
+        shown via a SHA256 digest. Additional fields might be added in future. Note that inode information
+        such as link counts, inode numbers and timestamps is excluded from the output on purpose, as it
+        typically complicates reproducibility.</para></listitem>
+      </varlistentry>
+
       <varlistentry>
         <term><option>--with</option></term>