freebsd-skq/usr.bin/du/du.1

.\" Copyright (c) 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)du.1	8.2 (Berkeley) 4/1/94
.\" $FreeBSD$
.\"
.Dd June 2, 2004
.Dt DU 1
.Os
.Sh NAME
.Nm du
.Nd display disk usage statistics
.Sh SYNOPSIS
.Nm
.Op Fl H | L | P
.Op Fl I Ar mask
.Op Fl a | s | d Ar depth
.Op Fl c
.Op Fl h | k | m
.Op Fl x
.Op Ar
.Sh DESCRIPTION
The
.Nm
utility displays the file system block usage for each file argument
and for each directory in the file hierarchy rooted in each directory
argument.
If no file is specified, the block usage of the hierarchy rooted in
the current directory is displayed.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl H
Symbolic links on the command line are followed, symbolic links in file
hierarchies are not followed.
.It Fl L
Symbolic links on the command line and in file hierarchies are followed.
.It Fl I Ar mask
Ignore files and directories matching the specified
.Ar mask .
.It Fl P
No symbolic links are followed.
This is the default.
.It Fl a
Display an entry for each file in a file hierarchy.
.It Fl h
"Human-readable" output.
Use unit suffixes: Byte, Kilobyte, Megabyte,
Gigabyte, Terabyte and Petabyte
.It Fl r
Generate messages about directories that cannot be read, files
that cannot be opened, and so on.
This is the default case.
This option exists solely for conformance with
.St -xpg4 .
.It Fl s
Display an entry for each specified file.
(Equivalent to
.Fl d Li 0 )
.It Fl d Ar depth
Display an entry for all files and directories
.Ar depth
directories deep.
.It Fl c
Display a grand total.
.It Fl k
Display block counts in 1024-byte (1-Kbyte) blocks.
.It Fl m
Display block counts in 1048576-byte (1-Mbyte) blocks.
.It Fl x
File system mount points are not traversed.
.El
.Pp
The
.Nm
utility counts the storage used by symbolic links and not the files they
reference unless the
.Fl H
or
.Fl L
option is specified.
If either the
.Fl H
or
.Fl L
options are specified, storage used by any symbolic links which are
followed is not counted or displayed.
.Pp
Files having multiple hard links are counted (and displayed) a single
time per
.Nm
execution.
.Sh ENVIRONMENT
.Bl -tag -width BLOCKSIZE
.It Ev BLOCKSIZE
If the environment variable
.Ev BLOCKSIZE
is set, and the
.Fl k
option is not specified, the block counts will be displayed in units of that
size block.
If
.Ev BLOCKSIZE
is not set, and the
.Fl k
option is not specified, the block counts will be displayed in 512-byte blocks.
.El
.Sh SEE ALSO
.Xr df 1 ,
.Xr fts 3 ,
.Xr symlink 7 ,
.Xr quot 8
.Sh HISTORY
A
.Nm
command appeared in
.At v1 .
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)du.1 8.2 (Berkeley) 4/1/94`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
typos. Pointed out by: ru 2004-06-02 07:31:11 +00:00			`.Dd June 2, 2004`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Dt DU 1`
			`.Os`
			`.Sh NAME`
			`.Nm du`
			`.Nd display disk usage statistics`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Make it clear that -P is the default. PR: docs/27629 2001-05-25 07:32:58 +00:00			`.Op Fl H \| L \| P`
Add '-I mask' cmdline flag to ignore/skip files and subdirectories matching a specified shell-glob mask. Reviewed by: no serious objections on -arch and -audit over the last few months MFC after: 1 month 2001-06-13 06:38:58 +00:00			`.Op Fl I Ar mask`
Add a 'depth (-d#)' flag to du patched (context diff), compiled (w/ -Wall) and tested Submitted by: John-Mark Gurney <jmg@nike.efn.org> 1996-10-23 06:53:57 +00:00			`.Op Fl a \| s \| d Ar depth`
* add a -c option which displays the grand total of all files counted. * re-word parts of the man page which I felt were badly worded or ambiguous. * change the behaviour of argument processing so that when more than one of the -P, -H and -L options are specified it will print an error message, rather than choosing the last option specified, this behaviour is more logical and consistent with other utilities. * change the behaviour of argument processing so that negative arguments to the -d option are not allowed. PR: 5388 Submitted by: Niall Smart <rotel@indigo.ie> 1997-12-29 20:56:21 +00:00			`.Op Fl c`
Give du(1) a -m option to report in megabytes. Submitted by: Vasily Korytov <deskpot@msk.yell.ru> PR: 66976 2004-06-02 07:09:34 +00:00			`.Op Fl h \| k \| m`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Fl x`
Use warnx(), -Wall cleaning and remove unused #include Better use of .Nm and .Ar 2000-03-26 14:21:57 +00:00			`.Op Ar`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh DESCRIPTION`
			`The`
