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 filesystem
  28 -b|--backup::
  29 use the first backup roots stored in the superblock that is valid
  30 --repair::
  31 try to repair the filesystem
  32 --readonly::
  33 run in read-only mode (default)
  34 --init-csum-tree::
  35 create a new CRC tree and recalculate all checksums
  36 --init-extent-tree::
  37 create a new extent tree
  38 --check-data-csum::
  39 verify checksums of data blocks
  40 -p|--progress::
  41 indicate progress at various checking phases
  42 --qgroup-report::
  43 verify qgroup accounting and compare against filesystem accounting
  44 -E|--subvol-extents <subvolid>::
  45 show extent state for the given subvolume
  46 -r|--tree-root <bytenr>::
  47 use the given bytenr for the tree root
  48 --chunk-root <bytenr>::
  49 use the given bytenr for the chunk tree root
  50
  51 EXIT STATUS
  52 -----------
  53 *btrfs check* returns a zero exit status if it succeeds. Non zero is
  54 returned in case of failure.
  55
  56 AVAILABILITY
  57 ------------
  58 *btrfs* is part of btrfs-progs.
  59 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
  60 further details.
  61
  62 SEE ALSO
  63 --------
  64 `mkfs.btrfs`(8),
  65 `btrfs-scrub`(8),
  66 `btrfs-rescue`(8)