xref: /freebsd/usr.bin/du/du.1 (revision ce834215a70ff69e7e222827437116eee2f9ac6f)
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.\"	$Id: du.1,v 1.8 1997/02/22 19:54:52 peter Exp $
34.\"
35.Dd April 1, 1994
36.Dt DU 1
37.Os
38.Sh NAME
39.Nm du
40.Nd display disk usage statistics
41.Sh SYNOPSIS
42.Nm du
43.Op Fl H | Fl L | Fl P
44.Op Fl a | s | d Ar depth
45.Op Fl k
46.Op Fl x
47.Op Ar file ...
48.Sh DESCRIPTION
49The
50.Nm du
51utility displays the file system block usage for each file argument
52and for each directory in the file hierarchy rooted in each directory
53argument.
54If no file is specified, the block usage of the hierarchy rooted in
55the current directory is displayed.
56The number of blocks are in the same units as that returned by the
57.Xr stat 2
58system call, i.e. 512-byte blocks.
59If the
60.Fl k
61flag is specified, the number displayed is the number of 1024-byte
62blocks.
63Partial numbers of blocks are rounded up.
64.Pp
65The options are as follows:
66.Bl -tag -width Ds
67.It Fl H
68Symbolic links on the command line are followed.
69(Symbolic links encountered in the tree traversal are not followed.)
70.It Fl L
71All symbolic links are followed.
72.It Fl P
73No symbolic links are followed.
74.It Fl a
75Display an entry for each file in the file hierarchy.
76.It Fl d Ar depth
77Displays all directories only
78.Ar depth
79directories deep.
80.It Fl k
81Report in 1024-byte (1-Kbyte) blocks rather than the default.  Note that
82this overrides the
83.Ev BLOCKSIZE
84setting from the environment.
85.It Fl s
86Display only the grand total for the specified files.
87.It Fl x
88Filesystem mount points are not traversed.
89.El
90.Pp
91.Nm Du
92counts the storage used by symbolic links and not the files they
93reference unless the
94.Fl H
95or
96.Fl L
97option is specified.
98If either the
99.Fl H
100or
101.Fl L
102options are specified, storage used by any symbolic links which are
103followed is not counted or displayed.
104The
105.Fl H ,
106.Fl L
107and
108.Fl P
109options override each other and the command's actions are determined
110by the last one specified.
111.Pp
112Files having multiple hard links are counted (and displayed) a single
113time per
114.Nm du
115execution.
116.Sh ENVIRONMENT VARIABLES
117.Bl -tag -width BLOCKSIZE
118.It Ev BLOCKSIZE
119If the environment variable
120.Ev BLOCKSIZE
121is set, and the
122.Fl k
123option is not specified, the block counts will be displayed in units of that
124size block.
125.El
126.Sh SEE ALSO
127.Xr df 1 ,
128.Xr fts 3 ,
129.Xr symlink 7 ,
130.Xr quot 8
131.Sh HISTORY
132A
133.Nm du
134command appeared in
135.At v1 .
136