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 -n::
  28 Enable no-holes feature. More efficient representation of file holes.
  29 -f::
  30 Allow dangerous changes, e.g. clear the seeding flag or change fsid. Make sure
  31 that you are aware of the dangers.
  32 -u::
  33 Change fsid to a random generated UUID or continue previous change operation in
  34 case it was interrupted with the original UUID.
  35 -U <UUID>::
  36 Change fsid to <UUID>.
  37 +
  38 The <UUID> should be a 36 bytes string in `printf`(3) format
  39 "%08x-%04x-%04x-%04x-%012x".
  40 If there is a previous unfinished fsid change, it will only continue if the
  41 <UUID> matches the unfinished one.
  42
  43 WARNING: Cancelling or interrupting a UUID change operation will make the
  44 filesystem temporarily unmountable.  To fix it, rerun 'btrfstune -u' to restore
  45 the UUID and wait it complete.
  46
  47 When mounting the new device, btrfs will check whether the seeding flag is set
  48 when try to open seeding device.  If the user clears the seeding flag of the
  49 seeding device, the new device will not be mountable. Even setting the seeding
  50 flag back will not fix this problem, because the generation will be changed at
  51 that time. Clear the seeding flag may damage the new filesystem.
  52
  53 EXIT STATUS
  54 -----------
  55 *btrfstune* will return 0 if no error happened.
  56 If any problems happened, 1 will be returned.
  57
  58 SEE ALSO
  59 --------
  60 `mkfs.btrfs`(8)