Use warnx(), -Wall cleaning and remove unused #include Better use of .Nm and .Ar 2000-03-26 14:21:57 +00:00			`.Nm`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`utility displays the file system block usage for each file argument`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`and for each directory in the file hierarchy rooted in each directory`
			`argument.`
			`If no file is specified, the block usage of the hierarchy rooted in`
			`the current directory is displayed.`
			`.Pp`
			`The options are as follows:`
Use warnx(), -Wall cleaning and remove unused #include Better use of .Nm and .Ar 2000-03-26 14:21:57 +00:00			`.Bl -tag -width indent`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl H`
* add a -c option which displays the grand total of all files counted. * re-word parts of the man page which I felt were badly worded or ambiguous. * change the behaviour of argument processing so that when more than one of the -P, -H and -L options are specified it will print an error message, rather than choosing the last option specified, this behaviour is more logical and consistent with other utilities. * change the behaviour of argument processing so that negative arguments to the -d option are not allowed. PR: 5388 Submitted by: Niall Smart <rotel@indigo.ie> 1997-12-29 20:56:21 +00:00			`Symbolic links on the command line are followed, symbolic links in file`
			`hierarchies are not followed.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl L`
* add a -c option which displays the grand total of all files counted. * re-word parts of the man page which I felt were badly worded or ambiguous. * change the behaviour of argument processing so that when more than one of the -P, -H and -L options are specified it will print an error message, rather than choosing the last option specified, this behaviour is more logical and consistent with other utilities. * change the behaviour of argument processing so that negative arguments to the -d option are not allowed. PR: 5388 Submitted by: Niall Smart <rotel@indigo.ie> 1997-12-29 20:56:21 +00:00			`Symbolic links on the command line and in file hierarchies are followed.`
Add '-I mask' cmdline flag to ignore/skip files and subdirectories matching a specified shell-glob mask. Reviewed by: no serious objections on -arch and -audit over the last few months MFC after: 1 month 2001-06-13 06:38:58 +00:00			`.It Fl I Ar mask`
			`Ignore files and directories matching the specified`
			`.Ar mask .`
Make it clear that -P is the default. PR: docs/27629 2001-05-25 07:32:58 +00:00			`.It Fl P`
			`No symbolic links are followed.`
			`This is the default.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl a`
* add a -c option which displays the grand total of all files counted. * re-word parts of the man page which I felt were badly worded or ambiguous. * change the behaviour of argument processing so that when more than one of the -P, -H and -L options are specified it will print an error message, rather than choosing the last option specified, this behaviour is more logical and consistent with other utilities. * change the behaviour of argument processing so that negative arguments to the -d option are not allowed. PR: 5388 Submitted by: Niall Smart <rotel@indigo.ie> 1997-12-29 20:56:21 +00:00			`Display an entry for each file in a file hierarchy.`
Add human-readable output flag, -h Reviewed by: obrien 2000-01-25 17:46:59 +00:00			`.It Fl h`
Mechanically kill hard sentence breaks. 2004-07-02 22:22:35 +00:00			`"Human-readable" output.`
			`Use unit suffixes: Byte, Kilobyte, Megabyte,`
Add human-readable output flag, -h Reviewed by: obrien 2000-01-25 17:46:59 +00:00			`Gigabyte, Terabyte and Petabyte`
			`.It Fl r`
			`Generate messages about directories that cannot be read, files`
Mechanically kill hard sentence breaks. 2004-07-02 22:22:35 +00:00			`that cannot be opened, and so on.`
			`This is the default case.`
Add human-readable output flag, -h Reviewed by: obrien 2000-01-25 17:46:59 +00:00			`This option exists solely for conformance with`
			`.St -xpg4 .`
* add a -c option which displays the grand total of all files counted. * re-word parts of the man page which I felt were badly worded or ambiguous. * change the behaviour of argument processing so that when more than one of the -P, -H and -L options are specified it will print an error message, rather than choosing the last option specified, this behaviour is more logical and consistent with other utilities. * change the behaviour of argument processing so that negative arguments to the -d option are not allowed. PR: 5388 Submitted by: Niall Smart <rotel@indigo.ie> 1997-12-29 20:56:21 +00:00			`.It Fl s`
Remove more single-space hard sentence breaks. 2000-03-02 14:54:02 +00:00			`Display an entry for each specified file.`
			`(Equivalent to`
mdoc(7) police: join split punctuation to macro calls. 2001-08-10 17:35:21 +00:00			`.Fl d Li 0 )`
Add a 'depth (-d#)' flag to du patched (context diff), compiled (w/ -Wall) and tested Submitted by: John-Mark Gurney <jmg@nike.efn.org> 1996-10-23 06:53:57 +00:00			`.It Fl d Ar depth`
* add a -c option which displays the grand total of all files counted. * re-word parts of the man page which I felt were badly worded or ambiguous. * change the behaviour of argument processing so that when more than one of the -P, -H and -L options are specified it will print an error message, rather than choosing the last option specified, this behaviour is more logical and consistent with other utilities. * change the behaviour of argument processing so that negative arguments to the -d option are not allowed. PR: 5388 Submitted by: Niall Smart <rotel@indigo.ie> 1997-12-29 20:56:21 +00:00			`Display an entry for all files and directories`
Add a 'depth (-d#)' flag to du patched (context diff), compiled (w/ -Wall) and tested Submitted by: John-Mark Gurney <jmg@nike.efn.org> 1996-10-23 06:53:57 +00:00			`.Ar depth`
			`directories deep.`
