The btrfs utility is a toolbox for managing btrfs filesystems. There
are command groups to work with subvolumes, devices, for whole
filesystem or other specific actions. See section COMMANDS.
There are also standalone tools for some tasks like btrfs-convert or
btrfstune that were separate historically and/or haven’t been merged
to the main utility. See section STANDALONE TOOLS for more details.
For other topics (mount options, etc) please refer to the separate
manual page btrfs(5).
Any command name can be shortened as far as it stays unambiguous,
however it is recommended to use full command names in scripts. All
command groups have their manual page named btrfs-<group>.
For example: it is possible to run btrfs sub snaps instead of btrfssubvolume snapshot. But btrfs file s is not allowed, because file s
may be interpreted both as filesystem show and as filesystem sync.
If the command name is ambiguous, the list of conflicting options is
For an overview of a given command use btrfs command --help or btrfs[command...] --help --full to print all available options.
Balance btrfs filesystem chunks across single or several devices.
See btrfs-balance(8) for details.
Do off-line check on a btrfs filesystem.
See btrfs-check(8) for details.
Manage devices managed by btrfs, including add/delete/scan and so
See btrfs-device(8) for details.
Manage a btrfs filesystem, including label setting/sync and so
See btrfs-filesystem(8) for details.
Debug tools for developers/hackers.
See btrfs-inspect-internal(8) for details.
Get/set a property from/to a btrfs object.
See btrfs-property(8) for details.
Manage quota group(qgroup) for btrfs filesystem.
See btrfs-qgroup(8) for details.
Manage quota on btrfs filesystem like enabling/rescan and etc.
See btrfs-quota(8) and btrfs-qgroup(8) for details.
Receive subvolume data from stdin/file for restore and etc.
See btrfs-receive(8) for details.
Replace btrfs devices.
See btrfs-replace(8) for details.
Try to rescue damaged btrfs filesystem.
See btrfs-rescue(8) for details.
Try to restore files from a damaged btrfs filesystem.
See btrfs-restore(8) for details.
Scrub a btrfs filesystem.
See btrfs-scrub(8) for details.
Send subvolume data to stdout/file for backup and etc.
See btrfs-send(8) for details.
Create/delete/list/manage btrfs subvolume.
See btrfs-subvolume(8) for details.
There are several standalone tools to provide certain functionality.
If the functionality proves to be useful, the standalone tools are
declared obsolete and their functionality copied to the main tool.
The deprecation period is long (years) and the obsolete binaries are
Tools that are still in active use without an equivalent in btrfs:
in-place conversion from ext2/3/4 filesystems to btrfs
tweak some filesystem properties on a unmounted filesystem
rescue tool to overwrite primary superblock from a spare copy
rescue helper to find tree roots in a filesystem
Deprecated and obsolete tools:
moved to btrfs inspect-internal dump-treebtrfs-show-super
moved to btrfs inspect-internal dump-superbtrfs-zero-log
moved to btrfs rescue zero-log
This page is part of the btrfs-progs (btrfs filesystem tools)
project. Information about the project can be found at
If you have a bug report for this manual page, see
This page was obtained from the project's upstream Git repository
on 2017-03-13. If you discover any rendering problems in this HTML
version of the page, or you believe there is a better or more up-to-
date source for the page, or you have corrections or improvements to
the information in this COLOPHON (which is not part of the original
manual page), send a mail to email@example.com
Btrfs v4.6.1 09/01/2016 BTRFS(8)