NetBSD/usr.bin/du/du.1

.\"	$NetBSD: du.1,v 1.23 2012/05/14 21:14:14 wiz Exp $
.\"
.\" 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. 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
.\"
.Dd May 14, 2012
.Dt DU 1
.Os
.Sh NAME
.Nm du
.Nd display disk usage statistics
.Sh SYNOPSIS
.Nm
.Op Fl H | Fl L | Fl P
.Op Fl a | Fl d Ar depth | Fl s
.Op Fl cghikmnrx
.Op Ar file ...
.Sh DESCRIPTION
The
.Nm
utility displays the file system 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 Ds
.It Fl H
Symbolic links on the command line are followed.
(Symbolic links encountered in the tree traversal are not followed.)
.It Fl L
All symbolic links are followed.
.It Fl P
No symbolic links are followed.
.It Fl a
Display an entry for each file in the file hierarchy.
.It Fl c
Display the grand total after all the arguments have been processed.
.It Fl d
Display an entry files and directories
.Ar depth
directories deep.
.It Fl g
If the
.Fl g
flag is specified, the number displayed is the number of gigabyte
(1024*1024*1024 bytes) blocks.
.It Fl h
If the
.Fl h
flag is specified, the numbers will be displayed in "human-readable"
format.
Use unit suffixes: B (Byte), K (Kilobyte), M (Megabyte), G (Gigabyte),
T (Terabyte) and P (Petabyte).
.It Fl i
Output inode usage instead of blocks.
All "human-readable" options are ignored.
.It Fl k
By default,
.Nm
displays the number of blocks as returned by the
.Xr stat 2
system call, i.e. 512-byte blocks.
If the
.Fl k
flag is specified, the number displayed is the number of kilobyte
(1024 bytes) blocks.
Partial numbers of blocks are rounded up.
.It Fl m
If the
.Fl m
flag is specified, the number displayed is the number of megabyte
(1024*1024 bytes) blocks.
.It Fl n
Ignore files and directories with user
.Qq nodump
flag
.Pq Dv UF_NODUMP
set.
.It Fl r
Generate warning messages about directories that cannot be read.
This is the default behaviour.
.It Fl s
Display only the grand total for the specified files.
.It Fl x
Filesystem mount points are not traversed.
.El
.Pp
.Nm
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.
The
.Fl H ,
.Fl L
and
.Fl P
options override each other and the command's actions are determined
by the last one specified.
.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 g ,
.Fl h ,
.Fl k ,
and
.Fl m
options are not specified, the block counts will be displayed in units of that
size block.
.El
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr df 1 ,
.Xr chflags 2 ,
.Xr fts 3 ,
.Xr getbsize 3 ,
.Xr symlink 7 ,
.Xr quot 8
.Sh HISTORY
A
.Nm
command appeared in
.At v6 .
Add EXIT STATUS section and bump date. From Bug Hunting. 2012-05-15 01:14:14 +04:00			`.\" $NetBSD: du.1,v 1.23 2012/05/14 21:14:14 wiz Exp $`
Merged with 4.4lite 1995-03-28 21:50:08 +04:00			`.\"`
			`.\" Copyright (c) 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" 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.`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22365, verified by myself. 2003-08-07 15:13:06 +04:00			`.\" 3. Neither the name of the University nor the names of its contributors`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\" 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.`
			`.\"`
Merged with 4.4lite 1995-03-28 21:50:08 +04:00			`.\" @(#)du.1 8.2 (Berkeley) 4/1/94`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
Add EXIT STATUS section and bump date. From Bug Hunting. 2012-05-15 01:14:14 +04:00			`.Dd May 14, 2012`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt DU 1`
Merged with 4.4lite 1995-03-28 21:50:08 +04:00			`.Os`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh NAME`
			`.Nm du`
Merged with 4.4lite 1995-03-28 21:50:08 +04:00			`.Nd display disk usage statistics`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SYNOPSIS`
WARNSify, fix .Nm usage, getopt returns -1 not EOF 1997-10-18 17:21:42 +04:00			`.Nm`
Merged with 4.4lite 1995-03-28 21:50:08 +04:00			`.Op Fl H \| Fl L \| Fl P`
PR/34220: Tyler Spivey: feature request: --max-depth for du Thanks to Matt Fleming for porting the -d feature from FreeBSD! 2006-09-24 03:20:20 +04:00			`.Op Fl a \| Fl d Ar depth \| Fl s`
PR/22405 -- extend du(1) to report inode usage. Patch provided by Jonathan Perkin. OK by wiz@ 2012-03-11 15:23:20 +04:00			`.Op Fl cghikmnrx`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Op Ar file ...`
			`.Sh DESCRIPTION`
			`The`
