[unix-history] / sbin / quotacheck / quotacheck.8

.\" Copyright (c) 1983, 1990, 1991 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	6.7 (Berkeley) 3/16/91
.\"
.Dd March 16, 1991
.Dt QUOTACHECK 8
.Os BSD 4.2
.Sh NAME
.Nm quotacheck
.Nd filesystem quota consistency checker
.Sh SYNOPSIS
.Nm quotacheck
.Op Fl g
.Op Fl u
.Op Fl v
.Ar filesystem Ar ...
.Nm quotacheck
.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
Available options:
.Bl -tag -width Ds
.It Fl a
If the
.Fl a
flag is supplied in place of any filesystem names,
.Nm quotacheck
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.
.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 quotacheck
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 quotacheck
will create it.
.Pp
.Nm Quotacheck
is normally run at boot time from the
.Pa /etc/rc.local
file, see
.Xr rc 8 ,
before enabling disk quotas with
.Xr quotaon 8 .
.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 quotacheck
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 .
Commit	Line	Data
15637ed4 RG	1	.\" Copyright (c) 1983, 1990, 1991 Regents of the University of California.
	2	.\" 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	.\" @(#)quotacheck.8 6.7 (Berkeley) 3/16/91
	36	.\"
	37	.Dd March 16, 1991
	38	.Dt QUOTACHECK 8
	39	.Os BSD 4.2
	40	.Sh NAME
	41	.Nm quotacheck
	42	.Nd filesystem quota consistency checker
	43	.Sh SYNOPSIS
	44	.Nm quotacheck
	45	.Op Fl g
	46	.Op Fl u
	47	.Op Fl v
	48	.Ar filesystem Ar ...
	49	.Nm quotacheck
	50	.Op Fl g
	51	.Op Fl u
	52	.Op Fl v
	53	.Fl a
	54	.Sh DESCRIPTION
	55	.Nm Quotacheck
	56	examines each filesystem,
	57	builds a table of current disk usage,
	58	and compares this table against that recorded
	59	in the disk quota file for the filesystem.
	60	If any inconsistencies are detected, both the
	61	quota file and the current system copy of the
	62	incorrect quotas are updated (the latter only
	63	occurs if an active filesystem is checked).
	64	By default both user and group quotas are checked.
65	.Pp
66	Available options:
67	.Bl -tag -width Ds
68	.It Fl a
69	If the
70	.Fl a
71	flag is supplied in place of any filesystem names,
72	.Nm quotacheck
73	will check all the filesystems indicated in
74	.Pa /etc/fstab
75	to be read-write with disk quotas.
76	By default only the types of quotas listed in
77	.Pa /etc/fstab
78	are checked.
79	.It Fl g
80	Only group quotas listed in
81	.Pa /etc/fstab
82	are to be checked.
83	.It Fl u
84	Only user quotas listed in
85	.Pa /etc/fstab
86	are to be checked.
87	.It Fl v
88	.Nm quotacheck
89	reports discrepancies between the
90	calculated and recorded disk quotas.
91	.El
92	.Pp
93	Specifying both
94	.Fl g
95	and
96	.Fl u
97	is equivalent to the default.
98	Parallel passes are run on the filesystems required,
99	using the pass numbers in
100	.Pa /etc/fstab
101	in an identical fashion to
102	.Xr fsck 8 .
103	.Pp
104	Normally
105	.Nm quotacheck
106	operates silently.
107	.Pp
108	.Nm Quotacheck
109	expects each filesystem to be checked to have a
110	quota files named
111	.Pa quota.user
112	and
113	.Pa quota.group
114	which are located at the root of the associated file system.
115	These defaults may be overridden in
116	.Pa /etc/fstab .
117	If a file is not present,
118	.Nm quotacheck
119	will create it.
120	.Pp
121	.Nm Quotacheck
122	is normally run at boot time from the
123	.Pa /etc/rc.local
124	file, see
125	.Xr rc 8 ,
126	before enabling disk quotas with
127	.Xr quotaon 8 .
128	.Pp
129	.Nm Quotacheck
130	accesses the raw device in calculating the actual
131	disk usage for each user.
132	Thus, the filesystems
133	checked should be quiescent while
134	.Nm quotacheck
135	is running.
136	.Sh FILES
137	.Bl -tag -width quota.group -compact
138	.It Pa quota.user
139	at the filesystem root with user quotas
140	.It Pa quota.group
141	at the filesystem root with group quotas
142	.It Pa /etc/fstab
143	default filesystems
144	.El
145	.Sh SEE ALSO
146	.Xr quota 1 ,
147	.Xr quotactl 2 ,
148	.Xr fstab 5 ,
149	.Xr edquota 8 ,
150	.Xr fsck 8 ,
151	.Xr quotaon 8 ,
152	.Xr repquota 8
153	.Sh HISTORY
154	The
155	.Nm
156	command appeared in
157	.Bx 4.2 .