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