share/man/man1/du.1

   1 '\" te
   2 .\" Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
   3 .\" Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" Copyright 2017 OmniTI Computer Consulting, Inc. All rights reserved.
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH DU 1 "Oct 25, 2017"
  13 .SH NAME
  14 du \- summarize disk usage
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 \fB/usr/bin/du\fR [\fB-Adorx\fR] [\fB-a\fR | \fB-s\fR] [\fB-h\fR | \fB-k\fR | \fB-m\fR] [\fB-H\fR | \fB-L\fR]
  19      [\fIfile\fR ...]
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .LP
  24 The \fBdu\fR utility writes to standard output the size of the file space
  25 allocated to, and the size of the file space allocated to each subdirectory of,
  26 the file hierarchy rooted in each of the specified files. The size of the file
  27 space allocated to a file of type directory is defined as the sum total of
  28 space allocated to all files in the file hierarchy rooted in the directory plus
  29 the space allocated to the directory itself. This sum will include the space
  30 allocated to any extended attributes encountered.
  31 .LP
  32 Files with multiple links will be counted and written for only one entry. The
  33 directory entry that is selected in the report is unspecified. By default, file
  34 sizes are written in 512-byte units, rounded up to the next 512-byte unit.
  35 .LP
  36 When \fBdu\fR cannot obtain file attributes or read directories (see
  37 \fBstat\fR(2)), it will report an error condition and the final exit status
  38 will be affected.
  39 .SH OPTIONS
  40 .LP
  41 The following options are supported:
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fB-a\fR\fR
  46 .ad
  47 .RS 6n
  48 In addition to the default output, report the size of each file not of type
  49 directory in the file hierarchy rooted in the specified file. Regardless of the
  50 presence of the \fB-a\fR option, non-directories given as \fIfile\fR operands
  51 will always be listed.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fB-A\fR\fR
  58 .ad
  59 .RS 6n
  60 Tally file size using the apparent size of the file instead of the disk usage.
  61 This option is useful when operating on file systems which employ compression
  62 or in the presence of sparse files.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fB-d\fR\fR
  69 .ad
  70 .RS 6n
  71 Do not cross filesystem boundaries. For example, the command, \fBdu -d /\fR
  72 reports usage only on the root partition.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fB-h\fR\fR
  79 .ad
  80 .RS 6n
  81 All sizes are scaled to a human readable format, for example, \fB14K\fR,
  82 \fB234M\fR, \fB2.7G\fR, or \fB3.0T\fR. Scaling is done by repetitively dividing
  83 by \fB1024\fR.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB-H\fR\fR
  90 .ad
  91 .RS 6n
  92 If a symbolic link to a directory is specified on the command line, process the
  93 symbolic link by using the directory which the symbolic link references, rather
  94 than the link itself.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fB-k\fR\fR
 101 .ad
 102 .RS 6n
 103 Write the files sizes in units of 1024 bytes, rather than the default 512-byte
 104 units.
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fB-L\fR\fR
 111 .ad
 112 .RS 6n
 113 Process symbolic links by using the file or directory which the symbolic link
 114 references, rather than the link itself.
 115 .RE
 116
 117 .sp
 118 .ne 2
 119 .na
 120 \fB\fB-m\fR\fR
 121 .ad
 122 .RS 6n
 123 Write the files sizes in units of megabytes, rather than the default 512-byte
 124 units.
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fB-o\fR\fR
 131 .ad
 132 .RS 6n
 133 Do not add child directories' usage to a parent's total. Without this option,
 134 the usage listed for a particular directory is the space taken by the files in
 135 that directory, as well as the files in all directories beneath it. This option
 136 does nothing if \fB-s\fR is used.
 137 .RE
 138
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fB-r\fR\fR
 143 .ad
 144 .RS 6n
 145 Generate diagnostic messages about unreadable directories and files whose
 146 status cannot be obtained (default option).
 147 .RE
 148
 149 .sp
 150 .ne 2
 151 .na
 152 \fB\fB-s\fR\fR
 153 .ad
 154 .RS 6n
 155 Instead of the default output, report only the total sum for each of the
 156 specified files.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fB-x\fR\fR
 163 .ad
 164 .RS 6n
 165 When evaluating file sizes, evaluate only those files that have the same device
 166 as the file specified by the file operand.
 167 .RE
 168
 169 .sp
 170 .LP
 171 Specifying more than one of the options in the mutually exclusive pair,
 172 \fB-H\fR and \fB-L\fR, is not considered an error. The last option specified
 173 determines the output format.
 174 .sp
 175 .LP
 176 Specifying more than one of the options in the mutually exclusive set of
 177 options \fB-h\fR, \fB-k\fR, and \fB-m\fR is not considered an error.  The last
 178 option specified determines the output format.
 179 .SH OPERANDS
 180 .LP
 181 The following operand is supported:
 182 .sp
 183 .ne 2
 184 .na
 185 \fB\fIfile\fR\fR
 186 .ad
 187 .RS 8n
 188 The path name of a file whose size is to be written. If no \fIfile\fR is
 189 specified, the current directory is used.
 190 .RE
 191 .SH OUTPUT
 192 .LP
 193 The output from \fBdu\fR consists of the amount of the space allocated to a
 194 file and the name of the file.
 195 .SH USAGE
 196 .LP
 197 See \fBlargefile\fR(5) for the description of the behavior of \fBdu\fR when
 198 encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
 199 .SH ENVIRONMENT VARIABLES
 200 .LP
 201 See \fBenviron\fR(5) for descriptions of the following environment variables
 202 that affect the execution of \fBdu\fR: \fBLANG\fR, \fBLC_ALL\fR,
 203 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
 204 .SH EXIT STATUS
 205 .LP
 206 The following exit values are returned:
 207 .sp
 208 .ne 2
 209 .na
 210 \fB\fB0\fR\fR
 211 .ad
 212 .RS 6n
 213 Successful completion.
 214 .RE
 215 .sp
 216 .ne 2
 217 .na
 218 \fB\fB>0\fR\fI\fR\fR
 219 .ad
 220 .RS 6n
 221 An error occurred.
 222 .RE
 223 .SH ATTRIBUTES
 224 .LP
 225 See \fBattributes\fR(5) for descriptions of the following attributes:
 226 .SS "/usr/bin/du"
 227
 228 .TS
 229 box;
 230 c | c
 231 l | l .
 232 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 233 _
 234 CSI     Enabled
 235 _
 236 Interface Stability     Standard
 237 .TE
 238
 239 .SH SEE ALSO
 240 .LP
 241 \fBls\fR(1), \fBstat\fR(2), \fBattributes\fR(5), \fBenviron\fR(5),
 242 \fBfsattr\fR(5), \fBlargefile\fR(5), \fBstandards\fR(5)
 243 .LP
 244 \fISystem Administration Guide: Basic Administration\fR
 245 .SH NOTES
 246 .LP
 247 A file with two or more links is counted only once. If, however, there are
 248 links between files in different directories where the directories are on
 249 separate branches of the file system hierarchy, \fBdu\fR will count the excess
 250 files more than once.
 251 .LP
 252 Files containing holes will result in an incorrect block count. In this case,
 253 one may use the \fB-A\fR option to report file sizes by their apparent size
 254 instead.