* add a -c option which displays the grand total of all files counted. * re-word parts of the man page which I felt were badly worded or ambiguous. * change the behaviour of argument processing so that when more than one of the -P, -H and -L options are specified it will print an error message, rather than choosing the last option specified, this behaviour is more logical and consistent with other utilities. * change the behaviour of argument processing so that negative arguments to the -d option are not allowed. PR: 5388 Submitted by: Niall Smart <rotel@indigo.ie> 1997-12-29 20:56:21 +00:00			`.It Fl c`
			`Display a grand total.`
Gimme my `-k' option back! 1994-08-10 19:25:34 +00:00			`.It Fl k`
* add a -c option which displays the grand total of all files counted. * re-word parts of the man page which I felt were badly worded or ambiguous. * change the behaviour of argument processing so that when more than one of the -P, -H and -L options are specified it will print an error message, rather than choosing the last option specified, this behaviour is more logical and consistent with other utilities. * change the behaviour of argument processing so that negative arguments to the -d option are not allowed. PR: 5388 Submitted by: Niall Smart <rotel@indigo.ie> 1997-12-29 20:56:21 +00:00			`Display block counts in 1024-byte (1-Kbyte) blocks.`
Give du(1) a -m option to report in megabytes. Submitted by: Vasily Korytov <deskpot@msk.yell.ru> PR: 66976 2004-06-02 07:09:34 +00:00			`.It Fl m`
typos. Pointed out by: ru 2004-06-02 07:31:11 +00:00			`Display block counts in 1048576-byte (1-Mbyte) blocks.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.It Fl x`
Uniformly refer to a file system as "file system". Approved by: re 2002-12-12 17:26:04 +00:00			`File system mount points are not traversed.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.El`
			`.Pp`
Use `The .Nm utility' 2002-04-19 23:44:58 +00:00			`The`
			`.Nm`
			`utility counts the storage used by symbolic links and not the files they`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`reference unless the`
			`.Fl H`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`or`
			`.Fl L`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`option is specified.`
			`If either the`
			`.Fl H`
			`or`
			`.Fl L`
			`options are specified, storage used by any symbolic links which are`
			`followed is not counted or displayed.`
			`.Pp`
			`Files having multiple hard links are counted (and displayed) a single`
			`time per`
Use warnx(), -Wall cleaning and remove unused #include Better use of .Nm and .Ar 2000-03-26 14:21:57 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`execution.`
.Sh ENVIRONMENT VARIABLES -> .Sh ENVIRONMENT PR: 6599 Reviewed by: phk Submitted by: Josh Gilliam <josh@quick.net> 1998-05-13 07:57:49 +00:00			`.Sh ENVIRONMENT`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Bl -tag -width BLOCKSIZE`
			`.It Ev BLOCKSIZE`
Document -k flag. 1997-06-30 06:50:07 +00:00			`If the environment variable`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Ev BLOCKSIZE`
Document -k flag. 1997-06-30 06:50:07 +00:00			`is set, and the`
			`.Fl k`
Backed out part of the revision 1.10. BLOCKSIZE could specify arbitrary block sizes, not exactly 1K blocks. 2000-10-16 10:00:50 +00:00			`option is not specified, the block counts will be displayed in units of that`
			`size block.`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 12:20:22 +00:00			`If`
* add a -c option which displays the grand total of all files counted. * re-word parts of the man page which I felt were badly worded or ambiguous. * change the behaviour of argument processing so that when more than one of the -P, -H and -L options are specified it will print an error message, rather than choosing the last option specified, this behaviour is more logical and consistent with other utilities. * change the behaviour of argument processing so that negative arguments to the -d option are not allowed. PR: 5388 Submitted by: Niall Smart <rotel@indigo.ie> 1997-12-29 20:56:21 +00:00			`.Ev BLOCKSIZE`
			`is not set, and the`
			`.Fl k`
			`option is not specified, the block counts will be displayed in 512-byte blocks.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr df 1 ,`
			`.Xr fts 3 ,`
			`.Xr symlink 7 ,`
Restore the reference to quot(8). 1995-08-13 09:39:23 +00:00			`.Xr quot 8`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh HISTORY`
			`A`
Use warnx(), -Wall cleaning and remove unused #include Better use of .Nm and .Ar 2000-03-26 14:21:57 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`command appeared in`
[HISTORY] command appeared in Version 1 AT&T UNIX Obtained from: A Quarter Century of UNIX, Peter H. Salus, page 41 1996-08-29 18:06:19 +00:00			`.At v1 .`