WARNSify, fix .Nm usage, getopt returns -1 not EOF 1997-10-18 17:21:42 +04:00			`.Nm`
PR/22405 -- extend du(1) to report inode usage. Patch provided by Jonathan Perkin. OK by wiz@ 2012-03-11 15:23:20 +04:00			`utility displays the file system usage for each file argument`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03: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:`
			`.Bl -tag -width Ds`
Merged with 4.4lite 1995-03-28 21:50:08 +04:00			`.It Fl H`
			`Symbolic links on the command line are followed.`
			`(Symbolic links encountered in the tree traversal are not followed.)`
			`.It Fl L`
			`All symbolic links are followed.`
			`.It Fl P`
			`No symbolic links are followed.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.It Fl a`
			`Display an entry for each file in the file hierarchy.`
Sort options. Bump date for -h addition. Begin new sentences on new lines(!). The abbreviation for 'kilo' is still a small 'k', not a capital one. Add -h to the list of options that disable display in default blocksize. 2002-09-27 11:18:16 +04:00			`.It Fl c`
			`Display the grand total after all the arguments have been processed.`
PR/34220: Tyler Spivey: feature request: --max-depth for du Thanks to Matt Fleming for porting the -d feature from FreeBSD! 2006-09-24 03:20:20 +04:00			`.It Fl d`
Remove trailing whitespace. 2006-09-24 11:19:16 +04:00			`Display an entry files and directories`
			`.Ar depth`
PR/34220: Tyler Spivey: feature request: --max-depth for du Thanks to Matt Fleming for porting the -d feature from FreeBSD! 2006-09-24 03:20:20 +04:00			`directories deep.`
add -g for output in gigabytes. 2003-04-18 17:16:50 +04:00			`.It Fl g`
			`If the`
			`.Fl g`
			`flag is specified, the number displayed is the number of gigabyte`
			`(102410241024 bytes) blocks.`
Sort options. Bump date for -h addition. Begin new sentences on new lines(!). The abbreviation for 'kilo' is still a small 'k', not a capital one. Add -h to the list of options that disable display in default blocksize. 2002-09-27 11:18:16 +04:00			`.It Fl h`
			`If the`
			`.Fl h`
			`flag is specified, the numbers will be displayed in "human-readable"`
			`format.`
humanize_number() actually prints 'K' as the suffix for 1024 ('k' is used for 1000). minor whitespace fix. 2003-04-18 17:09:22 +04:00			`Use unit suffixes: B (Byte), K (Kilobyte), M (Megabyte), G (Gigabyte),`
Sort options. Bump date for -h addition. Begin new sentences on new lines(!). The abbreviation for 'kilo' is still a small 'k', not a capital one. Add -h to the list of options that disable display in default blocksize. 2002-09-27 11:18:16 +04:00			`T (Terabyte) and P (Petabyte).`
PR/22405 -- extend du(1) to report inode usage. Patch provided by Jonathan Perkin. OK by wiz@ 2012-03-11 15:23:20 +04:00			`.It Fl i`
			`Output inode usage instead of blocks.`
			`All "human-readable" options are ignored.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.It Fl k`
			`By default,`
WARNSify, fix .Nm usage, getopt returns -1 not EOF 1997-10-18 17:21:42 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`displays the number of blocks as returned by the`
humanize_number() actually prints 'K' as the suffix for 1024 ('k' is used for 1000). minor whitespace fix. 2003-04-18 17:09:22 +04:00			`.Xr stat 2`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`system call, i.e. 512-byte blocks.`
			`If the`
			`.Fl k`
Option similar to -k, only to use megabyte (1024**2) as display unit. Patch contributed by Chris Pinnock <C.J.E.Pinnock@qmw.ac.uk> in PR 11848. 2000-12-30 19:00:33 +03:00			`flag is specified, the number displayed is the number of kilobyte`
Sort options. Bump date for -h addition. Begin new sentences on new lines(!). The abbreviation for 'kilo' is still a small 'k', not a capital one. Add -h to the list of options that disable display in default blocksize. 2002-09-27 11:18:16 +04:00			`(1024 bytes) blocks.`
			`Partial numbers of blocks are rounded up.`
Option similar to -k, only to use megabyte (1024**2) as display unit. Patch contributed by Chris Pinnock <C.J.E.Pinnock@qmw.ac.uk> in PR 11848. 2000-12-30 19:00:33 +03:00			`.It Fl m`
Whitespace cleanup. 2001-12-01 19:43:07 +03:00			`If the`
Option similar to -k, only to use megabyte (1024**2) as display unit. Patch contributed by Chris Pinnock <C.J.E.Pinnock@qmw.ac.uk> in PR 11848. 2000-12-30 19:00:33 +03:00			`.Fl m`
Whitespace cleanup. 2001-12-01 19:43:07 +03:00			`flag is specified, the number displayed is the number of megabyte`
Option similar to -k, only to use megabyte (1024**2) as display unit. Patch contributed by Chris Pinnock <C.J.E.Pinnock@qmw.ac.uk> in PR 11848. 2000-12-30 19:00:33 +03:00			`(1024*1024 bytes) blocks.`
Add a "-n" flag that will ignore files/directories with the "nodump" flag set. Useful when used in conjunction with "dump -h" to size dumps. 2004-05-17 05:56:19 +04:00			`.It Fl n`
Use more macros. 2004-05-17 19:36:17 +04:00			`Ignore files and directories with user`
			`.Qq nodump`
			`flag`
			`.Pq Dv UF_NODUMP`
			`set.`
Add an `-r' flag (which is a no-op) to meet XPG4.2 requirements. 1998-02-15 20:08:17 +03:00			`.It Fl r`
			`Generate warning messages about directories that cannot be read.`
			`This is the default behaviour.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.It Fl s`
			`Display only the grand total for the specified files.`
			`.It Fl x`
			`Filesystem mount points are not traversed.`
			`.El`
			`.Pp`
