xref: /dragonfly/usr.bin/du/du.1 (revision b827281d)
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. 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 Fl t
47.Op Ar
48.Sh DESCRIPTION
49The
50.Nm
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.
56If the
57.Fl k
58flag is specified, the number of 1024-byte
59blocks used by the file is displayed, otherwise
60.Xr getbsize 3
61is used to determine the preferred block size.
62Partial numbers of blocks are rounded up.
63.Pp
64The options are as follows:
65.Bl -tag -width indent
66.It Fl H
67Symbolic links on the command line are followed, symbolic links in file
68hierarchies are not followed.
69.It Fl L
70Symbolic links on the command line and in file hierarchies are followed.
71.It Fl I Ar mask
72Ignore files and directories matching the specified
73.Ar mask .
74.It Fl P
75No symbolic links are followed.
76This is the default.
77.It Fl a
78Display an entry for each file in a file hierarchy.
79.It Fl h
80"Human-readable" output.  Use unit suffixes: Byte, Kilobyte, Megabyte,
81Gigabyte, Terabyte and Petabyte
82.It Fl r
83Generate messages about directories that cannot be read, files
84that cannot be opened, and so on.  This is the default case.
85This option exists solely for conformance with
86.St -xpg4 .
87.It Fl s
88Display an entry for each specified file.
89(Equivalent to
90.Fl d Li 0 )
91.It Fl t
92Calculate the apparent size based on the file size (st_size) instead
93of the actual media space used based on st_blkcnt.  This is meant to
94give the caller an idea of how much data is present in actual transmittable
95bytes if it were to be copied or sent elsewhere.
96.Pp
97To make this calculation
98.Nm
99uses st_size and assumes a media blocking granularity of 512 bytes.
100Any holes present in the file are counted as transmittable data.
101.It Fl d Ar depth
102Display an entry for all files and directories
103.Ar depth
104directories deep.
105.It Fl c
106Display a grand total.
107.It Fl k
108Display block counts in 1024-byte (1-Kbyte) blocks.
109.It Fl x
110File system mount points are not traversed.
111.El
112.Pp
113The
114.Nm
115utility counts the storage used by symbolic links and not the files they
116reference unless the
117.Fl H
118or
119.Fl L
120option is specified.
121If either the
122.Fl H
123or
124.Fl L
125options are specified, storage used by any symbolic links which are
126followed is not counted or displayed.
127.Pp
128Files having multiple hard links are counted (and displayed) a single
129time per
130.Nm
131execution.
132.Sh ENVIRONMENT
133.Bl -tag -width BLOCKSIZE
134.It Ev BLOCKSIZE
135If the environment variable
136.Ev BLOCKSIZE
137is set, and the
138.Fl k
139option is not specified, the block counts will be displayed in units of that
140size block.
141If
142.Ev BLOCKSIZE
143is not set, and the
144.Fl k
145option is not specified, the block counts will be displayed in 512-byte blocks.
146.El
147.Sh SEE ALSO
148.Xr df 1 ,
149.Xr fts 3 ,
150.Xr symlink 7 ,
151.Xr quot 8
152.Sh HISTORY
153A
154.Nm
155command appeared in
156.At v1 .
157