Correct BSD License clause numbering from 1-2-4 to 1-2-3.
[dragonfly.git] / usr.bin / quota / quota.1
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: src/usr.bin/quota/quota.1,v 1.7.2.8 2003/02/24 22:37:42 trhodes Exp $
33 .\" $DragonFly: src/usr.bin/quota/quota.1,v 1.3 2006/02/17 19:39:10 swildner Exp $
34 .\"
35 .Dd August 8, 2002
36 .Dt QUOTA 1
37 .Os
38 .Sh NAME
39 .Nm quota
40 .Nd display disk usage and limits
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl glu
44 .Op Fl v | Fl q
45 .Nm
46 .Op Fl lu
47 .Op Fl v | Fl q
48 .Ar user ...
49 .Nm
50 .Fl g
51 .Op Fl l
52 .Op Fl v | Fl q
53 .Ar group ...
54 .Sh DESCRIPTION
55 The
56 .Nm
57 utility displays users' disk usage and limits.
58 By default only the user quotas are printed.
59 .Pp
60 The following options are available:
61 .Bl -tag -width indent
62 .It Fl g
63 Print group quotas for the group
64 of which the user is a member.
65 .It Fl l
66 Do not report quotas on
67 .Tn NFS
68 file systems.
69 .It Fl q
70 Print a more terse message,
71 containing only information
72 on file systems where usage is over quota.
73 .It Fl u
74 Print the user quotas.
75 This is the default unless
76 .Fl g
77 is specified.
78 .It Fl v
79 Display quotas on file systems
80 where no storage is allocated.
81 .El
82 .Pp
83 Specifying both
84 .Fl g
85 and
86 .Fl u
87 displays both the user quotas and the group quotas (for
88 the user).
89 .Pp
90 Only the super-user may use the
91 .Fl u
92 flag and the optional
93 .Ar user
94 argument to view the limits of other users.
95 Non-super-users can use the
96 .Fl g
97 flag and optional
98 .Ar group
99 argument to view only the limits of groups of which they are members.
100 .Pp
101 The
102 .Fl q
103 flag takes precedence over the
104 .Fl v
105 flag.
106 .Pp
107 The
108 .Nm
109 utility tries to report the quotas of all mounted file systems.
110 If the file system is mounted via
111 .Tn NFS ,
112 it will attempt to contact the
113 .Xr rpc.rquotad 8
114 daemon on the
115 .Tn NFS
116 server.
117 For
118 .Xr UFS 5
119 file systems, quotas must be turned on in
120 .Pa /etc/fstab .
121 If
122 .Nm
123 exits with a non-zero status, one or more file systems
124 are over quota.
125 .Pp
126 If the
127 .Fl l
128 flag is specified,
129 .Nm
130 will not check
131 .Tn NFS
132 file systems.
133 .Sh FILES
134 .Bl -tag -width quota.group -compact
135 .It Pa quota.user
136 located at the file system root with user quotas
137 .It Pa quota.group
138 located at the file system root with group quotas
139 .It Pa /etc/fstab
140 to find file system names and locations
141 .El
142 .Sh SEE ALSO
143 .Xr quotactl 2 ,
144 .Xr fstab 5 ,
145 .Xr edquota 8 ,
146 .Xr quotacheck 8 ,
147 .Xr quotaon 8 ,
148 .Xr repquota 8 ,
149 .Xr rpc.rquotad 8
150 .Sh HISTORY
151 The
152 .Nm
153 command appeared in
154 .Bx 4.2 .