WARNSify, fix .Nm usage, getopt returns -1 not EOF 1997-10-18 17:21:42 +04:00			`.Nm`
Merged with 4.4lite 1995-03-28 21:50:08 +04:00			`counts the storage used by symbolic links and not the files they`
			`reference unless the`
			`.Fl H`
Whitespace cleanup. 2001-12-01 19:43:07 +03:00			`or`
			`.Fl L`
			`option is specified.`
Merged with 4.4lite 1995-03-28 21:50:08 +04:00			`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.`
			`The`
			`.Fl H ,`
			`.Fl L`
			`and`
			`.Fl P`
			`options override each other and the command's actions are determined`
			`by the last one specified.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Pp`
			`Files having multiple hard links are counted (and displayed) a single`
			`time per`
WARNSify, fix .Nm usage, getopt returns -1 not EOF 1997-10-18 17:21:42 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`execution.`
Use standard headers. 2001-12-01 22:03:31 +03:00			`.Sh ENVIRONMENT`
Incorporate new version using getbsize(), with -k flag added. 1993-08-06 21:05:08 +04:00			`.Bl -tag -width BLOCKSIZE`
			`.It Ev BLOCKSIZE`
merge in change accidently made to release branch 1996-01-04 21:25:47 +03:00			`If the environment variable`
Incorporate new version using getbsize(), with -k flag added. 1993-08-06 21:05:08 +04:00			`.Ev BLOCKSIZE`
Whitespace cleanup. 2001-12-01 19:43:07 +03:00			`is set, and the`
add -g for output in gigabytes. 2003-04-18 17:16:50 +04:00			`.Fl g ,`
Sort options. Bump date for -h addition. Begin new sentences on new lines(!). The abbreviation for 'kilo' is still a small 'k', not a capital one. Add -h to the list of options that disable display in default blocksize. 2002-09-27 11:18:16 +04:00			`.Fl h ,`
			`.Fl k ,`
Option similar to -k, only to use megabyte (1024**2) as display unit. Patch contributed by Chris Pinnock <C.J.E.Pinnock@qmw.ac.uk> in PR 11848. 2000-12-30 19:00:33 +03:00			`and`
			`.Fl m`
			`options are not specified, the block counts will be displayed in units of that`
Incorporate new version using getbsize(), with -k flag added. 1993-08-06 21:05:08 +04:00			`size block.`
			`.El`
Add EXIT STATUS section and bump date. From Bug Hunting. 2012-05-15 01:14:14 +04:00			`.Sh EXIT STATUS`
			`.Ex -std`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SEE ALSO`
			`.Xr df 1 ,`
Add a "-n" flag that will ignore files/directories with the "nodump" flag set. Useful when used in conjunction with "dump -h" to size dumps. 2004-05-17 05:56:19 +04:00			`.Xr chflags 2 ,`
Merged with 4.4lite 1995-03-28 21:50:08 +04:00			`.Xr fts 3 ,`
Xref getbsize(3). 2001-07-08 19:34:13 +04:00			`.Xr getbsize 3 ,`
Merged with 4.4lite 1995-03-28 21:50:08 +04:00			`.Xr symlink 7 ,`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Xr quot 8`
			`.Sh HISTORY`
			`A`
WARNSify, fix .Nm usage, getopt returns -1 not EOF 1997-10-18 17:21:42 +04:00			`.Nm`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`command appeared in`
			`.At v6 .`