diff --git a/Documentation/Makefile b/Documentation/Makefile index 68b7e1f7..a838ca1d 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -21,7 +21,7 @@ MAN8_TXT += btrfs-filesystem.txt MAN8_TXT += btrfs-balance.txt MAN8_TXT += btrfs-device.txt MAN8_TXT += btrfs-scrub.txt -#MAN8_TXT += btrfs-check.txt +MAN8_TXT += btrfs-check.txt #MAN8_TXT += btrfs-rescue.txt #MAN8_TXT += btrfs-inspect-internal.txt #MAN8_TXT += btrfs-send.txt diff --git a/Documentation/btrfs-check.txt b/Documentation/btrfs-check.txt new file mode 100644 index 00000000..accbed4e --- /dev/null +++ b/Documentation/btrfs-check.txt @@ -0,0 +1,45 @@ +btrfs-check(8) +============== + +NAME +---- +btrfs-check - check or repair a btrfs filesystem offline + +SYNOPSIS +-------- +'btrfs check' [options] + +DESCRIPTION +----------- +'btrfs check' is used to check or repair a btrfs filesystem offline. + +OPTIONS +------- +-s|--support :: +use th superblock copy. +--repair:: +try to repair the filesystem. +--init-csum-tree:: +create a new CRC tree. +--init-extent-tree:: +create a new extent tree. + +EXIT STATUS +----------- +'btrfs check' returns a zero exist status if it succeeds. Non zero is +returned in case of failure. + +AVAILABILITY +------------ +'btrfs' is part of btrfs-progs. Btrfs filesystem 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. + +SEE ALSO +-------- +`mkfs.btrfs`(8), +`btrfs-scrub`(8), +`btrfs-rescue`(8) +`btrfsck`(8)