freebsd-src/usr.bin/quota/quota.1

.\" Copyright (c) 1983, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Robert Elz at The University of Melbourne.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	from: @(#)quota.1	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd August 8, 2002
.Dt QUOTA 1
.Os
.Sh NAME
.Nm quota
.Nd display disk usage and limits
.Sh SYNOPSIS
.Nm
.Op Fl glu
.Op Fl v | Fl q
.Nm
.Op Fl lu
.Op Fl v | Fl q
.Ar user ...
.Nm
.Fl g
.Op Fl l
.Op Fl v | Fl q
.Ar group ...
.Sh DESCRIPTION
The
.Nm
utility displays users' disk usage and limits.
By default only the user quotas are printed.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl g
Print group quotas for the group
of which the user is a member.
.It Fl l
Do not report quotas on
.Tn NFS
file systems.
.It Fl q
Print a more terse message,
containing only information
on file systems where usage is over quota.
.It Fl u
Print the user quotas.
This is the default unless
.Fl g
is specified.
.It Fl v
Display quotas on file systems
where no storage is allocated.
.El
.Pp
Specifying both
.Fl g
and
.Fl u
displays both the user quotas and the group quotas (for
the user).
.Pp
Only the super-user may use the
.Fl u
flag and the optional
.Ar user
argument to view the limits of other users.
Non-super-users can use the
.Fl g
flag and optional
.Ar group
argument to view only the limits of groups of which they are members.
.Pp
The
.Fl q
flag takes precedence over the
.Fl v
flag.
.Pp
The
.Nm
utility tries to report the quotas of all mounted file systems.
If the file system is mounted via
.Tn NFS ,
it will attempt to contact the
.Xr rpc.rquotad 8
daemon on the
.Tn NFS
server.
For
.Tn UFS
file systems, quotas must be turned on in
.Pa /etc/fstab .
If
.Nm
exits with a non-zero status, one or more file systems
are over quota.
.Pp
If the
.Fl l
flag is specified,
.Nm
will not check
.Tn NFS
file systems.
.Sh FILES
.Bl -tag -width quota.group -compact
.It Pa quota.user
located at the file system root with user quotas
.It Pa quota.group
located at the file system root with group quotas
.It Pa /etc/fstab
to find file system names and locations
.El
.Sh SEE ALSO
.Xr quotactl 2 ,
.Xr fstab 5 ,
.Xr edquota 8 ,
.Xr quotacheck 8 ,
.Xr quotaon 8 ,
.Xr repquota 8 ,
.Xr rpc.rquotad 8
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.2 .
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.\" Copyright (c) 1983, 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" This code is derived from software contributed to Berkeley by`
			`.\" Robert Elz at The University of Melbourne.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
Obtained from: NetBSD replaced our quota with the NetBSD one, then added all changes we made to our - this is done to support the displaying of quota's over nfs using the rpc.rquotad 1996-01-05 08:37:29 +00:00			`.\" from: @(#)quota.1 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 02:08:13 +01:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.\"`
Add a new flag (-l) that suppresses quota checks on NFS filesystems. PR: bin/12939 Submitted by: Neil Blakey-Milner <nbm@rucus.ru.ac.za> 2002-08-09 01:53:00 +01:00			`.Dd August 8, 2002`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.Dt QUOTA 1`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:16:33 +01:00			`.Os`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.Sh NAME`
			`.Nm quota`
			`.Nd display disk usage and limits`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Add a new flag (-l) that suppresses quota checks on NFS filesystems. PR: bin/12939 Submitted by: Neil Blakey-Milner <nbm@rucus.ru.ac.za> 2002-08-09 01:53:00 +01:00			`.Op Fl glu`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.Op Fl v \| Fl q`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Add a new flag (-l) that suppresses quota checks on NFS filesystems. PR: bin/12939 Submitted by: Neil Blakey-Milner <nbm@rucus.ru.ac.za> 2002-08-09 01:53:00 +01:00			`.Op Fl lu`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.Op Fl v \| Fl q`
Fix a few compiler warnings, sort options and make the usage() output match the synopsis. 2002-08-09 01:43:36 +01:00			`.Ar user ...`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Fix a few compiler warnings, sort options and make the usage() output match the synopsis. 2002-08-09 01:43:36 +01:00			`.Fl g`
Add a new flag (-l) that suppresses quota checks on NFS filesystems. PR: bin/12939 Submitted by: Neil Blakey-Milner <nbm@rucus.ru.ac.za> 2002-08-09 01:53:00 +01:00			`.Op Fl l`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.Op Fl v \| Fl q`
Fix a few compiler warnings, sort options and make the usage() output match the synopsis. 2002-08-09 01:43:36 +01:00			`.Ar group ...`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-20 13:18:28 +01:00			`The`
			`.Nm`
			`utility displays users' disk usage and limits.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`By default only the user quotas are printed.`
			`.Pp`
