Documentation/btrfs-check.txt

   1 btrfs-check(8)
   2 ==============
   3
   4 NAME
   5 ----
   6 btrfs-check - check or repair a btrfs filesystem offline
   7
   8 SYNOPSIS
   9 --------
  10 'btrfs check' [options] <device>
  11
  12 DESCRIPTION
  13 -----------
  14 'btrfs check' is used to check or repair a btrfs filesystem offline.
  15
  16 NOTE: Since btrfs is under heavy development especially the 'btrfs check'
  17 command, it is *highly* recommended to read the following btrfs wiki before
  18 executing 'btrfs check' with '--repair' option: +
  19 https://btrfs.wiki.kernel.org/index.php/Btrfsck
  20
  21 OPTIONS
  22 -------
  23 -s|--support <superblock>::
  24 use <superblock>th superblock copy.
  25 --repair::
  26 try to repair the filesystem.
  27 --init-csum-tree::
  28 create a new CRC tree.
  29 --init-extent-tree::
  30 create a new extent tree.
  31
  32 EXIT STATUS
  33 -----------
  34 'btrfs check' returns a zero exist status if it succeeds. Non zero is
  35 returned in case of failure.
  36
  37 AVAILABILITY
  38 ------------
  39 'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
  40 development,
  41 and not suitable for any uses other than benchmarking and review.
  42 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
  43 further details.
  44
  45 SEE ALSO
  46 --------
  47 `mkfs.btrfs`(8),
  48 `btrfs-scrub`(8),
  49 `btrfs-rescue`(8)
  50 `btrfsck`(8)