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 'btrfsck' is an alias of 'btrfs check' command and is now deprecated.
  22
  23 OPTIONS
  24 -------
  25 -s|--support <superblock>::
  26 use <superblock>th superblock copy.
  27 --repair::
  28 try to repair the filesystem.
  29 --init-csum-tree::
  30 create a new CRC tree.
  31 --init-extent-tree::
  32 create a new extent tree.
  33
  34 EXIT STATUS
  35 -----------
  36 'btrfs check' returns a zero exist status if it succeeds. Non zero is
  37 returned in case of failure.
  38
  39 AVAILABILITY
  40 ------------
  41 'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
  42 development,
  43 and not suitable for any uses other than benchmarking and review.
  44 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
  45 further details.
  46
  47 SEE ALSO
  48 --------
  49 `mkfs.btrfs`(8),
  50 `btrfs-scrub`(8),
  51 `btrfs-rescue`(8)