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