FSCKHFS(8)               BSD System Manager's Manual              FSCKHFS(8)

NAME
     fsckhfs -- HFS file system consistency check

SYNOPSIS
     fsckhfs -q [-df] special ...
     fsckhfs -p [-df] special ...
     fsckhfs [-n  -y  -r] [-dfgl] [-m mode] [-c size] special ...

DESCRIPTION
     The fsckhfs utility verifies and repairs standard HFS and HFS] file sys-
     tems.

     The first form of fsckhfs quickly checks the specified file systems to
     determine whether they were cleanly unmounted.

     The second form of fsckhfs preens the specified file systems.  It is
     normally started by fsck(8) run from /etc/rc.boot during automatic
     reboot, when a HFS file system is detected.  When preening file systems,
     fsckhfs will fix common inconsistencies for file systems that were not
     unmounted cleanly.  If more serious problems are found, fsckhfs does not
     try to fix them, indicates that it was not successful, and exits.

     The third form of fsckhfs checks the specified file systems and tries to
     repair all detected inconsistencies.

     If no options are specified fsckhfs will always check and attempt to fix
     the specified file systems.

     The options are as follows:

           -c size Specify the size of the cache used by fsckhfs internally.
                   Bigger size can result in better performance but can result
                   in deadlock when used with -l option.  Size can be speci-
                   fied as a decimal, octal, or hexadecimal number.  If the
                   number ends with a ``k'', ``m'', or ``g'', the number is
                   multiplied by 1024 (1K), 1048576 (1M), or 1073741824 (1G),
                   respectively.

           -d      Display debugging information.  This option may provide
                   useful information when fsckhfs cannot repair a damaged
                   file system.

           -f      When used with the -p option, force fsckhfs to check
                   `clean' file systems, otherwise it means force fsckhfs to
                   check and repair journaled HFS] file systems.

           -g      Causes fsckhfs to generate it's output strings in GUI for-
                   mat.  This option is used when another application with a
                   graphical user interface (like Mac OS X Disk Utility) is
                   envoking the fsckhfs tool.

           -l      Lock down the file system and perform a test-only check.
                   This makes it possible to check a file system that is cur-
                   rently mounted, although no repairs can be made.

           -m mode Mode is an octal number that will be used to set the per-
                   missions for the lost]found directory when it is created.
                   The lost]found directory is only created when a volume is
                   repaired and orphaned files or directories are detected.
                   fsckhfs places orphaned files and directories into the
                   lost]found directory (located at the root of the volume).
                   The default mode is 01777.

           -p      Preen the specified file systems.

           -q      Causes fsckhfs to quickly check whether the volume was
                   unmounted cleanly.  If the volume was unmounted cleanly,
                   then the exit status is 0.  If the volume was not unmounted
                   cleanly, then the exit status will be non-zero.  In either
                   case, a message is printed to standard output describing
                   whether the volume was clean or dirty.

           -y      Always attempt to repair any damage that is found.

           -n      Never attempt to repair any damage that is found.

           -r      Rebuild the catalog file on the specified file system.
                   This option currently will only work if there is enough
                   contiguous space on the specified file system for a new
                   catalog file and if there is no damage to the leaf nodes in
                   the existing catalog file.

     Because of inconsistencies between the block device and the buffer cache,
     the raw device should always be used.

SEE ALSO
     fsck(8)

BUGS
     fsckhfs is not able to fix some inconsistencies that it detects.

HISTORY
     The fsckhfs command appeared in Mac OS X Server 1.0 .

Mac OS X                       November 21, 2002                      Mac OS X