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