xref: /netbsd/usr.bin/du/du.1 (revision c4a72b64)
1.\"	$NetBSD: du.1,v 1.14 2002/09/27 07:18:16 wiz Exp $
2.\"
3.\" Copyright (c) 1990, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"	@(#)du.1	8.2 (Berkeley) 4/1/94
35.\"
36.Dd September 27, 2002
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 | Fl L | Fl P
45.Op Fl a | Fl s
46.Op Fl chkmrx
47.Op Ar file ...
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.
56.Pp
57The options are as follows:
58.Bl -tag -width Ds
59.It Fl H
60Symbolic links on the command line are followed.
61(Symbolic links encountered in the tree traversal are not followed.)
62.It Fl L
63All symbolic links are followed.
64.It Fl P
65No symbolic links are followed.
66.It Fl a
67Display an entry for each file in the file hierarchy.
68.It Fl c
69Display the grand total after all the arguments have been processed.
70.It Fl h
71If the
72.Fl h
73flag is specified, the numbers will be displayed in "human-readable"
74format.
75Use unit suffixes: B (Byte), k (Kilobyte), M (Megabyte), G (Gigabyte),
76T (Terabyte) and P (Petabyte).
77.It Fl k
78By default,
79.Nm
80displays the number of blocks as returned by the
81.Xr stat  2
82system call, i.e. 512-byte blocks.
83If the
84.Fl k
85flag is specified, the number displayed is the number of kilobyte
86(1024 bytes) blocks.
87Partial numbers of blocks are rounded up.
88.It Fl m
89If the
90.Fl m
91flag is specified, the number displayed is the number of megabyte
92(1024*1024 bytes) blocks.
93.It Fl r
94Generate warning messages about directories that cannot be read.
95This is the default behaviour.
96.It Fl s
97Display only the grand total for the specified files.
98.It Fl x
99Filesystem mount points are not traversed.
100.El
101.Pp
102.Nm
103counts the storage used by symbolic links and not the files they
104reference unless the
105.Fl H
106or
107.Fl L
108option is specified.
109If either the
110.Fl H
111or
112.Fl L
113options are specified, storage used by any symbolic links which are
114followed is not counted or displayed.
115The
116.Fl H ,
117.Fl L
118and
119.Fl P
120options override each other and the command's actions are determined
121by the last one specified.
122.Pp
123Files having multiple hard links are counted (and displayed) a single
124time per
125.Nm
126execution.
127.Sh ENVIRONMENT
128.Bl -tag -width BLOCKSIZE
129.It Ev BLOCKSIZE
130If the environment variable
131.Ev BLOCKSIZE
132is set, and the
133.Fl h ,
134.Fl k ,
135and
136.Fl m
137options are not specified, the block counts will be displayed in units of that
138size block.
139.El
140.Sh SEE ALSO
141.Xr df 1 ,
142.Xr fts 3 ,
143.Xr getbsize 3 ,
144.Xr symlink 7 ,
145.Xr quot 8
146.Sh HISTORY
147A
148.Nm
149command appeared in
150.At v6 .
151