VFS quota: add a command to set a group quota
[dragonfly.git] / sbin / vquota / vquota.8
CommitLineData
c115b876 1.\" Copyright (c) 2011,2012 Fran├žois Tigeot
b3ee253f
FT
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.\"
dff33cb0 25.
b3ee253f
FT
26.\" Note: The date here should be updated whenever a non-trivial
27.\" change is made to the manual page.
c115b876 28.Dd March 23, 2012
b3ee253f
FT
29.Dt VQUOTA 8
30.Os
31.Sh NAME
32.Nm vquota
33.Nd VFS quota system utility
dff33cb0 34.
b3ee253f
FT
35.Sh SYNOPSIS
36.Nm
c4d75bef
FT
37.Oo
38.Fl D | h
39.Oc
b3ee253f
FT
40.Ar command
41.Ar argument
42.Sh DESCRIPTION
43This manual page documents the
44.Nm
45utility which provides functions for managing virtual file system
46accounting and quotas.
47.Pp
c4d75bef
FT
48The following options are available:
49.Bl -tag -width Ds
50.It Fl D
51Debug flag, show raw messages sent to and received from kernel
52.It Fl h
53"Human-readable" output. Use unit suffixes: Byte, Kilobyte, Megabyte,
54Gigabyte, Terabyte and Petabyte in order to reduce the number of
55digits to four or fewer.
bc844d36
FT
56.It Fl n
57Show raw user and group ids. Normally
58.Nm
59attempts to resolve and display full user and group names.
c4d75bef
FT
60.El
61.Pp
b3ee253f
FT
62The commands are as follows:
63.Bl -tag -width indent
64.\" ==== check ====
65.It Cm check Ar directory
44700357 66Reports the space (in bytes) occupied by files names located in the
b3ee253f 67directory hierarchy present under
44700357 68.Ar directory .
a3dce641
FT
69.
70.\" ==== lsfs ====
71.It Cm lsfs
72List mounted file systems having space accounting enabled
b4d6d8bb
FT
73.
74.\" ==== show ====
75.It Cm show Ar mount_point
c115b876 76Show file size usage and quota limits for the file system mounted under
b4d6d8bb
FT
77.Ar mount_point .
78The information is broken down by uid and gid
88c2e66c
FT
79.
80.\" ==== sync ====
81.It Cm sync Ar mount_point
82Initialize in one go the usage counters for the filesystem
83mounted under
84.Ar mount_point
85with real usage data. This command scans an entire filesystem
86directory hierarchy and may be slow to run
c115b876
FT
87.\" ==== limit ====
88.It Cm limit Ar mount_point size
89Set a global quota of
90.Ar size
91bytes for the filesystem mounted under
92.Ar mount_point .
c6e8a1bd
FT
93.\" ==== ulim ====
94.It Cm ulim Ar mount_point user size
95Set a quota of
96.Ar size
97bytes for the filesystem mounted under
98.Ar mount_point
99and the specified
100.Ar user .
3663c79b
FT
101.\" ==== glim ====
102.It Cm glim Ar mount_point group size
103Set a quota of
104.Ar size
105bytes for the filesystem mounted under
106.Ar mount_point
107and the specified
108.Ar group .
dff33cb0
SW
109.El
110.
b4d6d8bb
FT
111.Sh EXAMPLES
112The following is an example of a typical usage
113of the
114.Nm
115command:
116.Pp
117.Dl "vquota show /mnt/data"
118.
b3ee253f
FT
119.Sh HISTORY
120The
121.Nm
122utility first appeared in
123.Dx 2.13 .
124.Sh AUTHORS
125.An Francois Tigeot Aq ftigeot@wolfpond.org