Remove incorrect use of .Nm. Wrap long lines, Unwrap short lines Options: -> The following options are available: 2000-03-26 15:48:46 +01:00			`The following options are available:`
			`.Bl -tag -width indent`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.It Fl g`
Remove whitespace at EOL. 2001-07-15 09:06:20 +01:00			`Print group quotas for the group`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`of which the user is a member.`
Add a new flag (-l) that suppresses quota checks on NFS filesystems. PR: bin/12939 Submitted by: Neil Blakey-Milner <nbm@rucus.ru.ac.za> 2002-08-09 01:53:00 +01:00			`.It Fl l`
			`Do not report quotas on`
			`.Tn NFS`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`file systems.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.It Fl q`
			`Print a more terse message,`
			`containing only information`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`on file systems where usage is over quota.`
Fix a few compiler warnings, sort options and make the usage() output match the synopsis. 2002-08-09 01:43:36 +01:00			`.It Fl u`
			`Print the user quotas.`
			`This is the default unless`
			`.Fl g`
			`is specified.`
			`.It Fl v`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`Display quotas on file systems`
Fix a few compiler warnings, sort options and make the usage() output match the synopsis. 2002-08-09 01:43:36 +01:00			`where no storage is allocated.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.El`
			`.Pp`
			`Specifying both`
			`.Fl g`
			`and`
			`.Fl u`
			`displays both the user quotas and the group quotas (for`
			`the user).`
			`.Pp`
			`Only the super-user may use the`
			`.Fl u`
			`flag and the optional`
			`.Ar user`
			`argument to view the limits of other users.`
delete doubled words, e.g.: "the the" -> "the" 1996-10-05 23:27:30 +01:00			`Non-super-users can use the`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.Fl g`
			`flag and optional`
			`.Ar group`
			`argument to view only the limits of groups of which they are members.`
			`.Pp`
			`The`
			`.Fl q`
			`flag takes precedence over the`
			`.Fl v`
			`flag.`
			`.Pp`
Use `The .Nm utility' 2002-04-20 13:18:28 +01:00			`The`
			`.Nm`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`utility tries to report the quotas of all mounted file systems.`
			`If the file system is mounted via`
Remove incorrect use of .Nm. Wrap long lines, Unwrap short lines Options: -> The following options are available: 2000-03-26 15:48:46 +01:00			`.Tn NFS ,`
Obtained from: NetBSD replaced our quota with the NetBSD one, then added all changes we made to our - this is done to support the displaying of quota's over nfs using the rpc.rquotad 1996-01-05 08:37:29 +00:00			`it will attempt to contact the`
			`.Xr rpc.rquotad 8`
			`daemon on the`
Remove incorrect use of .Nm. Wrap long lines, Unwrap short lines Options: -> The following options are available: 2000-03-26 15:48:46 +01:00			`.Tn NFS`
Obtained from: NetBSD replaced our quota with the NetBSD one, then added all changes we made to our - this is done to support the displaying of quota's over nfs using the rpc.rquotad 1996-01-05 08:37:29 +00:00			`server.`
			`For`
Remove incorrect use of .Nm. Wrap long lines, Unwrap short lines Options: -> The following options are available: 2000-03-26 15:48:46 +01:00			`.Tn UFS`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`file systems, quotas must be turned on in`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.Pa /etc/fstab .`
			`If`
Use err(3). Cosmetic in usage string. Typo in man page. 1997-08-04 07:45:11 +01:00			`.Nm`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`exits with a non-zero status, one or more file systems`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`are over quota.`
Add a new flag (-l) that suppresses quota checks on NFS filesystems. PR: bin/12939 Submitted by: Neil Blakey-Milner <nbm@rucus.ru.ac.za> 2002-08-09 01:53:00 +01:00			`.Pp`
			`If the`
			`.Fl l`
			`flag is specified,`
			`.Nm`
			`will not check`
			`.Tn NFS`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`file systems.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.Sh FILES`
			`.Bl -tag -width quota.group -compact`
			`.It Pa quota.user`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`located at the file system root with user quotas`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.It Pa quota.group`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`located at the file system root with group quotas`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.It Pa /etc/fstab`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`to find file system names and locations`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 13:33:43 +01:00			`.El`
			`.Sh SEE ALSO`
			`.Xr quotactl 2 ,`
			`.Xr fstab 5 ,`
			`.Xr edquota 8 ,`
			`.Xr quotacheck 8 ,`
			`.Xr quotaon 8 ,`
Obtained from: NetBSD replaced our quota with the NetBSD one, then added all changes we made to our - this is done to support the displaying of quota's over nfs using the rpc.rquotad 1996-01-05 08:37:29 +00:00			`.Xr repquota 8 ,`
			`.Xr rpc.rquotad 8`
Sort sections. 2005-01-18 13:43:56 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`command appeared in`
			`.Bx 4.2 .`