file_cmds-45.tar.gz
[apple/file_cmds.git] / du / du.1
1 .\"     $NetBSD: du.1,v 1.8 1998/02/15 17:08:17 kleink 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 October 4, 1996
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 ckrx
47 .Op Ar file ...
48 .Sh DESCRIPTION
49 The
50 .Nm
51 utility displays the file system block usage for each file argument
52 and for each directory in the file hierarchy rooted in each directory
53 argument.
54 If no file is specified, the block usage of the hierarchy rooted in
55 the current directory is displayed.
56 .Pp
57 The options are as follows:
58 .Bl -tag -width Ds
59 .It Fl H
60 Symbolic links on the command line are followed.
61 (Symbolic links encountered in the tree traversal are not followed.)
62 .It Fl L
63 All symbolic links are followed.
64 .It Fl P
65 No symbolic links are followed.
66 .It Fl a
67 Display an entry for each file in the file hierarchy.
68 .It Fl k
69 By default,
70 .Nm
71 displays the number of blocks as returned by the
72 .Xr stat  2
73 system call, i.e. 512-byte blocks.
74 If the
75 .Fl k
76 flag is specified, the number displayed is the number of 1024-byte
77 blocks.
78 Partial numbers of blocks are rounded up.
79 .It Fl c
80 Display the grand total after all the arguments have been processed.
81 .It Fl r
82 Generate warning messages about directories that cannot be read.
83 This is the default behaviour.
84 .It Fl s
85 Display only the grand total for the specified files.
86 .It Fl x
87 Filesystem mount points are not traversed.
88 .El
89 .Pp
90 .Nm
91 counts the storage used by symbolic links and not the files they
92 reference unless the
93 .Fl H
94 or 
95 .Fl L 
96 option is specified.  
97 If either the
98 .Fl H
99 or
100 .Fl L
101 options are specified, storage used by any symbolic links which are
102 followed is not counted or displayed.
103 The
104 .Fl H ,
105 .Fl L
106 and
107 .Fl P
108 options override each other and the command's actions are determined
109 by the last one specified.
110 .Pp
111 Files having multiple hard links are counted (and displayed) a single
112 time per
113 .Nm
114 execution.
115 .Sh ENVIRONMENT VARIABLES
116 .Bl -tag -width BLOCKSIZE
117 .It Ev BLOCKSIZE
118 If the environment variable
119 .Ev BLOCKSIZE
120 is set, and the 
121 .Fl k
122 option is not specified, the block counts will be displayed in units of that
123 size block.
124 .El
125 .Sh SEE ALSO
126 .Xr df 1 ,
127 .Xr fts 3 ,
128 .Xr symlink 7 ,
129 .Xr quot 8
130 .Sh HISTORY
131 A
132 .Nm
133 command appeared in
134 .At v6 .