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

NAME

6       btrfstune - tune various filesystem parameters
7

SYNOPSIS

9       btrfstune [options] <device> [<device>...]
10

DESCRIPTION

12       btrfstune can be used to enable, disable, or set various filesystem
13       parameters. The filesystem must be unmounted.
14
15       The common usecase is to enable features that were not enabled at mkfs
16       time. Please make sure that you have kernel support for the features.
17       You can find a complete list of features and kernel version of their
18       introduction at
19       https://btrfs.wiki.kernel.org/index.php/Changelog#By_feature . Also,
20       the manual page mkfs.btrfs(8) contains more details about the features.
21
22       Some of the features could be also enabled on a mounted filesystem by
23       other means. Please refer to the FILESYSTEM FEATURES in btrfs(5).
24

OPTIONS

26       -f
27           Allow dangerous changes, e.g. clear the seeding flag or change
28           fsid. Make sure that you are aware of the dangers.
29
30       -m
31           (since kernel: 5.0)
32
33           change fsid stored as metadata_uuid to a randomly generated UUID,
34           see also -U
35
36       -M <UUID>
37           (since kernel: 5.0)
38
39           change fsid stored as metadata_uuid to a given UUID, see also -U
40
41           The metadata_uuid is stored only in the superblock and is a
42           backward incompatible change. The fsid in metadata blocks remains
43           unchanged and is not overwritten, thus the whole operation is
44           significantly faster than -U.
45
46           The new metadata_uuid can be used for mount by UUID and is also
47           used to identify devices of a multi-device filesystem.
48
49       -n
50           (since kernel: 3.14)
51
52           Enable no-holes feature (more efficient representation of file
53           holes), enabled by mkfs feature no-holes.
54
55       -r
56           (since kernel: 3.7)
57
58           Enable extended inode refs (hardlink limit per file in a directory
59           is 65536), enabled by mkfs feature extref.
60
61       -S <0|1>
62           Enable seeding on a given device. Value 1 will enable seeding, 0
63           will disable it.
64
65           A seeding filesystem is forced to be mounted read-only. A new
66           device can be added to the filesystem and will capture all writes
67           keeping the seeding device intact.
68
69               Warning
70               Clearing the seeding flag on a device may be dangerous. If a
71               previously-seeding device is changed, all filesystems that used
72               that device will become unmountable. Setting the seeding flag
73               back will not fix that.
74
75               A valid usecase is seeding device as a base image. Clear the
76               seeding flag, update the filesystem and make it seeding again,
77               provided that it’s OK to throw away all filesystems built on
78               top of the previous base.
79
80       -u
81           Change fsid to a randomly generated UUID or continue previous fsid
82           change operation in case it was interrupted.
83
84       -U <UUID>
85           Change fsid to UUID in all metadata blocks.
86
87           The UUID should be a 36 bytes string in printf(3) format
88           "%08x-%04x-%04x-%04x-%012x". If there is a previous unfinished fsid
89           change, it will continue only if the UUID matches the unfinished
90           one or if you use the option -u.
91
92           All metadata blocks are rewritten, this may take some time, but the
93           final filesystem compatibility is unaffected, unlike -M.
94
95               Warning
96               Cancelling or interrupting a UUID change operation will make
97               the filesystem temporarily unmountable. To fix it, rerun
98               btrfstune -u and let it complete.
99
100       -x
101           (since kernel: 3.10)
102
103           Enable skinny metadata extent refs (more efficient representation
104           of extents), enabled by mkfs feature skinny-metadata.
105
106           All newly created extents will use the new representation. To
107           completely switch the entire filesystem, run a full balance of the
108           metadata. Please refer to btrfs-balance(8).
109

EXIT STATUS

111       btrfstune returns 0 if no error happened, 1 otherwise.
112

COMPATIBILITY NOTE

114       This deprecated tool exists for historical reasons but is still in use
115       today. Its functionality will be merged to the main tool, at which time
116       btrfstune will be declared obsolete and scheduled for removal.
117

SEE ALSO

119       btrfs(5), btrfs-balance(8), mkfs.btrfs(8)
120
121
122
123Btrfs v5.4                        12/03/2019                      BTRFSTUNE(8)
Impressum