btrfs-progs/Documentation/btrfs-check.txt
David Sterba a4197dfe24 btrfs-progs: doc: make all commands and subcommands bold
Italic format is used for parameters and values.  also this makes the
text visually separated,

Signed-off-by: David Sterba <dsterba@suse.cz>
2014-05-19 17:54:10 +02:00

52 lines
1.2 KiB
Plaintext

btrfs-check(8)
==============
NAME
----
btrfs-check - check or repair a btrfs filesystem offline
SYNOPSIS
--------
*btrfs check* [options] <device>
DESCRIPTION
-----------
*btrfs check* is used to check or repair a btrfs filesystem offline.
NOTE: Since btrfs is under heavy development especially the *btrfs check*
command, it is *highly* recommended to read the following btrfs wiki before
executing *btrfs check* with '--repair' option: +
https://btrfs.wiki.kernel.org/index.php/Btrfsck
*btrfsck* is an alias of *btrfs check* command and is now deprecated.
OPTIONS
-------
-s|--super <superblock>::
use <superblock>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)