Welcome to BTRFS documentation!

BTRFS is a modern copy on write (COW) filesystem for Linux aimed at implementing advanced features while also focusing on fault tolerance, repair and easy administration. You can read more about the features in the introduction or choose from the pages below. Documentation for command line tools btrfs(8), mkfs.btrfs(8) and others is in the manual pages.

Overview Introduction Status Manual pages Administration Hardware considerations Changes (feature/version) Changes (kernel/version) Changes (btrfs-progs) Contributors Glossary Installation instructions Source repositories Interoperability

Features Common Linux features Custom ioctls Auto-repair on read Balance Compression Checksumming Convert Deduplication Defragmentation Inline files Quota groups Reflink Resize Scrub Seeding device Send/receive Subpage support Subvolumes Swapfile Tree checker Trim/discard Volume management Zoned mode

Developer documentation Development notes Developer’s FAQ Conventions and style for documentation Experimental features Btrfs design Btrees On-disk Format Send stream format JSON output Internal APIs Release checklist Pull request review workflow Command line, formatting, UI guidelines btrfs-ioctl(2)

Need help?

Assistance is available from the #btrfs channel on Libera Chat or the linux-btrfs mailing list. Issues with the userspace btrfs tools can be reported to the btrfs-progs issue tracker on GitHub.

---

This documentation is still work in progress, not everything from the original wiki https://btrfs.wiki.kernel.org has been moved here. Below are starting points for missing contents.

TODO

• Troubleshooting pages