← Back to branch summary

~ubuntu-branches/debian/stretch/btrfs-tools/stretch

« back to all changes in this revision

Viewing changes to .pc/0005-Update-references-to-btrfs-tools-instead-of-btrfs-pr.patch/man/btrfs-image.8.in

  • Committer: Package Import Robot
  • Author(s): Dimitri John Ledkov
  • Date: 2014-04-19 12:12:11 UTC
  • mfrom: (1.2.12) (6.1.37 sid)
  • Revision ID: package-import@ubuntu.com-20140419121211-mski0g757tsdv4x1
Tags: 3.14.1-1
* New upstream release.
* Switch to git-dpm.
* Rebase and cleanup patches.

Show diffs side-by-side

added added

removed removed

Lines of Context:
.pc/0005-Update-references-to-btrfs-tools-instead-of-btrfs-pr.patch/man/btrfs-image.8.in
 
1
.TH BTRFS-IMAGE 8
 
2
.SH NAME
 
3
btrfs-image \- create/restore an image of the filesystem
 
4
.SH SYNOPSIS
 
5
.B btrfs-image
 
6
[options] \fIsource\fP \fItarget\fP
 
7
.SH DESCRIPTION
 
8
.B btrfs-image
 
9
is used to create an image of a btrfs filesystem. All data will be zeroed,
 
10
but metadata and the like is preserved.
 
11
.I source
 
12
is the special file corresponding to the device containing a btrfs filesystem.
 
13
(e.g \fI/dev/sdXX\fP).
 
14
.I target
 
15
is the image file that btrfs-image creates. When used with \fB-r\fP option,
 
16
\fBbtrfs-image\fP restores the image file from source into target.
 
17
.SH OPTIONS
 
18
.TP
 
19
\fB\-r\fP
 
20
Restore metadump image. By default, this fixes super's chunk tree, by
 
21
using 1 stripe pointing to primary device, so that file system can be
 
22
restored by running tree log reply if possible. To restore without
 
23
changing number of stripes in chunk tree check \fB-o\fP option.
 
24
.TP
 
25
\fB\-c\fR \fIvalue\fP
 
26
compression level (0 ~ 9).
 
27
.TP
 
28
\fB\-t\fR \fIvalue\fP
 
29
number of threads (1 ~ 32) to be used to process the image dump or restore.
 
30
.TP
 
31
\fB\-o\fP
 
32
use the old restore method, this does not fixup the chunk tree so the restored
 
33
file system will not be able to be mounted.
 
34
.TP
 
35
\fB\-s\fP
 
36
Sanitize the file names when generating the image. One \fB-s\fP means just
 
37
generate random garbage, which means that the directory indexes won't match up
 
38
since the hashes won't match with the garbage filenames. Using \fB-ss\fP will
 
39
calculate a collision for the filename so that the hashes match, and if it
 
40
can't calculate a collision then it will just generate garbage.  The collision
 
41
calculator is very time and CPU intensive so only use it if you are having
 
42
problems with your file system tree and need to have it mostly working.
 
43
.TP
 
44
\fB\-w\fP
 
45
Walk all the trees manually and copy any blocks that are referenced. Use this
 
46
option if your extent tree is corrupted to make sure that all of the metadata is
 
47
captured.
 
48
.SH AVAILABILITY
 
49
.B btrfs-image
 
50
is part of btrfs-progs. Btrfs is currently under heavy development,
 
51
and not suitable for any uses other than benchmarking and review.
 
52
Please refer to the btrfs wiki
 
53
http://btrfs.wiki.kernel.org for further details.
 
54
.SH SEE ALSO
 
55
.BR btrfsck (8), mkfs.btrfs (8)