Manpage/btrfs-check

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
(update)
(update from git)
Line 6: Line 6:
 
==NAME==
 
==NAME==
  
btrfs-check - check or repair a btrfs filesystem offline
+
btrfs-check - check or repair an unmounted btrfs filesystem
  
 
==SYNOPSIS==
 
==SYNOPSIS==
Line 14: Line 14:
 
==DESCRIPTION==
 
==DESCRIPTION==
  
'''btrfs check''' is used to check or repair a btrfs filesystem offline.
+
'''btrfs check''' is used to check or repair an unmounted btrfs filesystem.
  
'''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:<br />https://btrfs.wiki.kernel.org/index.php/Btrfsck
+
'''Note:''' Since btrfs is under development, the '''btrfs check''' capabilities are continuously enhanced. It’s highly recommended to read the following btrfs wiki before executing '''btrfs check''' with '''--repair''' option:<br />https://btrfs.wiki.kernel.org/index.php/Btrfsck
  
 
'''btrfsck''' is an alias of '''btrfs check''' command and is now deprecated.
 
'''btrfsck''' is an alias of '''btrfs check''' command and is now deprecated.
Line 23: Line 23:
  
 
; -s|--super &lt;superblock&gt;
 
; -s|--super &lt;superblock&gt;
: use &lt;superblock&gt;th superblock copy.
+
: use &lt;superblock&gt;th superblock copy, valid values are 0 up to 2 if the respective superblock offset is within the fileystem
 
; --repair
 
; --repair
: try to repair the filesystem.
+
: try to repair the filesystem
 
; --init-csum-tree
 
; --init-csum-tree
: create a new CRC tree.
+
: create a new CRC tree and recalculate all checksums
 
; --init-extent-tree
 
; --init-extent-tree
: create a new extent tree.
+
: create a new extent tree
 
; --check-data-csum
 
; --check-data-csum
: verify checkums of data blocks.
+
: verify checkums of data blocks
 +
; --qgroup-report
 +
: verify qgroup accounting and compare against filesystem accounting
 +
; --subvol-extents &lt;subvolid&gt;
 +
: show extent state for a subvolume
 +
; --tree-root &lt;bytenr&gt;
 +
: use the given bytenr for the tree root
  
 
==EXIT STATUS==
 
==EXIT STATUS==
  
'''btrfs check''' returns a zero exist status if it succeeds. Non zero is returned in case of failure.
+
'''btrfs check''' returns a zero exit status if it succeeds. Non zero is returned in case of failure.
  
 
==AVAILABILITY==
 
==AVAILABILITY==

Revision as of 01:41, 6 April 2015

Contents

btrfs-check(8) Manual Page

Warning: this page is automatically generated from git, all edits will be lost.



NAME

btrfs-check - check or repair an unmounted btrfs filesystem

SYNOPSIS

btrfs check [options] <device>

DESCRIPTION

btrfs check is used to check or repair an unmounted btrfs filesystem.

Note: Since btrfs is under development, the btrfs check capabilities are continuously enhanced. It’s 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, valid values are 0 up to 2 if the respective superblock offset is within the fileystem
--repair
try to repair the filesystem
--init-csum-tree
create a new CRC tree and recalculate all checksums
--init-extent-tree
create a new extent tree
--check-data-csum
verify checkums of data blocks
--qgroup-report
verify qgroup accounting and compare against filesystem accounting
--subvol-extents <subvolid>
show extent state for a subvolume
--tree-root <bytenr>
use the given bytenr for the tree root

EXIT STATUS

btrfs check returns a zero exit status if it succeeds. Non zero is returned in case of failure.

AVAILABILITY

btrfs is part of btrfs-progs. 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)

Personal tools