xref: /openbsd-src/usr.bin/quota/quota.1 (revision d607b6a56e77796de63b1e0bd5d989c1565d3a26)
1.\"	$OpenBSD: quota.1,v 1.17 2020/02/21 21:45:20 jmc Exp $
2.\"
3.\" Copyright (c) 1983, 1990, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" Robert Elz at The University of Melbourne.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. Neither the name of the University nor the names of its contributors
18.\"    may be used to endorse or promote products derived from this software
19.\"    without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.\"	from: @(#)quota.1	8.1 (Berkeley) 6/6/93
34.\"
35.Dd $Mdocdate: February 21 2020 $
36.Dt QUOTA 1
37.Os
38.Sh NAME
39.Nm quota
40.Nd display disk usage and limits
41.Sh SYNOPSIS
42.Nm quota
43.Op Fl q | v
44.Op Fl gu
45.Nm quota
46.Op Fl q | v
47.Fl g
48.Ar group ...
49.Nm quota
50.Op Fl q | v
51.Fl u
52.Ar user ...
53.Sh DESCRIPTION
54.Nm quota
55displays users' disk usage and limits.
56By default only the user quotas are printed.
57.Pp
58The options are as follows:
59.Bl -tag -width Ds
60.It Fl g
61Print group quotas for the group
62of which the user is a member.
63.It Fl q
64Print a more terse message,
65containing only information
66on filesystems where usage is over quota.
67This flag takes precedence over the
68.Fl v
69flag.
70.It Fl u
71Print user quotas for the user.
72This flag is equivalent to the default.
73.It Fl v
74.Nm quota
75will display quotas on filesystems
76where no storage is allocated.
77.El
78.Pp
79Only the superuser may use the
80.Fl g
81and
82.Fl u
83flags
84to view the limits of other groups and users.
85Non-superusers can use the
86.Fl g
87and
88.Fl u
89flags to view the limits of groups of which they are members as well as
90their own user limits.
91.Pp
92.Nm quota
93tries to report the quotas of all mounted filesystems.
94If the filesystem is mounted via NFS,
95it will attempt to contact the
96.Xr rpc.rquotad 8
97daemon on the
98NFS server.
99For FFS
100filesystems, quotas must be turned on in
101.Pa /etc/fstab .
102.Sh FILES
103.Bl -tag -width quota.group -compact
104.It Pa quota.user
105located at the filesystem root with user quotas
106.It Pa quota.group
107located at the filesystem root with group quotas
108.It Pa /etc/fstab
109to find filesystem names and locations
110.El
111.Sh EXIT STATUS
112The
113.Nm quota
114utility exits 0 on success,
115and with a non-zero value if one or more
116filesystems are over quota.
117.Sh SEE ALSO
118.Xr quotactl 2 ,
119.Xr fstab 5 ,
120.Xr edquota 8 ,
121.Xr quotacheck 8 ,
122.Xr quotaon 8 ,
123.Xr repquota 8 ,
124.Xr rpc.rquotad 8
125.Sh HISTORY
126The
127.Nm quota
128command appeared in
129.Bx 4.2 .
130