Btrfs-progs: add missing man page information for btrfsck

Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
Signed-off-by: Chris Mason <chris.mason@fusionio.com>
This commit is contained in:
Wang Shilong 2013-08-14 12:29:10 +08:00 committed by David Sterba
parent fa25b35dcc
commit e9c0fe428e
1 changed files with 24 additions and 11 deletions

View File

@ -1,16 +1,29 @@
.TH BTRFSCK 8
.SH NAME
btrfsck \- check a btrfs filesystem
btrfsck \- check and repair of a Btrfs filesystem
.SH SYNOPSIS
.B btrfsck \fI device\fP
.B btrfsck [\fIoptions\fP] \fI<device>\fP
.SH DESCRIPTION
\fBbtrfsck\fP is used to check a btrfs filesystem.
\fIdevice\fP is the device file where the filesystem is stored.
.SH AVAILABILITY
.B btrfsck
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.
\fBbtrfsck\fP is used to check and optionally repair of a Btrfs filesystem. Now, it can only be run on an unmounted FS. Considering it is not well-tested
in real-life situations yet. if you have a broken Btrfs filesystem, btrfsck may not repair but cause aditional damages. \fI<device>\fP is the device file
where the filesystem is stored.
\fIOptions\fP
.IP "\fB-s,--super \fI<superblock>\fP" 5
specify which superblock copy that you want to use.
.IP "\fB--repair\fP" 5
try to repair the filesystem.
.IP "\fB--init-csum-tree\fP" 5
create a new CRC tree.
.IP "\fB--init-extent-tree\fP" 5
create a new extent tree.
.SH EXIT CODE
\fBbtrfsck\fR will return 0 exit code if no error happened.
Other exit code means some problems happened.
.br
This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.
.SH SEE ALSO
.BR mkfs.btrfs (8)
.BR mkfs.btrfs (8),
.BR btrfs (8)