freebsd-dev/sbin/quotacheck/quotacheck.8

.\" Copyright (c) 1983, 1990, 1991, 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.
.\"
.\"     @(#)quotacheck.8	8.1 (Berkeley) 6/5/93
.\" $FreeBSD$
.\"
.Dd June 5, 1993
.Dt QUOTACHECK 8
.Os BSD 4.2
.Sh NAME
.Nm quotacheck
.Nd filesystem quota consistency checker
.Sh SYNOPSIS
.Nm
.Op Fl g
.Op Fl u
.Op Fl v
.Ar filesystem
.Ar
.Nm
.Op Fl g
.Op Fl u
.Op Fl v
.Fl a
.Sh DESCRIPTION
.Nm Quotacheck
examines each filesystem,
builds a table of current disk usage,
and compares this table against that recorded
in the disk quota file for the filesystem.
If any inconsistencies are detected, both the
quota file and the current system copy of the
incorrect quotas are updated (the latter only
occurs if an active filesystem is checked).
By default both user and group quotas are checked.
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl a
If supplied in place of any filesystem names,
.Nm
will check all the filesystems indicated in
.Pa /etc/fstab
to be read-write with disk quotas.
By default only the types of quotas listed in
.Pa /etc/fstab
are checked.
.It Fl g
Only group quotas listed in
.Pa /etc/fstab
are to be checked.
.It Fl u
Only user quotas listed in
.Pa /etc/fstab
are to be checked.
.It Fl v
.Nm Quotacheck
reports discrepancies between the
calculated and recorded disk quotas and other additional diagnostic messages.
.El
.Pp
Specifying both
.Fl g
and
.Fl u
is equivalent to the default.
Parallel passes are run on the filesystems required,
using the pass numbers in
.Pa /etc/fstab
in an identical fashion to
.Xr fsck 8 .
.Pp
Normally,
.Nm
operates silently.
.Pp
.Nm Quotacheck
expects each filesystem to be checked to have a
quota files named
.Pa quota.user
and
.Pa quota.group
which are located at the root of the associated file system.
These defaults may be overridden in
.Pa /etc/fstab .
If a file is not present, 
.Nm
will create it.
These files should be edited with the 
.Xr edquota 8
utility.
.Pp
.Nm Quotacheck
is normally run at boot time from the
.Pa /etc/rc
file.
The rc startup procedure is controlled by the 
.Pa /etc/rc.conf
variable 
.Ar check_quotas .
Note that to enable this functionality in 
.Pa /etc/rc
you also need to enable startup quota procedures
with the variable
.Ar enable_quotas 
in 
.Pa /etc/rc.conf .
.Pp
.Nm Quotacheck
accesses the raw device in calculating the actual
disk usage for each user.
Thus, the filesystems
checked should be quiescent while
.Nm
is running.
.Sh FILES
.Bl -tag -width quota.group -compact
.It Pa quota.user
at the filesystem root with user quotas
.It Pa quota.group
at the filesystem root with group quotas
.It Pa /etc/fstab
default filesystems
.El
.Sh SEE ALSO
.Xr quota 1 ,
.Xr quotactl 2 ,
.Xr fstab 5 ,
.Xr edquota 8 ,
.Xr fsck 8 ,
.Xr quotaon 8 ,
.Xr repquota 8
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.2 .
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\" Copyright (c) 1983, 1990, 1991, 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.`
			`.\"`
			`.\" @(#)quotacheck.8 8.1 (Berkeley) 6/5/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\"`
			`.Dd June 5, 1993`
			`.Dt QUOTACHECK 8`
			`.Os BSD 4.2`
			`.Sh NAME`
			`.Nm quotacheck`
			`.Nd filesystem quota consistency checker`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Op Fl g`
			`.Op Fl u`
			`.Op Fl v`
Correct use of .Nm. Add rcsid. Remove unused #includes. Use warn(). Errx(1, "malloc failed") is better than err(1, NULL). 1998-07-15 06:48:52 +00:00			`.Ar filesystem`
			`.Ar`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Op Fl g`
			`.Op Fl u`
			`.Op Fl v`
			`.Fl a`
			`.Sh DESCRIPTION`
			`.Nm Quotacheck`
			`examines each filesystem,`
			`builds a table of current disk usage,`
			`and compares this table against that recorded`
			`in the disk quota file for the filesystem.`
			`If any inconsistencies are detected, both the`
			`quota file and the current system copy of the`
			`incorrect quotas are updated (the latter only`
			`occurs if an active filesystem is checked).`
			`By default both user and group quotas are checked.`
			`.Pp`
