xref: /freebsd/usr.bin/quota/quota.1 (revision f856af0466c076beef4ea9b15d088e1119a945b8)
1.\" Copyright (c) 1983, 1990, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Robert Elz at The University of Melbourne.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"	from: @(#)quota.1	8.1 (Berkeley) 6/6/93
36.\" $FreeBSD$
37.\"
38.Dd October 22, 2006
39.Dt QUOTA 1
40.Os
41.Sh NAME
42.Nm quota
43.Nd display disk usage and limits
44.Sh SYNOPSIS
45.Nm
46.Op Fl ghlu
47.Op Fl v | Fl q
48.Nm
49.Op Fl hlu
50.Op Fl v | Fl q
51.Ar user ...
52.Nm
53.Fl g
54.Op Fl hl
55.Op Fl v | Fl q
56.Ar group ...
57.Sh DESCRIPTION
58The
59.Nm
60utility displays users' disk usage and limits.
61By default only the user quotas are printed.
62Disk block usage and limits are shown in 1024-byte blocks.
63.Pp
64The following options are available:
65.Bl -tag -width indent
66.It Fl g
67Print group quotas for the group
68of which the user is a member.
69.It Fl h
70"Human-readable" output.
71Use unit suffixes: Byte, Kilobyte, Megabyte, Gigabyte, Terabyte and Petabyte.
72.It Fl l
73Do not report quotas on
74.Tn NFS
75file systems.
76.It Fl q
77Print a more terse message,
78containing only information
79on file systems where usage is over quota.
80.It Fl u
81Print the user quotas.
82This is the default unless
83.Fl g
84is specified.
85.It Fl v
86Display quotas on file systems
87where no storage is allocated.
88.El
89.Pp
90Specifying both
91.Fl g
92and
93.Fl u
94displays both the user quotas and the group quotas (for
95the user).
96.Pp
97Only the super-user may use the
98.Fl u
99flag and the optional
100.Ar user
101argument to view the limits of other users.
102Non-super-users can use the
103.Fl g
104flag and optional
105.Ar group
106argument to view only the limits of groups of which they are members.
107.Pp
108The
109.Fl q
110flag takes precedence over the
111.Fl v
112flag.
113.Pp
114The
115.Nm
116utility tries to report the quotas of all mounted file systems.
117If the file system is mounted via
118.Tn NFS ,
119it will attempt to contact the
120.Xr rpc.rquotad 8
121daemon on the
122.Tn NFS
123server.
124For
125.Tn UFS
126file systems, quotas must be turned on in
127.Pa /etc/fstab .
128If
129.Nm
130exits with a non-zero status, one or more file systems
131are over quota.
132.Pp
133If the
134.Fl l
135flag is specified,
136.Nm
137will not check
138.Tn NFS
139file systems.
140.Sh FILES
141.Bl -tag -width quota.group -compact
142.It Pa quota.user
143located at the file system root with user quotas
144.It Pa quota.group
145located at the file system root with group quotas
146.It Pa /etc/fstab
147to find file system names and locations
148.El
149.Sh SEE ALSO
150.Xr quotactl 2 ,
151.Xr fstab 5 ,
152.Xr edquota 8 ,
153.Xr quotacheck 8 ,
154.Xr quotaon 8 ,
155.Xr repquota 8 ,
156.Xr rpc.rquotad 8
157.Sh HISTORY
158The
159.Nm
160command appeared in
161.Bx 4.2 .
162