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