xref: /freebsd/usr.bin/du/du.1 (revision ad30f8e79bd1007cc2476e491bd21b4f5e389e0a)
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.\" 4. 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 6, 2008
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 A
40.Op Fl H | L | P
41.Op Fl a | s | d Ar depth | Fl t Ar threshold
42.Op Fl c
43.Op Fl l
44.Op Fl h | k | m | B Ar blocksize
45.Op Fl n
46.Op Fl x
47.Op Fl I Ar mask
48.Op Ar
49.Sh DESCRIPTION
50The
51.Nm
52utility displays the file system block usage for each file argument
53and for each directory in the file hierarchy rooted in each directory
54argument.
55If no file is specified, the block usage of the hierarchy rooted in
56the current directory is displayed.
57.Pp
58The options are as follows:
59.Bl -tag -width indent
60.It Fl A
61Display the apparent size instead of the disk usage.
62This can be helpful when operating on compressed volumes or sparse files.
63.It Fl B Ar blocksize
64Calculate block counts in
65.Ar blocksize
66byte blocks.
67This is different from the
68.Fl k, m
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 L
83Symbolic links on the command line and in file hierarchies are followed.
84.It Fl I Ar mask
85Ignore files and directories matching the specified
86.Ar mask .
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 h
93"Human-readable" output.
94Use unit suffixes: Byte, Kilobyte, Megabyte,
95Gigabyte, Terabyte and Petabyte.
96.It Fl r
97Generate messages about directories that cannot be read, files
98that cannot be opened, and so on.
99This is the default case.
100This option exists solely for conformance with
101.St -xpg4 .
102.It Fl s
103Display an entry for each specified file.
104(Equivalent to
105.Fl d Li 0 )
106.It Fl t Ar threshold
107Display only entries for which size exceeds
108.Ar threshold .
109If
110.Ar threshold
111is negative, display only entries for which size is less than the absolute
112value of
113.Ar threshold .
114.It Fl d Ar depth
115Display an entry for all files and directories
116.Ar depth
117directories deep.
118.It Fl c
119Display a grand total.
120.It Fl k
121Display block counts in 1024-byte (1-Kbyte) blocks.
122.It Fl l
123If a file has multiple hard links, count its size many times.
124The default behavior of
125.Nm
126is to count files with multiple hard links only once.
127When the
128.Fl l
129option is specified, the hard link checks are disabled, and these files
130are counted (and displayed) as many times as they are found.
131.It Fl m
132Display block counts in 1048576-byte (1-Mbyte) blocks.
133.It Fl n
134Ignore files and directories with user
135.Dq nodump
136flag
137.Pq Dv UF_NODUMP
138set.
139.It Fl x
140File system mount points are not traversed.
141.El
142.Pp
143The
144.Nm
145utility counts the storage used by symbolic links and not the files they
146reference unless the
147.Fl H
148or
149.Fl L
150option is specified.
151If either the
152.Fl H
153or
154.Fl L
155options are specified, storage used by any symbolic links which are
156followed is not counted or displayed.
157.Sh ENVIRONMENT
158.Bl -tag -width BLOCKSIZE
159.It Ev BLOCKSIZE
160If the environment variable
161.Ev BLOCKSIZE
162is set, and the
163.Fl k, m
164or
165.Fl h
166options are not specified, the block counts will be displayed in units of
167that block size.
168If
169.Ev BLOCKSIZE
170is not set, and the
171.Fl k, m
172or
173.Fl h
174options are not specified, the block counts will be displayed in 512-byte
175blocks.
176.El
177.Sh SEE ALSO
178.Xr df 1 ,
179.Xr chflags 2 ,
180.Xr fts 3 ,
181.Xr symlink 7 ,
182.Xr quot 8
183.Sh HISTORY
184A
185.Nm
186command appeared in
187.At v1 .
188