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