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