Documentation/btrfs.asciidoc

   1 btrfs(8)
   2 ========
   3
   4 NAME
   5 ----
   6 btrfs - control a btrfs filesystem
   7
   8 SYNOPSIS
   9 --------
  10 *btrfs* <command> [<args>]
  11
  12 DESCRIPTION
  13 -----------
  14 The *btrfs* utility is a toolbox for managing btrfs filesystems.  There are
  15 command groups to work with subvolumes, devices, for whole filesystem or other
  16 specific actions. See section *COMMANDS*.
  17
  18 COMMAND SYTNAX
  19 --------------
  20
  21 Any command name can be shortened as far as it stays unambiguous,
  22 however it is recommended to use full command names in scripts.
  23 All command groups have their manual page named *btrfs-<group>*.
  24
  25 For example: it is possible to run *btrfs sub snaps* instead of
  26 *btrfs subvolume snapshot*.
  27 But *btrfs file s* is not allowed, because *file s* may be interpreted
  28 both as *filesystem show* and as *filesystem sync*.
  29
  30 If the command name is ambiguous, the list of conflicting options is
  31 printed.
  32
  33 For an overview of a given command use 'btrfs command --help'
  34 or 'btrfs [command...] --help --full' to print all available options.
  35
  36 COMMANDS
  37 --------
  38 *balance*::
  39         Balance btrfs filesystem chunks across single or several devices. +
  40         See `btrfs-balance`(8) for details.
  41
  42 *check*::
  43         Do off-line check on a btrfs filesystem. +
  44         See `btrfs-check`(8) for details.
  45
  46 *device*::
  47         Manage devices managed by btrfs, including add/delete/scan and so
  48         on. +
  49         See `btrfs-device`(8) for details.
  50
  51 *filesystem*::
  52         Manage a btrfs filesystem, including label setting/sync and so on. +
  53         See `btrfs-filesystem`(8) for details.
  54
  55 *inspect-internal*::
  56         Debug tools for developers/hackers. +
  57         See `btrfs-inspect-internal`(8) for details.
  58
  59 *property*::
  60         Get/set a property from/to a btrfs object. +
  61         See `btrfs-property`(8) for details.
  62
  63 *qgroup*::
  64         Manage quota group(qgroup) for btrfs filesystem. +
  65         See `btrfs-qgroup`(8) for details.
  66
  67 *quota*::
  68         Manage quota on btrfs filesystem like enabling/rescan and etc. +
  69         See `btrfs-quota`(8) and `btrfs-qgroup`(8) for details.
  70
  71 *receive*::
  72         Receive subvolume data from stdin/file for restore and etc. +
  73         See `btrfs-receive`(8) for details.
  74
  75 *replace*::
  76         Replace btrfs devices. +
  77         See `btrfs-replace`(8) for details.
  78
  79 *rescue*::
  80         Try to rescue damaged btrfs filesystem. +
  81         See `btrfs-rescue`(8) for details.
  82
  83 *restore*::
  84         Try to restore files from a damaged btrfs filesystem. +
  85         See `btrfs-restore`(8) for details.
  86
  87 *scrub*::
  88         Scrub a btrfs filesystem. +
  89         See `btrfs-scrub`(8) for details.
  90
  91 *send*::
  92         Send subvolume data to stdout/file for backup and etc. +
  93         See `btrfs-send`(8) for details.
  94
  95 *subvolume*::
  96         Create/delete/list/manage btrfs subvolume. +
  97         See `btrfs-subvolume`(8) for details.
  98
  99 EXIT STATUS
 100 -----------
 101 *btrfs* returns a zero exit status if it succeeds. Non zero is returned in
 102 case of failure.
 103
 104 AVAILABILITY
 105 ------------
 106 *btrfs* is part of btrfs-progs.
 107 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
 108 further details.
 109
 110 SEE ALSO
 111 --------
 112 `mkfs.btrfs`(8), `ionice`(1),
 113 `btrfs-balance`(8),
 114 `btrfs-check`(8),
 115 `btrfs-device`(8),
 116 `btrfs-filesystem`(8),
 117 `btrfs-inspect-internal`(8),
 118 `btrfs-property`(8),
 119 `btrfs-qgroup`(8),
 120 `btrfs-quota`(8),
 121 `btrfs-receive`(8),
 122 `btrfs-replace`(8),
 123 `btrfs-rescue`(8),
 124 `btrfs-restore`(8),
 125 `btrfs-scrub`(8),
 126 `btrfs-send`(8),
 127 `btrfs-subvolume`(8),