xref: /dragonfly/usr.bin/du/du.1 (revision 3170ffd7)
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.\" 4. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"	@(#)du.1	8.2 (Berkeley) 4/1/94
29.\" $FreeBSD: src/usr.bin/du/du.1,v 1.15.2.9 2003/02/24 22:37:41 trhodes Exp $
30.\" $DragonFly: src/usr.bin/du/du.1,v 1.2 2003/06/17 04:29:26 dillon Exp $
31.\"
32.Dd April 1, 1994
33.Dt DU 1
34.Os
35.Sh NAME
36.Nm du
37.Nd display disk usage statistics
38.Sh SYNOPSIS
39.Nm
40.Op Fl H | L | P
41.Op Fl I Ar mask
42.Op Fl a | s | d Ar depth
43.Op Fl c
44.Op Fl h | k
45.Op Fl x
46.Op Ar
47.Sh DESCRIPTION
48The
49.Nm
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.
55If the
56.Fl k
57flag is specified, the number of 1024-byte
58blocks used by the file is displayed, otherwise
59.Xr getbsize 3
60is used to determine the preferred block size.
61Partial numbers of blocks are rounded up.
62.Pp
63The options are as follows:
64.Bl -tag -width indent
65.It Fl H
66Symbolic links on the command line are followed, symbolic links in file
67hierarchies are not followed.
68.It Fl L
69Symbolic links on the command line and in file hierarchies are followed.
70.It Fl I Ar mask
71Ignore files and directories matching the specified
72.Ar mask .
73.It Fl P
74No symbolic links are followed.
75This is the default.
76.It Fl a
77Display an entry for each file in a file hierarchy.
78.It Fl h
79"Human-readable" output.  Use unit suffixes: Byte, Kilobyte, Megabyte,
80Gigabyte, Terabyte and Petabyte
81.It Fl r
82Generate messages about directories that cannot be read, files
83that cannot be opened, and so on.  This is the default case.
84This option exists solely for conformance with
85.St -xpg4 .
86.It Fl s
87Display an entry for each specified file.
88(Equivalent to
89.Fl d Li 0 )
90.It Fl d Ar depth
91Display an entry for all files and directories
92.Ar depth
93directories deep.
94.It Fl c
95Display a grand total.
96.It Fl k
97Display block counts in 1024-byte (1-Kbyte) 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