btrfs-progs/man/btrfs-image.8.in
Josef Bacik 1ed8193d19 Btrfs-progs: add an option to btrfs-image to walk the trees
When working with a user with a broken file system I noticed I wasn't able to
read some of the blocks properly from the restored image.  This is because his
extent tree was corrupt and was missing references to some of the blocks, which
means they weren't copied into the image when he generated it.  So add a -w
option which will walk all of the trees manually and copy them into the image.
This way we can run fsck against a complete file system image and fix any bugs
in fsck.  Thanks,

Signed-off-by: Josef Bacik <jbacik@fusionio.com>
2013-04-23 18:56:26 +02:00

44 lines
1.3 KiB
Groff

.TH BTRFS-IMAGE 8
.SH NAME
btrfs-image \- create/restore an image of the filesystem
.SH SYNOPSIS
.B btrfs-image
[options] \fIsource\fP \fItarget\fP
.SH DESCRIPTION
.B btrfs-image
is used to create an image of a btrfs filesystem. All data will be zeroed,
but metadata and the like is preserved.
.I source
is the special file corresponding to the device containing a btrfs filesystem.
(e.g \fI/dev/sdXX\fP).
.I target
is the image file that btrfs-image creates. When used with \fB-r\fP option,
\fBbtrfs-image\fP restores the image file from source into target.
.SH OPTIONS
.TP
\fB\-r\fP
restore metadump image.
.TP
\fB\-c\fR \fIvalue\fP
compression level (0 ~ 9).
.TP
\fB\-t\fR \fIvalue\fP
number of threads (1 ~ 32) to be used to process the image dump or restore.
.TP
\fB\-o\fP
use the old restore method, this does not fixup the chunk tree so the restored
file system will not be able to be mounted.
.TP
\fB\-w\fP
Walk all the trees manually and copy any blocks that are referenced. Use this
option if your extent tree is corrupted to make sure that all of the metadata is
captured.
.SH AVAILABILITY
.B btrfs-image
is part of btrfs-progs. Btrfs is currently under heavy development,
and not suitable for any uses other than benchmarking and review.
Please refer to the btrfs wiki
http://btrfs.wiki.kernel.org for further details.
.SH SEE ALSO
.BR btrfsck (8), mkfs.btrfs (8)