btrfs-progs: Convert man page for btrfs-quota.
[platform/upstream/btrfs-progs.git] / Documentation / btrfs-quota.txt
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 'enable' <path>::
26 Enable subvolume quota support for a filesystem.
27
28
29 'disable' <path>::
30 Disable subvolume quota support for a filesystem.
31
32 'rescan' [-s] <path>::
33 Trash all qgroup numbers and scan the metadata again with the current config.
34 +
35 `Options`
36 +
37 -s::::
38 show status of a running rescan operation.
39 -w::::
40 wait for rescan operation to finish(can be already in progress).
41
42 EXIT STATUS
43 -----------
44 'btrfs quota' returns a zero exist status if it succeeds. Non zero is
45 returned in case of failure.
46
47 AVAILABILITY
48 ------------
49 'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
50 development,
51 and not suitable for any uses other than benchmarking and review.
52 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
53 further details.
54
55 SEE ALSO
56 --------
57 `mkfs.btrfs`(8),
58 `btrfs-subvolume`(8),
59 `btrfs-qgroup`(8)