file_cmds/du/du.1

   1 .\" Copyright (c) 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)du.1        8.2 (Berkeley) 4/1/94
  33 .\" $FreeBSD: src/usr.bin/du/du.1,v 1.30 2005/05/21 09:55:05 ru Exp $
  34 .\"
  35 .Dd June 2, 2004
  36 .Dt DU 1
  37 .Os
  38 .Sh NAME
  39 .Nm du
  40 .Nd display disk usage statistics
  41 .Sh SYNOPSIS
  42 .Nm du
  43 .Op Fl H | L | P
  44 .Op Fl a | s | d Ar depth
  45 .Op Fl c
  46 .Op Fl h | k | m | g
  47 .Op Fl x
  48 .Op Fl I Ar mask
  49 .Op Ar
  50 .Sh DESCRIPTION
  51 The
  52 .Nm du
  53 utility displays the file system block usage for each file argument
  54 and for each directory in the file hierarchy rooted in each directory
  55 argument.
  56 If no file is specified, the block usage of the hierarchy rooted in
  57 the current directory is displayed.
  58 .Pp
  59 The options are as follows:
  60 .Bl -tag -width indent
  61 .It Fl a
  62 Display an entry for each file in a file hierarchy.
  63 .It Fl c
  64 Display a grand total.
  65 .It Fl d Ar depth
  66 Display an entry for all files and directories
  67 .Ar depth
  68 directories deep.
  69 .It Fl H
  70 Symbolic links on the command line are followed, symbolic links in file
  71 hierarchies are not followed.
  72 .It Fl h
  73 "Human-readable" output.
  74 Use unit suffixes: Byte, Kilobyte, Megabyte,
  75 Gigabyte, Terabyte and Petabyte.
  76 .It Fl I Ar mask
  77 Ignore files and directories matching the specified
  78 .Ar mask .
  79 .It Fl g
  80 Display block counts in 1073741824-byte (1-Gbyte) blocks.
  81 .It Fl k
  82 Display block counts in 1024-byte (1-Kbyte) blocks.
  83 .It Fl L
  84 Symbolic links on the command line and in file hierarchies are followed.
  85 .It Fl m
  86 Display block counts in 1048576-byte (1-Mbyte) blocks.
  87 .It Fl P
  88 No symbolic links are followed.
  89 This is the default.
  90 .It Fl r
  91 Generate messages about directories that cannot be read, files
  92 that cannot be opened, and so on.
  93 This is the default case.
  94 This option exists solely for conformance with
  95 .St -xpg4 .
  96 .It Fl s
  97 Display an entry for each specified file.
  98 (Equivalent to
  99 .Fl d Li 0 )
 100 .It Fl x
 101 File system mount points are not traversed.
 102 .El
 103 .Pp
 104 The
 105 .Nm du
 106 utility counts the storage used by symbolic links and not the files they
 107 reference unless the
 108 .Fl H
 109 or
 110 .Fl L
 111 option is specified.
 112 If either the
 113 .Fl H
 114 or
 115 .Fl L
 116 options are specified, storage used by any symbolic links which are
 117 followed is not counted or displayed.
 118 If more than one of the
 119 .Fl H ,
 120 .Fl L ,
 121 and
 122 .Fl P
 123 options is specified, the last one given is used.
 124 .Pp
 125 Files having multiple hard links are counted (and displayed) a single
 126 time per
 127 .Nm du
 128 execution.
 129 Directories having multiple hard links (typically Time Machine backups) are
 130 counted a single time per
 131 .Nm du
 132 execution.
 133 .Sh ENVIRONMENT
 134 .Bl -tag -width BLOCKSIZE
 135 .It Ev BLOCKSIZE
 136 If the environment variable
 137 .Ev BLOCKSIZE
 138 is set, and the
 139 .Fl k
 140 option is not specified, the block counts will be displayed in units of that
 141 size block.
 142 If
 143 .Ev BLOCKSIZE
 144 is not set, and the
 145 .Fl k
 146 option is not specified, the block counts will be displayed in 512-byte blocks.
 147 .El
 148 .Sh LEGACY DESCRIPTION
 149 In legacy mode, only one of the
 150 .Fl H ,
 151 .Fl L ,
 152 or
 153 .Fl P
 154 options may be specified.
 155 .Pp
 156 The command will detect and report a SYMLOOP error
 157 (loop involving symbolic links).
 158 In legacy mode, this is not the case.
 159 .Pp
 160 For more information about legacy mode, see
 161 .Xr compat 5 .
 162 .Sh SEE ALSO
 163 .Xr df 1 ,
 164 .Xr fts 3 ,
 165 .Xr compat 5 ,
 166 .Xr symlink 7 ,
 167 .Xr quot 8
 168 .Sh HISTORY
 169 A
 170 .Nm du
 171 command appeared in
 172 .At v1 .