69e0d1e2835281b26a27651471cb7207bc6f6784
[dragonfly.git] / sbin / vquota / vquota.8
1 .\" Copyright (c) 2011 Fran├žois Tigeot
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .
26 .\" Note: The date here should be updated whenever a non-trivial
27 .\" change is made to the manual page.
28 .Dd December 2, 2011
29 .Dt VQUOTA 8
30 .Os
31 .Sh NAME
32 .Nm vquota
33 .Nd VFS quota system utility
34 .
35 .Sh SYNOPSIS
36 .Nm
37 .Ar command
38 .Ar argument
39 .Sh DESCRIPTION
40 This manual page documents the
41 .Nm
42 utility which provides functions for managing virtual file system
43 accounting and quotas.
44 .Pp
45 The commands are as follows:
46 .Bl -tag -width indent
47 .\" ==== check ====
48 .It Cm check Ar directory
49 Reports the space (in bytes) occupied by files names located in the
50 directory hierarchy present under
51 .Ar directory .
52 .
53 .\" ==== lsfs ====
54 .It Cm lsfs
55 List mounted file systems having space accounting enabled
56 .
57 .\" ==== show ====
58 .It Cm show Ar mount_point
59 Show file size usage for the file system mounted under
60 .Ar mount_point .
61 The information is broken down by uid and gid
62 .El
63 .
64 .Sh EXAMPLES
65 The following is an example of a typical usage
66 of the
67 .Nm
68 command:
69 .Pp
70 .Dl "vquota show /mnt/data"
71 .
72 .Sh HISTORY
73 The
74 .Nm
75 utility first appeared in
76 .Dx 2.13 .
77 .Sh AUTHORS
78 .An Francois Tigeot Aq ftigeot@wolfpond.org