btrfs(8) - f31

1BTRFS(8)                         Btrfs Manual                         BTRFS(8)
2
3
4

NAME

6       btrfs - a toolbox to manage btrfs filesystems
7

SYNOPSIS

9       btrfs <command> [<args>]
10

DESCRIPTION

12       The btrfs utility is a toolbox for managing btrfs filesystems. There
13       are command groups to work with subvolumes, devices, for whole
14       filesystem or other specific actions. See section COMMANDS.
15
16       There are also standalone tools for some tasks like btrfs-convert or
17       btrfstune that were separate historically and/or haven’t been merged to
18       the main utility. See section STANDALONE TOOLS for more details.
19
20       For other topics (mount options, etc) please refer to the separate
21       manual page btrfs(5).
22

COMMAND SYNTAX

24       Any command name can be shortened so long as the shortened form is
25       unambiguous, however, it is recommended to use full command names in
26       scripts. All command groups have their manual page named btrfs-<group>.
27
28       For example: it is possible to run btrfs sub snaps instead of btrfs
29       subvolume snapshot. But btrfs file s is not allowed, because file s may
30       be interpreted both as filesystem show and as filesystem sync.
31
32       If the command name is ambiguous, the list of conflicting options is
33       printed.
34
35       For an overview of a given command use btrfs command --help or btrfs
36       [command...] --help --full to print all available options.
37

COMMANDS

39       balance
40           Balance btrfs filesystem chunks across single or several devices.
41
42           See btrfs-balance(8) for details.
43
44       check
45           Do off-line check on a btrfs filesystem.
46
47           See btrfs-check(8) for details.
48
49       device
50           Manage devices managed by btrfs, including add/delete/scan and so
51           on.
52
53           See btrfs-device(8) for details.
54
55       filesystem
56           Manage a btrfs filesystem, including label setting/sync and so on.
57
58           See btrfs-filesystem(8) for details.
59
60       inspect-internal
61           Debug tools for developers/hackers.
62
63           See btrfs-inspect-internal(8) for details.
64
65       property
66           Get/set a property from/to a btrfs object.
67
68           See btrfs-property(8) for details.
69
70       qgroup
71           Manage quota group(qgroup) for btrfs filesystem.
72
73           See btrfs-qgroup(8) for details.
74
75       quota
76           Manage quota on btrfs filesystem like enabling/rescan and etc.
77
78           See btrfs-quota(8) and btrfs-qgroup(8) for details.
79
80       receive
81           Receive subvolume data from stdin/file for restore and etc.
82
83           See btrfs-receive(8) for details.
84
85       replace
86           Replace btrfs devices.
87
88           See btrfs-replace(8) for details.
89
90       rescue
91           Try to rescue damaged btrfs filesystem.
92
93           See btrfs-rescue(8) for details.
94
95       restore
96           Try to restore files from a damaged btrfs filesystem.
97
98           See btrfs-restore(8) for details.
99
100       scrub
101           Scrub a btrfs filesystem.
102
103           See btrfs-scrub(8) for details.
104
105       send
106           Send subvolume data to stdout/file for backup and etc.
107
108           See btrfs-send(8) for details.
109
110       subvolume
111           Create/delete/list/manage btrfs subvolume.
112
113           See btrfs-subvolume(8) for details.
114

STANDALONE TOOLS

116       New functionality could be provided using a standalone tool. If the
117       functionality proves to be useful, then the standalone tool is declared
118       obsolete and its functionality is copied to the main tool. Obsolete
119       tools are removed after a long (years) depreciation period.
120
121       Tools that are still in active use without an equivalent in btrfs:
122
123       btrfs-convert
124           in-place conversion from ext2/3/4 filesystems to btrfs
125
126       btrfstune
127           tweak some filesystem properties on a unmounted filesystem
128
129       btrfs-select-super
130           rescue tool to overwrite primary superblock from a spare copy
131
132       btrfs-find-root
133           rescue helper to find tree roots in a filesystem
134
135       Deprecated and obsolete tools:
136
137       btrfs-debug-tree
138           moved to btrfs inspect-internal dump-tree. Removed from source
139           distribution.
140
141       btrfs-show-super
142           moved to btrfs inspect-internal dump-super, standalone removed.
143
144       btrfs-zero-log
145           moved to btrfs rescue zero-log, standalone removed.
146
147       For space-constrained environments, it’s possible to build a single
148       binary with functionality of several standalone tools. This is
149       following the concept of busybox where the file name selects the
150       functionality. This works for symlinks or hardlinks. The full list can
151       be obtained by btrfs help --box.
152

EXIT STATUS

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

AVAILABILITY

158       btrfs is part of btrfs-progs. Please refer to the btrfs wiki
159       http://btrfs.wiki.kernel.org for further details.
160