Documentation/btrfs-convert.asciidoc

   1 btrfs-convert(8)
   2 ================
   3
   4 NAME
   5 ----
   6 btrfs-convert - convert from ext2/3/4 filesystem to btrfs or rollback
   7
   8 SYNOPSIS
   9 --------
  10 *btrfs-convert* [options] <device>
  11
  12 DESCRIPTION
  13 -----------
  14 *btrfs-convert* is used to convert existed ext2/3/4 to btrfs filesystem,
  15 and the original filesystem image is accessible as from separate subvolume
  16 named 'ext2_saved' as file image.
  17
  18 WARNING: If one hopes to rollback to ext2/3/4, they should not execute
  19 *btrfs balance* command on converted btrfs, since it will change the extent
  20 layout and make *btrfs-convert* unable to rollback.
  21
  22 NOTE: If one is satisfied with converted btrfs, and not longer wants to
  23 rollback to ext2/3/4, it is highly recommended to remove 'ext2_saved' subvolume
  24 and execute *btrfs filesystem defragment* and *btrfs balance* command on the
  25 converted btrfs.
  26
  27 OPTIONS
  28 -------
  29 -d|--no-datasum::
  30 Disable data checksum calculations and set NODATASUM file flag. This can speed
  31 up the conversion.
  32 -i|--no-xattr::
  33 Ignore xattrs and ACLs.
  34 -n|--no-inline::
  35 Disable inlining of small files to metadata blocks.
  36 -N|--nodesize <SIZE>::
  37 Set filesystem nodesize, the tree block size in which btrfs stores data.
  38 The default value is 16KB (16384) or the page size, whichever is bigger.
  39 Must be a multiple of the sectorsize, but not larger than 65536.
  40 -r|--rollback::
  41 Roll back to ext2fs.
  42 -l|--label <LABEL>::
  43 set filesystem label during conversion.
  44 -L|--copy-label::
  45 use label from the converted filesystem.
  46 -p|--progress::
  47 Show progress of conversion, on by default.
  48 --no-progress::
  49 Disable detailed progress and show only the main phases of conversion.
  50
  51 EXIT STATUS
  52 -----------
  53 *btrfs-convert* will return 0 if no error happened.
  54 If any problems happened, 1 will be returned.
  55
  56 SEE ALSO
  57 --------
  58 `mkfs.btrfs`(8)
  59