Documentation/btrfs-qgroup.txt

   1 btrfs-qgroup(8)
   2 ===============
   3
   4 NAME
   5 ----
   6 btrfs-qgroup - control the quota group of a btrfs filesystem
   7
   8 SYNOPSIS
   9 --------
  10 *btrfs qgroup* <subcommand> <args>
  11
  12 DESCRIPTION
  13 -----------
  14 *btrfs qgroup* is used to control quota group(qgroup) of a btrfs filesystem.
  15
  16 NOTE: To use qgroup, it needs to enable quota first using *btrfs quota*
  17 command.
  18
  19 WARNING: Qgroup is not stable yet and will impact performance in current mainline
  20 kernel(v3.14 so far).
  21
  22 QGROUP
  23 ------
  24 Quota group or qgroup in btrfs has its hierarchy like subvolume.
  25 One subvolume/snapshot can reach its quota limits if it consumes all the quota
  26 assigned to it or any of the parent qgroup(s).
  27
  28 Also for snapshot, it consumes no quota initially since all its data
  29 shares with its parent, so only modification in snapshot consumes quota.
  30
  31 Every subvolume/snapshot will have its own qgroup with id '0/<subvolume id>'
  32 upon creating, but can be later destroyed by *btrfs qgroup destroy* command.
  33
  34 NOTE: If the qgroup of a subvolume is destroyed, quota about the subvolume
  35 will not be functional until qgroup '0/<subvolume id>' is created again.
  36
  37 SUBCOMMAND
  38 ----------
  39 *assign* <src> <dst> <path>::
  40 Assign qgroup <src> as the child qgroup of <dst> in the btrfs filesystem
  41 identified by <path>.
  42
  43 *remove* <src> <dst> <path>::
  44 Remove the relationship between child qgroup <src> and parent qgroup <dst> in
  45 the btrfs filesystem identified by <path>.
  46
  47 *create* <qgroupid> <path>::
  48 Create a subvolume quota group.
  49 +
  50 For the '0/<subvolume id>' qgroup, a qgroup can be created even before the
  51 subvolume created.
  52
  53 *destroy* <qgroupid> <path>::
  54 Destroy a qgroup.
  55 +
  56 If a qgroup is no isolated,which means it is a parent or child qgroup, it
  57 can't be destroyed.
  58
  59 *show* [options] <path>::
  60 Show all qgroups in the btrfs filesystem identified by <path>.
  61 +
  62 `Options`
  63 +
  64 -p::::
  65 print parent qgroup id.
  66 -c::::
  67 print child qgroup id.
  68 -r::::
  69 print max referenced size of qgroup.
  70 -e::::
  71 print max exclusive size of qgroup.
  72 -F::::
  73 list all qgroups which impact the given path(include ancestral qgroups)
  74 -f::::
  75 list all qgroups which impact the given path(exclude ancestral qgroups)
  76 --sort=[\+/-]<attr>[,[+/-]<attr>]...::::
  77 list qgroups in order of <attr>.
  78 +
  79 <attr> can be one or more of qgroupid,rfer,excl,max_rfer,max_excl.
  80 +
  81 Prefix \'+' means ascending order and \'-' means descending order of <attr>.
  82 If no prefix is given, use ascending order by default.
  83 +
  84 If multiple <attr>s is given, use comma to separate.
  85
  86 *limit* [options] <size>|none [<qgroupid>] <path>::
  87 Limit the size of a qgroup to <size> or no limit in the btrfs filesystem
  88 identified by <path>.
  89 +
  90 If <qgroupid> is not given, qgroup of the subvolume identified by <path>
  91 is used if possible.
  92
  93 EXIT STATUS
  94 -----------
  95 *btrfs qgroup* returns a zero exist status if it succeeds. Non zero is
  96 returned in case of failure.
  97
  98 AVAILABILITY
  99 ------------
 100 *btrfs* is part of btrfs-progs.
 101 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
 102 further details.
 103
 104 SEE ALSO
 105 --------
 106 `mkfs.btrfs`(8),
 107 `btrfs-subvolume`(8),
 108 `btrfs-quota`(8),