btrfs-progs: docs: update dump-super
authorDavid Sterba <dsterba@suse.com>
Tue, 15 Mar 2016 16:16:00 +0000 (17:16 +0100)
committerDavid Sterba <dsterba@suse.com>
Tue, 15 Mar 2016 16:16:00 +0000 (17:16 +0100)
Signed-off-by: David Sterba <dsterba@suse.com>
Documentation/btrfs-inspect-internal.asciidoc

index fae6ed6..62d42bc 100644 (file)
@@ -20,37 +20,32 @@ requires calls to privileged ioctls.
 SUBCOMMAND
 ----------
 *dump-super* [options] <device> [device...]::
-(needs root privileges)
-+
-Show btrfs superblock information stored in devices.
-It is used to print the information of superblock,
-you can specify which mirror to print out.
+(replaces the standalone tool *btrfs-show-super*)
 +
-By default, every device's first superblock will be printed out.
+Show btrfs superblock information stored on given devices in textual form.
+By default the first superblock is printed, more details about all copies or
+additional backup data can be printed.
 +
-Mainly used for debug purpose.
+Besides verifictaion of the filesystem signature, there are no other sanity
+checks. The superblock checksum status is reported, the device item and
+filesystem UUIDs are checked and reported.
 +
 `Options`
 +
--f::::
-Print full superblock information.
-+
-Including the system chunk array and backup roots.
-+
--a::::
-Print information of all superblocks.
+-f|--full::::
+print full superblock information, including the system chunk array and backup roots
+-a|--all::::
+print information about all present superblock copies (cannot be used together with '-i' option)
+-i <super_mirror>::::
+specify which mirror to print, valid values are 0, 1 and 2 and the superblock must be present on the device
 +
-If this option is given, '-i' option will be ignored.
+If there are multiple options specified, only the last one is applies.
 +
--i <super_mirror>::::
-Specify which mirror to print out.
+-F|--force::::
+attempt to print the superblock even if thre's no valid BTRFS signature found
 +
-<super_mirror> is between 0 and 2.
-If several '-i <super_mirror>' are given, only the last one is valid.
+The result may be completely wrong if the data do not resemble a superblock.
 +
--F::::
-Attempt to print the superblock even if no superblock magic is found.  May end
-badly.
 -s <bytenr>::::
 specify offset to a superblock in a non-standard location at 'bytenr', useful
 for debugging (disables the '-f' option)