Annotation of src/usr.bin/du/du.1, Revision 1.8
1.8 ! aaron 1: .\" $OpenBSD: du.1,v 1.7 1998/06/22 21:33:56 millert Exp $
1.4 millert 2: .\" $NetBSD: du.1,v 1.6 1996/10/18 07:20:31 thorpej Exp $
1.1 deraadt 3: .\"
4: .\" Copyright (c) 1990, 1993
5: .\" The Regents of the University of California. All rights reserved.
6: .\"
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by the University of
18: .\" California, Berkeley and its contributors.
19: .\" 4. Neither the name of the University nor the names of its contributors
20: .\" may be used to endorse or promote products derived from this software
21: .\" without specific prior written permission.
22: .\"
23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: .\" SUCH DAMAGE.
34: .\"
35: .\" @(#)du.1 8.2 (Berkeley) 4/1/94
36: .\"
1.4 millert 37: .Dd October 4, 1996
1.1 deraadt 38: .Dt DU 1
39: .Os
40: .Sh NAME
41: .Nm du
42: .Nd display disk usage statistics
43: .Sh SYNOPSIS
44: .Nm du
45: .Op Fl H | Fl L | Fl P
46: .Op Fl a | Fl s
1.5 deraadt 47: .Op Fl ckrx
1.1 deraadt 48: .Op Ar file ...
49: .Sh DESCRIPTION
50: The
51: .Nm du
1.8 ! aaron 52: utility displays the file system block usage for each
! 53: .Ar file
! 54: argument
1.1 deraadt 55: and for each directory in the file hierarchy rooted in each directory
1.7 millert 56: argument. Note that the system block usage is usually greater than
57: the actual size of the file.
1.1 deraadt 58: If no file is specified, the block usage of the hierarchy rooted in
59: the current directory is displayed.
60: .Pp
61: The options are as follows:
62: .Bl -tag -width Ds
63: .It Fl H
64: Symbolic links on the command line are followed.
65: (Symbolic links encountered in the tree traversal are not followed.)
66: .It Fl L
67: All symbolic links are followed.
68: .It Fl P
69: No symbolic links are followed.
70: .It Fl a
71: Display an entry for each file in the file hierarchy.
72: .It Fl k
73: By default,
74: .Nm du
75: displays the number of blocks as returned by the
76: .Xr stat 2
77: system call, i.e. 512-byte blocks.
78: If the
79: .Fl k
80: flag is specified, the number displayed is the number of 1024-byte
81: blocks.
82: Partial numbers of blocks are rounded up.
1.4 millert 83: .It Fl c
84: Display the grand total after all the arguments have been processed.
1.1 deraadt 85: .It Fl s
86: Display only the grand total for the specified files.
1.5 deraadt 87: .It Fl r
88: Generate messages about directories that cannot be read, files
89: that cannot be opened, and so on. This is the default case.
90: This option exists solely for conformance with
91: .St -xpg4 .
1.1 deraadt 92: .It Fl x
93: Filesystem mount points are not traversed.
94: .El
95: .Pp
1.8 ! aaron 96: .Nm du
1.1 deraadt 97: counts the storage used by symbolic links and not the files they
98: reference unless the
99: .Fl H
100: or
101: .Fl L
102: option is specified.
103: If either the
104: .Fl H
105: or
106: .Fl L
107: options are specified, storage used by any symbolic links which are
108: followed is not counted or displayed.
109: The
110: .Fl H ,
111: .Fl L
112: and
113: .Fl P
114: options override each other and the command's actions are determined
115: by the last one specified.
116: .Pp
117: Files having multiple hard links are counted (and displayed) a single
118: time per
119: .Nm du
120: execution.
1.6 deraadt 121: .Sh ENVIRONMENT
1.1 deraadt 122: .Bl -tag -width BLOCKSIZE
123: .It Ev BLOCKSIZE
1.2 deraadt 124: If the environment variable
1.1 deraadt 125: .Ev BLOCKSIZE
126: is set, and the
127: .Fl k
128: option is not specified, the block counts will be displayed in units of that
129: size block.
130: .El
131: .Sh SEE ALSO
132: .Xr df 1 ,
133: .Xr fts 3 ,
134: .Xr symlink 7 ,
135: .Xr quot 8
136: .Sh HISTORY
137: A
138: .Nm du
139: command appeared in
140: .At v6 .