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