Correct use of .Nm. Add rcsid. Remove unused #includes. Use warn(). Errx(1, "malloc failed") is better than err(1, NULL). 1998-07-15 06:48:52 +00:00			`The following options are available:`
			`.Bl -tag -width indent`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.It Fl a`
Correct use of .Nm. Add rcsid. Remove unused #includes. Use warn(). Errx(1, "malloc failed") is better than err(1, NULL). 1998-07-15 06:48:52 +00:00			`If supplied in place of any filesystem names,`
			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`will check all the filesystems indicated in`
			`.Pa /etc/fstab`
			`to be read-write with disk quotas.`
			`By default only the types of quotas listed in`
			`.Pa /etc/fstab`
			`are checked.`
			`.It Fl g`
			`Only group quotas listed in`
			`.Pa /etc/fstab`
			`are to be checked.`
			`.It Fl u`
			`Only user quotas listed in`
			`.Pa /etc/fstab`
			`are to be checked.`
			`.It Fl v`
Correct use of .Nm. Add rcsid. Remove unused #includes. Use warn(). Errx(1, "malloc failed") is better than err(1, NULL). 1998-07-15 06:48:52 +00:00			`.Nm Quotacheck`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`reports discrepancies between the`
Print out an informative message if the verbose option is given and an unknown uid/gid is found in the file system. This is useful if you wind up with a file in your file system that has a uid that is extremely large, since quotacheck will wind up running a very very long time due to it not handling large gaps in uids very well (this is a problem that should be addressed some day). Update the man page to reflect that fact the the -v flag now prints some additional diagnostic messages. 1996-02-21 18:40:54 +00:00			`calculated and recorded disk quotas and other additional diagnostic messages.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.El`
			`.Pp`
			`Specifying both`
			`.Fl g`
			`and`
			`.Fl u`
			`is equivalent to the default.`
			`Parallel passes are run on the filesystems required,`
			`using the pass numbers in`
			`.Pa /etc/fstab`
			`in an identical fashion to`
			`.Xr fsck 8 .`
			`.Pp`
Correct use of .Nm. Add rcsid. Remove unused #includes. Use warn(). Errx(1, "malloc failed") is better than err(1, NULL). 1998-07-15 06:48:52 +00:00			`Normally,`
			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`operates silently.`
			`.Pp`
			`.Nm Quotacheck`
			`expects each filesystem to be checked to have a`
			`quota files named`
			`.Pa quota.user`
			`and`
			`.Pa quota.group`
			`which are located at the root of the associated file system.`
			`These defaults may be overridden in`
			`.Pa /etc/fstab .`
			`If a file is not present,`
Correct use of .Nm. Add rcsid. Remove unused #includes. Use warn(). Errx(1, "malloc failed") is better than err(1, NULL). 1998-07-15 06:48:52 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`will create it.`
Mention the edquota(8) utility when talking about editing quota.user and quota.group. PR: docs/25124 2001-02-22 11:07:58 +00:00			`These files should be edited with the`
			`.Xr edquota 8`
			`utility.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Pp`
			`.Nm Quotacheck`
			`is normally run at boot time from the`
Indicate that we now control quota checking via an rc.conf variable, instead of putting it in rc.local. Submitted by: Alex Perel <veers@disturbed.net> 1999-09-06 20:55:28 +00:00			`.Pa /etc/rc`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 11:27:47 +00:00			`file.`
			`The rc startup procedure is controlled by the`
Indicate that we now control quota checking via an rc.conf variable, instead of putting it in rc.local. Submitted by: Alex Perel <veers@disturbed.net> 1999-09-06 20:55:28 +00:00			`.Pa /etc/rc.conf`
			`variable`
			`.Ar check_quotas .`
			`Note that to enable this functionality in`
			`.Pa /etc/rc`
			`you also need to enable startup quota procedures`
			`with the variable`
			`.Ar enable_quotas`
			`in`
			`.Pa /etc/rc.conf .`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Pp`
			`.Nm Quotacheck`
			`accesses the raw device in calculating the actual`
			`disk usage for each user.`
			`Thus, the filesystems`
			`checked should be quiescent while`
Correct use of .Nm. Add rcsid. Remove unused #includes. Use warn(). Errx(1, "malloc failed") is better than err(1, NULL). 1998-07-15 06:48:52 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`is running.`
			`.Sh FILES`
			`.Bl -tag -width quota.group -compact`
			`.It Pa quota.user`
			`at the filesystem root with user quotas`
			`.It Pa quota.group`
			`at the filesystem root with group quotas`
			`.It Pa /etc/fstab`
			`default filesystems`
			`.El`
			`.Sh SEE ALSO`
			`.Xr quota 1 ,`
			`.Xr quotactl 2 ,`
			`.Xr fstab 5 ,`
			`.Xr edquota 8 ,`
			`.Xr fsck 8 ,`
			`.Xr quotaon 8 ,`
			`.Xr repquota 8`
			`.Sh HISTORY`
			`The`
			`.Nm`
			`command appeared in`
			`.Bx 4.2 .`