Annotation of src/usr.bin/quota/quota.1, Revision 1.17
1.17 ! jmc 1: .\" $OpenBSD: quota.1,v 1.16 2011/01/20 13:58:16 jmc Exp $
1.10 aaron 2: .\"
1.1 deraadt 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.
1.12 millert 17: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 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: .\"
1.17 ! jmc 35: .Dd $Mdocdate: January 20 2011 $
1.1 deraadt 36: .Dt QUOTA 1
1.7 aaron 37: .Os
1.1 deraadt 38: .Sh NAME
39: .Nm quota
40: .Nd display disk usage and limits
41: .Sh SYNOPSIS
42: .Nm quota
1.13 jmc 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 ...
1.1 deraadt 53: .Sh DESCRIPTION
1.5 aaron 54: .Nm quota
1.1 deraadt 55: displays users' disk usage and limits.
56: By default only the user quotas are printed.
57: .Pp
1.8 aaron 58: The options are as follows:
1.1 deraadt 59: .Bl -tag -width Ds
60: .It Fl g
1.7 aaron 61: Print group quotas for the group
1.1 deraadt 62: of which the user is a member.
1.13 jmc 63: .It Fl q
64: Print a more terse message,
65: containing only information
66: on filesystems where usage is over quota.
1.17 ! jmc 67: This flag takes precedence over the
! 68: .Fl v
! 69: flag.
1.13 jmc 70: .It Fl u
71: Print user quotas for the user.
72: This flag is equivalent to the default.
1.1 deraadt 73: .It Fl v
74: .Nm quota
75: will display quotas on filesystems
76: where no storage is allocated.
77: .El
78: .Pp
1.17 ! jmc 79: Only the superuser may use the
1.1 deraadt 80: .Fl g
81: and
82: .Fl u
1.17 ! jmc 83: flags
! 84: to view the limits of other groups and users.
1.11 aaron 85: Non-superusers can use the
1.1 deraadt 86: .Fl g
1.17 ! jmc 87: and
! 88: .Fl u
! 89: flags to view the limits of groups of which they are members as well as
! 90: their own user limits.
1.1 deraadt 91: .Pp
1.5 aaron 92: .Nm quota
1.1 deraadt 93: tries to report the quotas of all mounted filesystems.
1.5 aaron 94: If the filesystem is mounted via NFS,
1.1 deraadt 95: it will attempt to contact the
96: .Xr rpc.rquotad 8
97: daemon on the
1.5 aaron 98: NFS server.
99: For FFS
1.1 deraadt 100: filesystems, 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
105: located at the filesystem root with user quotas
106: .It Pa quota.group
107: located at the filesystem root with group quotas
108: .It Pa /etc/fstab
109: to find filesystem names and locations
110: .El
1.15 jmc 111: .Sh EXIT STATUS
112: The
113: .Nm quota
114: utility exits 0 on success,
1.16 jmc 115: and with a non-zero value if one or more
1.15 jmc 116: filesystems are over quota.
1.1 deraadt 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
1.9 aaron 125: .Sh HISTORY
126: The
127: .Nm quota
128: command appeared in
129: .Bx 4.2 .