xref: /dragonfly/usr.bin/du/du.1 (revision e4adeac1)
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.\"
31.Dd April 1, 1994
32.Dt DU 1
33.Os
34.Sh NAME
35.Nm du
36.Nd display disk usage statistics
37.Sh SYNOPSIS
38.Nm
39.Op Fl H | L | P
40.Op Fl I Ar mask
41.Op Fl a | s | d Ar depth
42.Op Fl c
43.Op Fl h | k
44.Op Fl x
45.Op Fl t
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 t
91Calculate the apparent size based on the file size (st_size) instead
92of the actual media space used based on st_blkcnt.  This is meant to
93give the caller an idea of how much data is present in actual transmittable
94bytes if it was to be copied or sent elsewhere.
95.Pp
96To make this calculation
97.Nm
98uses st_size and assumes a media blocking granularity of 512 bytes.
99Any holes present in the file are counted as transmittable data.
100.It Fl d Ar depth
101Display an entry for all files and directories
102.Ar depth
103directories deep.
104.It Fl c
105Display a grand total.
106.It Fl k
107Display block counts in 1024-byte (1-Kbyte) blocks.
108.It Fl x
109File system mount points are not traversed.
110.El
111.Pp
112The
113.Nm
114utility counts the storage used by symbolic links and not the files they
115reference unless the
116.Fl H
117or
118.Fl L
119option is specified.
120If either the
121.Fl H
122or
123.Fl L
124options are specified, storage used by any symbolic links which are
125followed is not counted or displayed.
126.Pp
127Files having multiple hard links are counted (and displayed) a single
128time per
129.Nm
130execution.
131.Sh ENVIRONMENT
132.Bl -tag -width BLOCKSIZE
133.It Ev BLOCKSIZE
134If the environment variable
135.Ev BLOCKSIZE
136is set, and the
137.Fl k
138option is not specified, the block counts will be displayed in units of that
139size block.
140If
141.Ev BLOCKSIZE
142is not set, and the
143.Fl k
144option is not specified, the block counts will be displayed in 512-byte blocks.
145.El
146.Sh SEE ALSO
147.Xr df 1 ,
148.Xr fts 3 ,
149.Xr symlink 7 ,
150.Xr quot 8
151.Sh HISTORY
152A
153.Nm
154command appeared in
155.At v1 .
156