1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
btrfs-subvolume(8)
==================
SYNOPSIS
--------
**btrfs subvolume** <subcommand> [<args>]
DESCRIPTION
-----------
**btrfs subvolume** is used to create/delete/list/show btrfs subvolumes and
snapshots.
.. include:: ch-subvolume-intro.rst
SUBVOLUME AND SNAPSHOT
----------------------
A subvolume is a part of filesystem with its own independent
file/directory hierarchy. Subvolumes can share file extents. A snapshot is
also subvolume, but with a given initial content of the original subvolume.
.. note::
A subvolume in btrfs is not like an LVM logical volume, which is block-level
snapshot while btrfs subvolumes are file extent-based.
A subvolume looks like a normal directory, with some additional operations
described below. Subvolumes can be renamed or moved, nesting subvolumes is not
restricted but has some implications regarding snapshotting.
A subvolume in btrfs can be accessed in two ways:
* like any other directory that is accessible to the user
* like a separately mounted filesystem (options *subvol* or *subvolid*)
In the latter case the parent directory is not visible and accessible. This is
similar to a bind mount, and in fact the subvolume mount does exactly that.
A freshly created filesystem is also a subvolume, called *top-level*,
internally has an id 5. This subvolume cannot be removed or replaced by another
subvolume. This is also the subvolume that will be mounted by default, unless
the default subvolume has been changed (see subcommand *set-default*).
A snapshot is a subvolume like any other, with given initial content. By
default, snapshots are created read-write. File modifications in a snapshot
do not affect the files in the original subvolume.
SUBCOMMAND
-----------
create [-i <qgroupid>] [<dest>/]<name>
Create a subvolume *name* in *dest*.
If *dest* is not given, subvolume *name* will be created in the current
directory.
``Options``
-i <qgroupid>
Add the newly created subvolume to a qgroup. This option can be given multiple
times.
delete [options] [<subvolume> [<subvolume>...]], delete -i|--subvolid <subvolid> <path>
Delete the subvolume(s) from the filesystem.
If *subvolume* is not a subvolume, btrfs returns an error but continues if
there are more arguments to process.
If *--subvolid* is used, *path* must point to a btrfs filesystem. See ``btrfs
subvolume list`` or ``btrfs inspect-internal rootid`` how to get the subvolume id.
The corresponding directory is removed instantly but the data blocks are
removed later in the background. The command returns immediately. See ``btrfs
subvolume sync`` how to wait until the subvolume gets completely removed.
The deletion does not involve full transaction commit by default due to
performance reasons. As a consequence, the subvolume may appear again after a
crash. Use one of the *--commit* options to wait until the operation is
safely stored on the device.
Deleting subvolume needs sufficient permissions, by default the owner
cannot delete it unless it's enabled by a mount option
*user_subvol_rm_allowed*, or deletion is run as root.
The default subvolume (see ``btrfs subvolume set-default``) cannot be deleted and
returns error (EPERM) and this is logged to the system log. A subvolume that's
currently involved in send (see ``btrfs send``) also cannot be deleted until the
send is finished. This is also logged in the system log.
``Options``
-c|--commit-after
wait for transaction commit at the end of the operation.
-C|--commit-each
wait for transaction commit after deleting each subvolume.
-i|--subvolid <subvolid>
subvolume id to be removed instead of the <path> that should point to the
filesystem with the subvolume
-v|--verbose
(deprecated) alias for global *-v* option
find-new <subvolume> <last_gen>
List the recently modified files in a subvolume, after *last_gen* generation.
get-default <path>
Get the default subvolume of the filesystem *path*.
The output format is similar to **subvolume list** command.
list [options] [-G [\+|-]<value>] [-C [+|-]<value>] [--sort=rootid,gen,ogen,path] <path>
List the subvolumes present in the filesystem *path*.
For every subvolume the following information is shown by default:
ID *ID* gen *generation* top level *parent_ID* path *path*
where *ID* is subvolume's (root)id, *generation* is an internal counter which is
updated every transaction, *parent_ID* is the same as the parent subvolume's id,
and *path* is the relative path of the subvolume to the top level subvolume.
The subvolume's ID may be used by the subvolume set-default command,
or at mount time via the *subvolid=* option.
``Options``
Path filtering:
-o
print only subvolumes below specified <path>.
-a
print all the subvolumes in the filesystem and distinguish between
absolute and relative path with respect to the given *path*.
Field selection:
-p
print the parent ID
(*parent* here means the subvolume which contains this subvolume).
-c
print the ogeneration of the subvolume, aliases: ogen or origin generation.
-g
print the generation of the subvolume (default).
-u
print the UUID of the subvolume.
-q
print the parent UUID of the subvolume
(*parent* here means subvolume of which this subvolume is a snapshot).
-R
print the UUID of the sent subvolume, where the subvolume is the result of a receive operation.
Type filtering:
-s
only snapshot subvolumes in the filesystem will be listed.
-r
only readonly subvolumes in the filesystem will be listed.
-d
list deleted subvolumes that are not yet cleaned.
Other:
-t
print the result as a table.
Sorting:
By default the subvolumes will be sorted by subvolume ID ascending.
-G [+|-]<value>
list subvolumes in the filesystem that its generation is
>=, \<= or = value. \'\+' means >= value, \'-' means \<= value, If there is
neither \'+' nor \'-', it means = value.
-C [+|-]<value>
list subvolumes in the filesystem that its ogeneration is
>=, \<= or = value. The usage is the same to *-G* option.
--sort=rootid,gen,ogen,path
list subvolumes in order by specified items.
you can add *+* or *-* in front of each items, *+* means ascending,
*-* means descending. The default is ascending.
for *--sort* you can combine some items together by *,*, just like
*--sort=+ogen,-gen,path,rootid*.
set-default [<subvolume>|<id> <path>]
Set the default subvolume for the (mounted) filesystem.
Set the default subvolume for the (mounted) filesystem at *path*. This will hide
the top-level subvolume (i.e. the one mounted with *subvol=/* or *subvolid=5*).
Takes action on next mount.
There are two ways how to specify the subvolume, by *id* or by the *subvolume*
path.
The id can be obtained from **btrfs subvolume list**, **btrfs subvolume show** or
**btrfs inspect-internal rootid**.
show [options] <path>
Show more information about a subvolume (UUIDs, generations, times, flags,
related snapshots).
.. code-block:: none
/mnt/btrfs/subvolume
Name: subvolume
UUID: 5e076a14-4e42-254d-ac8e-55bebea982d1
Parent UUID: -
Received UUID: -
Creation time: 2018-01-01 12:34:56 +0000
Subvolume ID: 79
Generation: 2844
Gen at creation: 2844
Parent ID: 5
Top level ID: 5
Flags: -
Snapshot(s):
``Options``
-r|--rootid <ID>
show details about subvolume with root *ID*, looked up in *path*
-u|--uuid UUID
show details about subvolume with the given *UUID*, looked up in *path*
snapshot [-r] [-i <qgroupid>] <source> <dest>|[<dest>/]<name>
Create a snapshot of the subvolume *source* with the
name *name* in the *dest* directory.
If only *dest* is given, the subvolume will be named the basename of *source*.
If *source* is not a subvolume, btrfs returns an error.
``Options``
-r
Make the new snapshot read only.
-i <qgroupid>
Add the newly created subvolume to a qgroup. This option can be given multiple
times.
sync <path> [subvolid...]
Wait until given subvolume(s) are completely removed from the filesystem after
deletion. If no subvolume id is given, wait until all current deletion requests
are completed, but do not wait for subvolumes deleted in the meantime.
``Options``
-s <N>
sleep N seconds between checks (default: 1)
EXAMPLES
--------
Deleting a subvolume
^^^^^^^^^^^^^^^^^^^^
If we want to delete a subvolume called *foo* from a btrfs volume mounted at
*/mnt/bar* we could run the following:
.. code-block:: bash
btrfs subvolume delete /mnt/bar/foo
EXIT STATUS
-----------
**btrfs subvolume** returns a zero exit status if it succeeds. A non-zero value is
returned in case of failure.
AVAILABILITY
------------
**btrfs** is part of btrfs-progs. Please refer to the documentation at
https://btrfs.readthedocs.io or wiki http://btrfs.wiki.kernel.org for further
information.
SEE ALSO
--------
:doc:`btrfs-qgroup(8)<btrfs-qgroup>`,
:doc:`btrfs-quota(8)<btrfs-quota>`,
:doc:`btrfs-send(8)<btrfs-send>`,
:doc:`mkfs.btrfs(8)<mkfs.btrfs>`,
``mount(8)``
|
