xref: /freebsd/usr.bin/du/du.1 (revision 06064893b3c62c648518be78604fac29fc0d9d61)
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 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
43.Op Fl H | L | P
44.Op Fl I Ar mask
45.Op Fl a | s | d Ar depth
46.Op Fl c
47.Op Fl h | k | m
48.Op Fl x
49.Op Ar
50.Sh DESCRIPTION
51The
52.Nm
53utility displays the file system block usage for each file argument
54and for each directory in the file hierarchy rooted in each directory
55argument.
56If no file is specified, the block usage of the hierarchy rooted in
57the current directory is displayed.
58.Pp
59The options are as follows:
60.Bl -tag -width indent
61.It Fl H
62Symbolic links on the command line are followed, symbolic links in file
63hierarchies are not followed.
64.It Fl L
65Symbolic links on the command line and in file hierarchies are followed.
66.It Fl I Ar mask
67Ignore files and directories matching the specified
68.Ar mask .
69.It Fl P
70No symbolic links are followed.
71This is the default.
72.It Fl a
73Display an entry for each file in a file hierarchy.
74.It Fl h
75"Human-readable" output.
76Use unit suffixes: Byte, Kilobyte, Megabyte,
77Gigabyte, Terabyte and Petabyte.
78.It Fl r
79Generate messages about directories that cannot be read, files
80that cannot be opened, and so on.
81This is the default case.
82This option exists solely for conformance with
83.St -xpg4 .
84.It Fl s
85Display an entry for each specified file.
86(Equivalent to
87.Fl d Li 0 )
88.It Fl d Ar depth
89Display an entry for all files and directories
90.Ar depth
91directories deep.
92.It Fl c
93Display a grand total.
94.It Fl k
95Display block counts in 1024-byte (1-Kbyte) blocks.
96.It Fl m
97Display block counts in 1048576-byte (1-Mbyte) blocks.
98.It Fl x
99File system mount points are not traversed.
100.El
101.Pp
102The
103.Nm
104utility counts the storage used by symbolic links and not the files they
105reference unless the
106.Fl H
107or
108.Fl L
109option is specified.
110If either the
111.Fl H
112or
113.Fl L
114options are specified, storage used by any symbolic links which are
115followed is not counted or displayed.
116.Pp
117Files having multiple hard links are counted (and displayed) a single
118time per
119.Nm
120execution.
121.Sh ENVIRONMENT
122.Bl -tag -width BLOCKSIZE
123.It Ev BLOCKSIZE
124If the environment variable
125.Ev BLOCKSIZE
126is set, and the
127.Fl k
128option is not specified, the block counts will be displayed in units of that
129size block.
130If
131.Ev BLOCKSIZE
132is not set, and the
133.Fl k
134option is not specified, the block counts will be displayed in 512-byte blocks.
135.El
136.Sh SEE ALSO
137.Xr df 1 ,
138.Xr fts 3 ,
139.Xr symlink 7 ,
140.Xr quot 8
141.Sh HISTORY
142A
143.Nm
144command appeared in
145.At v1 .
146