xref: /dragonfly/sbin/vquota/vquota.8 (revision 5868d2b9)
1.\" Copyright (c) 2011,2012 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 March 28, 2012
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.Oo
38.Fl D | h
39.Oc
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
48To use the
49.Nm
50utility, the
51.Va vfs.quota_enabled
52tunable needs to be set in
53.Xr loader.conf 5 .
54.Pp
55The following options are available:
56.Bl -tag -width Ds
57.It Fl D
58Debug flag, show raw messages sent to and received from kernel
59.It Fl h
60"Human-readable" output. Use unit suffixes: Byte, Kilobyte, Megabyte,
61Gigabyte, Terabyte and Petabyte in order to reduce the number of
62digits to four or fewer.
63.It Fl n
64Show raw user and group ids. Normally
65.Nm
66attempts to resolve and display full user and group names.
67.El
68.Pp
69The commands are as follows:
70.Bl -tag -width indent
71.\" ==== check ====
72.It Cm check Ar directory
73Reports the space (in bytes) occupied by files names located in the
74directory hierarchy present under
75.Ar directory .
76.
77.\" ==== lsfs ====
78.It Cm lsfs
79List mounted file systems having space accounting enabled
80.
81.\" ==== show ====
82.It Cm show Ar mount_point
83Show file size usage and quota limits for the file system mounted under
84.Ar mount_point .
85The information is broken down by uid and gid
86.
87.\" ==== sync ====
88.It Cm sync Ar mount_point
89Initialize in one go the usage counters for the filesystem
90mounted under
91.Ar mount_point
92with real usage data. This command scans an entire filesystem
93directory hierarchy and may be slow to run
94.\" ==== limit ====
95.It Cm limit Ar mount_point size
96Set a global quota of
97.Ar size
98bytes for the filesystem mounted under
99.Ar mount_point .
100.\" ==== ulim ====
101.It Cm ulim Ar mount_point user size
102Set a quota of
103.Ar size
104bytes for the filesystem mounted under
105.Ar mount_point
106and the specified
107.Ar user .
108.\" ==== glim ====
109.It Cm glim Ar mount_point group size
110Set a quota of
111.Ar size
112bytes for the filesystem mounted under
113.Ar mount_point
114and the specified
115.Ar group .
116.El
117.Pp
118A limit of 0 effectively means checks are disabled.
119.
120.Sh EXAMPLES
121The following is an example of a typical usage
122of the
123.Nm
124command:
125.Pp
126.Dl "vquota show /mnt/data"
127.
128.Sh SEE ALSO
129.Xr vquotactl 2 ,
130.Xr loader.conf 5
131.Sh HISTORY
132The
133.Nm
134utility first appeared in
135.Dx 2.13 .
136.Sh AUTHORS
137.An Francois Tigeot Aq ftigeot@wolfpond.org
138