btrfs-progs: Documentaion: rename to .asciidoc
[platform/upstream/btrfs-progs.git] / Documentation / btrfstune.asciidoc
1 btrfstune(8)
2 ============
3
4 NAME
5 ----
6 btrfstune - tune various btrfs filesystem parameters
7
8 SYNOPSIS
9 --------
10 *btrfstune* [options] <dev> [<dev>...]
11
12 DESCRIPTION
13 -----------
14 *btrfstune* is used to tune various btrfs filesystem parameters,you can
15 enable/disable some extended features for btrfs.
16
17 OPTIONS
18 -------
19 -S <value>::
20 Updates the seeding value.
21 A positive value will enable seeding, zero will disable seeding, negtive is not allowed.
22 Enable seeding forces a fs readonly so that you can use it to build other filesystems.
23 -r::
24 Enable extended inode refs.
25 -x::
26 Enable skinny metadata extent refs.
27 -f::
28 Allow dangerous changes, e.g. clear the seeding flag. Make sure that you are
29 aware of the dangers.
30
31 When mounting the new device, btrfs will check whether the seeding flag is set
32 when try to open seeding device.  If the user clears the seeding flag of the
33 seeding device, the new device will not be mountable. Even setting the seeding
34 flag back will not fix this problem, because the generation will be changed at
35 that time. Clear the seeding flag may damage the new filesystem.
36
37 EXIT STATUS
38 -----------
39 *btrfstune* will return 0 if no error happened.
40 If any problems happened, 1 will be returned.
41
42 SEE ALSO
43 --------
44 `mkfs.btrfs`(8)