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