xref: /freebsd/usr.bin/du/du.1 (revision 41059135ce931c0f1014a999ffabc6bc470ce856)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"	@(#)du.1	8.2 (Berkeley) 4/1/94
29.\" $FreeBSD$
30.\"
31.Dd November 4, 2012
32.Dt DU 1
33.Os
34.Sh NAME
35.Nm du
36.Nd display disk usage statistics
37.Sh SYNOPSIS
38.Nm
39.Op Fl Aclnx
40.Op Fl H | L | P
41.Op Fl g | h | k | m
42.Op Fl a | s | d Ar depth
43.Op Fl B Ar blocksize
44.Op Fl I Ar mask
45.Op Fl t Ar threshold
46.Op Ar
47.Sh DESCRIPTION
48The
49.Nm
50utility displays the file system block usage for each file argument
51and for each directory in the file hierarchy rooted in each directory
52argument.
53If no file is specified, the block usage of the hierarchy rooted in
54the current directory is displayed.
55.Pp
56The options are as follows:
57.Bl -tag -width indent
58.It Fl A
59Display the apparent size instead of the disk usage.
60This can be helpful when operating on compressed volumes or sparse files.
61.It Fl B Ar blocksize
62Calculate block counts in
63.Ar blocksize
64byte blocks.
65This is different from the
66.Fl h, k, m
67and
68.Fl  g
69options or setting
70.Ev BLOCKSIZE
71and gives an estimate of how much space the examined file hierarchy would
72require on a filesystem with the given
73.Ar blocksize .
74Unless in
75.Fl A
76mode,
77.Ar blocksize
78is rounded up to the next multiple of 512.
79.It Fl H
80Symbolic links on the command line are followed, symbolic links in file
81hierarchies are not followed.
82.It Fl I Ar mask
83Ignore files and directories matching the specified
84.Ar mask .
85.It Fl L
86Symbolic links on the command line and in file hierarchies are followed.
87.It Fl P
88No symbolic links are followed.
89This is the default.
90.It Fl a
91Display an entry for each file in a file hierarchy.
92.It Fl c
93Display a grand total.
94.It Fl d Ar depth
95Display an entry for all files and directories
96.Ar depth
97directories deep.
98.It Fl g
99Display block counts in 1073741824-byte (1 GiB) blocks.
100.It Fl h
101.Dq Human-readable
102output.
103Use unit suffixes: Byte, Kilobyte, Megabyte,
104Gigabyte, Terabyte and Petabyte.
105.It Fl k
106Display block counts in 1024-byte (1 kiB) blocks.
107.It Fl l
108If a file has multiple hard links, count its size multiple times.
109The default behavior of
110.Nm
111is to count files with multiple hard links only once.
112When the
113.Fl l
114option is specified, the hard link checks are disabled, and these files
115are counted (and displayed) as many times as they are found.
116.It Fl m
117Display block counts in 1048576-byte (1 MiB) blocks.
118.It Fl n
119Ignore files and directories with user
120.Dq nodump
121flag
122.Pq Dv UF_NODUMP
123set.
124.It Fl r
125Generate messages about directories that cannot be read, files
126that cannot be opened, and so on.
127This is the default case.
128This option exists solely for conformance with
129.St -xpg4 .
130.It Fl s
131Display an entry for each specified file.
132(Equivalent to
133.Fl d Li 0 )
134.It Fl t Ar threshold
135Display only entries for which size exceeds
136.Ar threshold .
137If
138.Ar threshold
139is negative, display only entries for which size is less than the absolute
140value of
141.Ar threshold .
142.It Fl x
143File system mount points are not traversed.
144.El
145.Pp
146The
147.Nm
148utility counts the storage used by symbolic links and not the files they
149reference unless the
150.Fl H
151or
152.Fl L
153option is specified.
154If either the
155.Fl H
156or
157.Fl L
158option is specified, storage used by any symbolic links which are
159followed is not counted (or displayed).
160The
161.Fl H ,
162.Fl L
163and
164.Fl P
165options override each other and the command's actions are determined
166by the last one specified.
167.Pp
168The
169.Fl h, k
170and
171.Fl m
172options all override each other; the last one specified determines
173the block counts used.
174.Sh ENVIRONMENT
175.Bl -tag -width BLOCKSIZE
176.It Ev BLOCKSIZE
177If the environment variable
178.Ev BLOCKSIZE
179is set, and the
180.Fl h, k
181or
182.Fl m
183options are not specified, the block counts will be displayed in units of
184that block size.
185If
186.Ev BLOCKSIZE
187is not set, and the
188.Fl h, k
189or
190.Fl m
191options are not specified, the block counts will be displayed in 512-byte
192blocks.
193.El
194.Sh EXAMPLES
195Show disk usage for all files in the current directory.
196Output is in human-readable form:
197.Pp
198.Dl # du -ah
199.Pp
200Summarize disk usage in the current directory:
201.Pp
202.Dl # du -hs
203.Pp
204Summarize disk usage for a specific directory:
205.Pp
206.Dl # du -hs /home
207.Pp
208Show name and size of all C files in a specific directory.
209Also display a grand total at the end:
210.Pp
211.Dl # du -ch /usr/src/sys/kern/*.c
212.Sh SEE ALSO
213.Xr df 1 ,
214.Xr chflags 2 ,
215.Xr fts 3 ,
216.Xr symlink 7 ,
217.Xr quot 8
218.Sh HISTORY
219A
220.Nm
221command appeared in
222.At v1 .
223