summaryrefslogtreecommitdiff
path: root/Documentation/btrfstune.asciidoc
blob: 59f1500d719549066d2492ddaaf42cd369e74014 (plain)
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
btrfstune(8)
============

NAME
----
btrfstune - tune various btrfs filesystem parameters

SYNOPSIS
--------
*btrfstune* [options] <dev> [<dev>...]

DESCRIPTION
-----------
*btrfstune* is used to tune various btrfs filesystem parameters,you can
enable/disable some extended features for btrfs.

OPTIONS
-------
-S <value>::
Updates the seeding value.
A positive value will enable seeding, zero will disable seeding, negtive is not allowed.
Enable seeding forces a fs readonly so that you can use it to build other filesystems.
-r::
Enable extended inode refs.
-x::
Enable skinny metadata extent refs.
-n::
Enable no-holes feature. More efficient representation of file holes.
-f::
Allow dangerous changes, e.g. clear the seeding flag or change fsid. Make sure
that you are aware of the dangers.
-u::
Change fsid to a random generated UUID or continue previous change operation in
case it was interrupted with the original UUID.
-U <UUID>::
Change fsid to <UUID>.
+
The <UUID> should be a 36 bytes string in `printf`(3) format
"%08x-%04x-%04x-%04x-%012x".
If there is a previous unfinished fsid change, it will only continue if the
<UUID> matches the unfinished one.

WARNING: Cancelling or interrupting a UUID change operation will make the
filesystem temporarily unmountable.  To fix it, rerun 'btrfstune -u' to restore
the UUID and wait it complete.

When mounting the new device, btrfs will check whether the seeding flag is set
when try to open seeding device.  If the user clears the seeding flag of the
seeding device, the new device will not be mountable. Even setting the seeding
flag back will not fix this problem, because the generation will be changed at
that time. Clear the seeding flag may damage the new filesystem.

EXIT STATUS
-----------
*btrfstune* will return 0 if no error happened.
If any problems happened, 1 will be returned.

SEE ALSO
--------
`mkfs.btrfs`(8)