2021-10-26 21:06:50 +00:00
|
|
|
.. BTRFS documentation master file
|
2021-10-26 20:48:27 +00:00
|
|
|
|
|
|
|
|
Welcome to BTRFS documentation!
|
|
|
|
|
===============================
|
|
|
|
|
|
2023-11-30 23:53:40 +00:00
|
|
|
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
|
|
|
|
|
:doc:`introduction<Introduction>` or choose from the pages below. Documentation
|
|
|
|
|
for for command line tools :doc:`btrfs`, :doc:`mkfs.btrfs` and others
|
|
|
|
|
is in the :doc:`manual pages<man-index>`.
|
|
|
|
|
|
|
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
<table><tr><td class="main-table-col">
|
|
|
|
|
|
2021-10-26 20:48:27 +00:00
|
|
|
.. toctree::
|
2021-10-26 21:06:50 +00:00
|
|
|
:maxdepth: 1
|
2021-11-30 15:00:48 +00:00
|
|
|
:caption: Overview
|
2021-10-26 20:48:27 +00:00
|
|
|
|
2021-11-30 15:00:48 +00:00
|
|
|
Introduction
|
2023-03-17 19:40:30 +00:00
|
|
|
Status
|
2021-10-26 21:06:50 +00:00
|
|
|
man-index
|
2022-01-11 23:09:29 +00:00
|
|
|
Administration
|
2022-05-12 18:39:29 +00:00
|
|
|
Hardware
|
2022-06-14 18:39:42 +00:00
|
|
|
Feature-by-version
|
2023-03-17 21:18:55 +00:00
|
|
|
Kernel-by-version
|
2023-06-01 18:46:06 +00:00
|
|
|
CHANGES
|
2023-05-26 16:14:16 +00:00
|
|
|
Contributors
|
2022-05-10 13:48:50 +00:00
|
|
|
Glossary
|
2022-05-12 11:56:03 +00:00
|
|
|
INSTALL
|
2023-05-26 16:14:16 +00:00
|
|
|
Source-repositories
|
2021-10-26 20:48:27 +00:00
|
|
|
|
2023-11-30 23:53:40 +00:00
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
</td><td class="main-table-col">
|
|
|
|
|
|
2021-11-30 15:00:48 +00:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
2023-11-30 23:53:40 +00:00
|
|
|
:caption: Features
|
2021-11-30 15:00:48 +00:00
|
|
|
|
|
|
|
|
Common-features
|
|
|
|
|
Custom-ioctls
|
|
|
|
|
Auto-repair
|
|
|
|
|
Balance
|
|
|
|
|
Compression
|
|
|
|
|
Checksumming
|
|
|
|
|
Convert
|
|
|
|
|
Deduplication
|
|
|
|
|
Defragmentation
|
|
|
|
|
Inline-files
|
|
|
|
|
Qgroups
|
|
|
|
|
Reflink
|
|
|
|
|
Resize
|
|
|
|
|
Scrub
|
|
|
|
|
Seeding-device
|
|
|
|
|
Send-receive
|
2022-05-13 16:54:14 +00:00
|
|
|
Subpage
|
2021-11-30 15:00:48 +00:00
|
|
|
Subvolumes
|
2022-01-11 22:56:25 +00:00
|
|
|
Swapfile
|
2021-11-30 15:00:48 +00:00
|
|
|
Tree-checker
|
|
|
|
|
Trim
|
|
|
|
|
Volume-management
|
|
|
|
|
Zoned-mode
|
|
|
|
|
|
2023-11-30 23:53:40 +00:00
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
</td><td class="main-table-col">
|
|
|
|
|
|
2023-04-04 22:20:41 +00:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: Developer documentation
|
|
|
|
|
|
2023-04-04 22:56:29 +00:00
|
|
|
dev/Development-notes
|
2023-04-04 23:16:52 +00:00
|
|
|
dev/Developer-s-FAQ
|
2023-12-05 18:32:54 +00:00
|
|
|
DocConventions
|
2023-04-04 22:20:41 +00:00
|
|
|
dev/Experimental
|
|
|
|
|
dev/dev-btrfs-design
|
2023-04-04 23:39:42 +00:00
|
|
|
dev/dev-btrees
|
|
|
|
|
dev/On-disk-format
|
2023-04-04 22:20:41 +00:00
|
|
|
dev/dev-send-stream
|
2023-08-18 16:14:15 +00:00
|
|
|
dev/dev-json
|
2023-08-21 14:54:01 +00:00
|
|
|
dev/dev-internal-apis
|
2023-08-23 15:58:06 +00:00
|
|
|
dev/ReleaseChecklist
|
2023-04-04 22:20:41 +00:00
|
|
|
btrfs-ioctl
|
|
|
|
|
|
2023-11-30 23:53:40 +00:00
|
|
|
|
|
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
</td></tr></table>
|
|
|
|
|
|
|
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2021-11-30 15:00:48 +00:00
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
:caption: TODO
|
|
|
|
|
|
2021-12-17 09:49:39 +00:00
|
|
|
Quick-start
|
2021-11-30 15:00:48 +00:00
|
|
|
Interoperability
|
|
|
|
|
trouble-index
|
