Whamcloud - gitweb
e4defrag: adjust total count when files change during the run
[tools/e2fsprogs.git] / misc / e2image.8.in
index ba97ef8..a7bfdf2 100644 (file)
@@ -8,18 +8,36 @@ e2image \- Save critical ext2/ext3/ext4 filesystem metadata to a file
 .SH SYNOPSIS
 .B e2image
 [
-.B \-rsIQa
+.B \-r|Q
+]
+[
+.B \-f
+]
+.I device
+.I image-file
+.br
+.B e2image
+.B \-I
+.I device
+.I image-file
+.br
+.B e2image
+.B \-ra
+[
+.B \-cfnp
 ]
 [
 .B \-o
-.I source_offset
+.I src_offset
 ]
 [
 .B \-O
 .I dest_offset
 ]
-.I device
-.I image-file
+.I src_fs
+[
+.I dest_fs
+]
 .SH DESCRIPTION
 The
 .B e2image
@@ -44,8 +62,8 @@ or
 .B \-Q
 options, the filesystem must be unmounted or be mounted read/only, in order
 for the image file to be in a consistent state.  This requirement can be
-overriden using the
-.B -f
+overridden using the
+.B \-f
 option, but the resulting image file is very likely not going to be useful.
 .PP
 If
@@ -207,7 +225,21 @@ only includes fs metadata, not regular file data.  The
 option can be specified to include all data.  This will
 give an image that is suitable to use to clone the entire FS or
 for backup purposes.  Note that this option only works with the
-raw or QCOW2 formats.
+raw or QCOW2 formats.  The
+.B \-p
+switch may be given to show progress.  If the file system is being
+cloned to a flash-based storage device (where reads are very fast and
+where it is desirable to avoid unnecessary writes to reduce write wear
+on the device), the
+.B \-c
+option which cause e2image to try reading a block from the destination
+to see if it is identical to the block which
+.B e2image
+is about to copy.  If the block is already the same, the write can be
+skipped.  The
+.B \-n
+option will cause all of the writes to be no-ops, and print the blocks
+that would have been written.
 .PP
 .SH OFFSETS
 Normally a filesystem starts at the beginning of a partition, and
@@ -237,6 +269,9 @@ MiB for a partition table with:
 \      \fBe2image -arO 1048576 /dev/sda1 img\fR
 .br
 .PP
+If you specify at least one offset, and only one file, an in-place
+move will be performed, allowing you to safely move the filesystem
+from one offset to another.
 .SH AUTHOR
 .B e2image
 was written by Theodore Ts'o (tytso@mit.edu).