diskdev_cmds/quotacheck.tproj/quotacheck.8

   1 .\" Copyright (c) 1983, 1990, 1991, 1993, 2002
   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 .\"
  37 .Dd October 17, 2002
  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 read-write filesystems with an existing
  74 mount option file at its root.
  75 The mount option file specifies the types of quotas that
  76 are to be checked.
  77 .It Fl g
  78 Only group quotas are checked. The mount option file,
  79 .Pa .quota.ops.group ,
  80 must exist at the root of the filesystem.
  81 .It Fl u
  82 Only user quotas are checked.  The mount option file,
  83 .Pa .quota.ops.user ,
  84 must exist at the root of the filesystem.
  85 .It Fl v
  86 .Nm quotacheck
  87 reports discrepancies between the
  88 calculated and recorded disk quotas.
  89 .El
  90 .Pp
  91 Specifying both
  92 .Fl g
  93 and
  94 .Fl u
  95 is equivalent to the default.
  96 Parallel passes are run on the filesystems required,
  97 in an identical fashion to
  98 .Xr fsck 8 .
  99 .Pp
 100 Normally
 101 .Nm quotacheck
 102 operates silently.
 103 .Pp
 104 .Nm Quotacheck
 105 expects each filesystem being checked to have
 106 quota data files named
 107 .Pa .quota.user
 108 and/or
 109 .Pa .quota.group
 110 located at the filesystem root.
 111 If a binary data file is not present,
 112 .Nm quotacheck
 113 will create it.
 114 The default filename and root location cannot be overridden.
 115 .Pp
 116 .Nm Quotacheck
 117 is normally run at
 118 .Pa fsck
 119 time.
 120 .Pp
 121 .Nm Quotacheck
 122 accesses the raw device in calculating the actual
 123 disk usage for each user.
 124 Thus, the filesystems
 125 checked should be quiescent while
 126 .Nm quotacheck
 127 is running.
 128 .Sh FILES
 129 Each of the following quota files is located at the root of the
 130 mounted filesystem.  The mount option files are empty files
 131 whose existence indicates that quotas are to be enabled
 132 for that filesystem. The binary data files will be created by
 133 quotacheck, if they don't already exist.
 134 .Pp
 135 .Bl -tag -width .quota.ops.group -compact
 136 .It Pa .quota.user
 137 data file containing user quotas
 138 .It Pa .quota.group
 139 data file containing group quotas
 140 .It Pa .quota.ops.user
 141 mount option file used to enable user quotas
 142 .It Pa .quota.ops.group
 143 mount option file used to enable group quotas
 144 .El
 145 .Sh SEE ALSO
 146 .Xr quota 1 ,
 147 .Xr quotactl 2 ,
 148 .Xr edquota 8 ,
 149 .Xr fsck 8 ,
 150 .Xr quotaon 8 ,
 151 .Xr repquota 8
 152 .Sh HISTORY
 153 The
 154 .Nm
 155 command appeared in
 156 .Bx 4.2 .