btrfs-progs: docs: update btrfs manual page
[platform/upstream/btrfs-progs.git] / Documentation / btrfs-quota.asciidoc
1 btrfs-quota(8)
2 ==============
3
4 NAME
5 ----
6 btrfs-quota - control the quota of a btrfs filesystem
7
8 SYNOPSIS
9 --------
10 *btrfs quota* <subcommand> <args>
11
12 DESCRIPTION
13 -----------
14 *btrfs quota* is used to enable/disable or rescan subvolume quota of a btrfs
15 filesystem.
16
17 For setting quota or other quota operations on a btrfs filesystem, please see
18 `btrfs-qgroup`(8) for details.
19
20 WARNING: Quota and qgroup in btrfs filesystem is not stable and impacts
21 performance in mainline kernel yet(v3.14 so far).
22
23 SUBCOMMAND
24 ----------
25 *disable* <path>::
26 Disable subvolume quota support for a filesystem.
27
28 *enable* <path>::
29 Enable subvolume quota support for a filesystem.
30
31 *rescan* [-s] <path>::
32 Trash all qgroup numbers and scan the metadata again with the current config.
33 +
34 `Options`
35 +
36 -s::::
37 show status of a running rescan operation.
38 -w::::
39 wait for rescan operation to finish(can be already in progress).
40
41 EXIT STATUS
42 -----------
43 *btrfs quota* returns a zero exit status if it succeeds. Non zero is
44 returned in case of failure.
45
46 AVAILABILITY
47 ------------
48 *btrfs* is part of btrfs-progs.
49 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
50 further details.
51
52 SEE ALSO
53 --------
54 `mkfs.btrfs`(8),
55 `btrfs-subvolume`(8),
56 `btrfs-qgroup`(8)