Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / du / du.1
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 .\" $FreeBSD: src/usr.bin/du/du.1,v 1.15.2.9 2003/02/24 22:37:41 trhodes Exp $
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
43 .Op Fl H | L | P
44 .Op Fl I Ar mask
45 .Op Fl a | s | d Ar depth
46 .Op Fl c
47 .Op Fl h | k
48 .Op Fl x
49 .Op Ar
50 .Sh DESCRIPTION
51 The
52 .Nm
53 utility displays the file system block usage for each file argument
54 and for each directory in the file hierarchy rooted in each directory
55 argument.
56 If no file is specified, the block usage of the hierarchy rooted in
57 the current directory is displayed.
58 If the
59 .Fl k
60 flag is specified, the number of 1024-byte
61 blocks used by the file is displayed, otherwise
62 .Xr getbsize 3
63 is used to determine the preferred block size.
64 Partial numbers of blocks are rounded up.
65 .Pp
66 The options are as follows:
67 .Bl -tag -width indent
68 .It Fl H
69 Symbolic links on the command line are followed, symbolic links in file
70 hierarchies are not followed.
71 .It Fl L
72 Symbolic links on the command line and in file hierarchies are followed.
73 .It Fl I Ar mask
74 Ignore files and directories matching the specified
75 .Ar mask .
76 .It Fl P
77 No symbolic links are followed.
78 This is the default.
79 .It Fl a
80 Display an entry for each file in a file hierarchy.
81 .It Fl h
82 "Human-readable" output.  Use unit suffixes: Byte, Kilobyte, Megabyte,
83 Gigabyte, Terabyte and Petabyte
84 .It Fl r
85 Generate messages about directories that cannot be read, files
86 that cannot be opened, and so on.  This is the default case.
87 This option exists solely for conformance with
88 .St -xpg4 .
89 .It Fl s
90 Display an entry for each specified file.
91 (Equivalent to
92 .Fl d Li 0 )
93 .It Fl d Ar depth
94 Display an entry for all files and directories
95 .Ar depth
96 directories deep.
97 .It Fl c
98 Display a grand total.
99 .It Fl k
100 Display block counts in 1024-byte (1-Kbyte) blocks.
101 .It Fl x
102 File system mount points are not traversed.
103 .El
104 .Pp
105 The
106 .Nm
107 utility counts the storage used by symbolic links and not the files they
108 reference unless the
109 .Fl H
110 or
111 .Fl L
112 option is specified.
113 If either the
114 .Fl H
115 or
116 .Fl L
117 options are specified, storage used by any symbolic links which are
118 followed is not counted or displayed.
119 .Pp
120 Files having multiple hard links are counted (and displayed) a single
121 time per
122 .Nm
123 execution.
124 .Sh ENVIRONMENT
125 .Bl -tag -width BLOCKSIZE
126 .It Ev BLOCKSIZE
127 If the environment variable
128 .Ev BLOCKSIZE
129 is set, and the
130 .Fl k
131 option is not specified, the block counts will be displayed in units of that
132 size block.
133 If
134 .Ev BLOCKSIZE
135 is not set, and the
136 .Fl k
137 option is not specified, the block counts will be displayed in 512-byte blocks.
138 .El
139 .Sh SEE ALSO
140 .Xr df 1 ,
141 .Xr fts 3 ,
142 .Xr symlink 7 ,
143 .Xr quot 8
144 .Sh HISTORY
145 A
146 .Nm
147 command appeared in
148 .At v1 .