Drop main() prototype. Syncs with NetBSD-8
[minix.git] / usr.bin / du / du.1
blob14bb436d60bfce21905cae564cd14c9ae2486c7a
1 .\"     $NetBSD: du.1,v 1.23 2012/05/14 21:14:14 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. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)du.1        8.2 (Berkeley) 4/1/94
31 .\"
32 .Dd May 14, 2012
33 .Dt DU 1
34 .Os
35 .Sh NAME
36 .Nm du
37 .Nd display disk usage statistics
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl H | Fl L | Fl P
41 .Op Fl a | Fl d Ar depth | Fl s
42 .Op Fl cghikmnrx
43 .Op Ar file ...
44 .Sh DESCRIPTION
45 The
46 .Nm
47 utility displays the file system usage for each file argument
48 and for each directory in the file hierarchy rooted in each directory
49 argument.
50 If no file is specified, the block usage of the hierarchy rooted in
51 the current directory is displayed.
52 .Pp
53 The options are as follows:
54 .Bl -tag -width Ds
55 .It Fl H
56 Symbolic links on the command line are followed.
57 (Symbolic links encountered in the tree traversal are not followed.)
58 .It Fl L
59 All symbolic links are followed.
60 .It Fl P
61 No symbolic links are followed.
62 .It Fl a
63 Display an entry for each file in the file hierarchy.
64 .It Fl c
65 Display the grand total after all the arguments have been processed.
66 .It Fl d
67 Display an entry files and directories
68 .Ar depth
69 directories deep.
70 .It Fl g
71 If the
72 .Fl g
73 flag is specified, the number displayed is the number of gigabyte
74 (1024*1024*1024 bytes) blocks.
75 .It Fl h
76 If the
77 .Fl h
78 flag is specified, the numbers will be displayed in "human-readable"
79 format.
80 Use unit suffixes: B (Byte), K (Kilobyte), M (Megabyte), G (Gigabyte),
81 T (Terabyte) and P (Petabyte).
82 .It Fl i
83 Output inode usage instead of blocks.
84 All "human-readable" options are ignored.
85 .It Fl k
86 By default,
87 .Nm
88 displays the number of blocks as returned by the
89 .Xr stat 2
90 system call, i.e. 512-byte blocks.
91 If the
92 .Fl k
93 flag is specified, the number displayed is the number of kilobyte
94 (1024 bytes) blocks.
95 Partial numbers of blocks are rounded up.
96 .It Fl m
97 If the
98 .Fl m
99 flag is specified, the number displayed is the number of megabyte
100 (1024*1024 bytes) blocks.
101 .It Fl n
102 Ignore files and directories with user
103 .Qq nodump
104 flag
105 .Pq Dv UF_NODUMP
106 set.
107 .It Fl r
108 Generate warning messages about directories that cannot be read.
109 This is the default behaviour.
110 .It Fl s
111 Display only the grand total for the specified files.
112 .It Fl x
113 Filesystem mount points are not traversed.
117 counts the storage used by symbolic links and not the files they
118 reference unless the
119 .Fl H
121 .Fl L
122 option is specified.
123 If either the
124 .Fl H
126 .Fl L
127 options are specified, storage used by any symbolic links which are
128 followed is not counted or displayed.
130 .Fl H ,
131 .Fl L
133 .Fl P
134 options override each other and the command's actions are determined
135 by the last one specified.
137 Files having multiple hard links are counted (and displayed) a single
138 time per
140 execution.
141 .Sh ENVIRONMENT
142 .Bl -tag -width BLOCKSIZE
143 .It Ev BLOCKSIZE
144 If the environment variable
145 .Ev BLOCKSIZE
146 is set, and the
147 .Fl g ,
148 .Fl h ,
149 .Fl k ,
151 .Fl m
152 options are not specified, the block counts will be displayed in units of that
153 size block.
155 .Sh EXIT STATUS
156 .Ex -std
157 .Sh SEE ALSO
158 .Xr df 1 ,
159 .Xr chflags 2 ,
160 .Xr fts 3 ,
161 .Xr getbsize 3 ,
162 .Xr symlink 7 ,
163 .Xr quot 8
164 .Sh HISTORY
167 command appeared in
168 .At v6 .