Documentation/btrfs-check.asciidoc

   1 btrfs-check(8)
   2 ==============
   3
   4 NAME
   5 ----
   6 btrfs-check - check or repair an unmounted btrfs filesystem
   7
   8 SYNOPSIS
   9 --------
  10 *btrfs check* [options] <device>
  11
  12 DESCRIPTION
  13 -----------
  14 *btrfs check* is used to check or repair an unmounted btrfs filesystem.
  15
  16 NOTE: Since btrfs is under development, the *btrfs check* capabilities are
  17 continuously enhanced. It's highly recommended to read the following btrfs
  18 wiki before executing *btrfs check* with '--repair' option: +
  19 https://btrfs.wiki.kernel.org/index.php/Btrfsck
  20
  21 *btrfsck* is an alias of *btrfs check* command and is now deprecated.
  22
  23 OPTIONS
  24 -------
  25 -s|--super <superblock>::
  26 use <superblock>th superblock copy, valid values are 0 up to 2 if the
  27 respective superblock offset is within the fileystem
  28 --repair::
  29 try to repair the filesystem
  30 --init-csum-tree::
  31 create a new CRC tree and recalculate all checksums
  32 --init-extent-tree::
  33 create a new extent tree
  34 --check-data-csum::
  35 verify checkums of data blocks
  36 --qgroup-report::
  37 verify qgroup accounting and compare against filesystem accounting
  38 --subvol-extents <subvolid>::
  39 show extent state for a subvolume
  40 --tree-root <bytenr>::
  41 use the given bytenr for the tree root
  42
  43 EXIT STATUS
  44 -----------
  45 *btrfs check* returns a zero exit status if it succeeds. Non zero is
  46 returned in case of failure.
  47
  48 AVAILABILITY
  49 ------------
  50 *btrfs* is part of btrfs-progs.
  51 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
  52 further details.
  53
  54 SEE ALSO
  55 --------
  56 `mkfs.btrfs`(8),
  57 `btrfs-scrub`(8),
  58 `btrfs-rescue`(8)