file_cmds-220.4.tar.gz
[apple/file_cmds.git] / df / df.1
1 .\" Copyright (c) 1989, 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)df.1        8.3 (Berkeley) 5/8/95
33 .\" $FreeBSD: src/bin/df/df.1,v 1.18.2.7 2002/04/22 22:17:36 keramida Exp $
34 .\"
35 .Dd May 8, 1995
36 .Dt DF 1
37 .Os
38 .Sh NAME
39 .Nm df
40 .Nd display free disk space
41 .Sh SYNOPSIS
42 .Nm df
43 .Oo
44 .Fl b | h | H | k |
45 .Fl m | g | P
46 .Oc
47 .Op Fl ailn
48 .Op Fl t
49 .Op Fl T Ar type
50 .Op Ar file | filesystem ...
51 .Sh LEGACY SYNOPSIS
52 .Nm df
53 .Oo
54 .Fl b | h | H | k |
55 .Fl m | P
56 .Oc
57 .Op Fl ailn
58 .Op Fl t Ar type
59 .Op Fl T Ar type
60 .Op Ar file | filesystem ...
61 .Sh DESCRIPTION
62 The
63 .Nm df
64 utility
65 displays statistics about the amount of free disk space on the specified
66 .Ar filesystem
67 or on the filesystem of which
68 .Ar file
69 is a part.
70 Values are displayed in 512-byte per block counts.
71 If neither a file or a filesystem operand is specified,
72 statistics for all mounted filesystems are displayed
73 (subject to the
74 .Fl t
75 option below).
76 .Pp
77 The following options are available:
78 .Bl -tag -width Ds
79 .It Fl a
80 Show all mount points, including those that were mounted with the MNT_IGNORE
81 flag.
82 .It Fl b
83 Use (the default) 512-byte blocks.
84 This is only useful as a way to override an
85 .Ev BLOCKSIZE
86 specification from the environment.
87 .It Fl g
88 Use 1073741824-byte (1-Gbyte) blocks rather than the default.
89 Note that this overrides the
90 .Ev BLOCKSIZE
91 specification from the environment.
92 .It Fl H
93 "Human-readable" output.  Use unit suffixes: Byte, Kilobyte, Megabyte,
94 Gigabyte, Terabyte and Petabyte in order to reduce the number of
95 digits to three or less using base 10 for sizes.
96 .It Fl h
97 "Human-readable" output.  Use unit suffixes: Byte, Kilobyte, Megabyte,
98 Gigabyte, Terabyte and Petabyte in order to reduce the number of
99 digits to three or less using base 2 for sizes.
100 .It Fl i
101 Include statistics on the number of free inodes. This option is now the default to conform to
102 .St -susv3
103 .It Fl k
104 Use 1024-byte (1-Kbyte) blocks, rather than the default.
105 Note that this overrides the
106 .Ev BLOCKSIZE
107 specification from the environment.
108 .It Fl l
109 Only display information about locally-mounted filesystems.
110 .It Fl m
111 Use 1048576-byte (1-Mbyte) blocks rather than the default.  Note that
112 this overrides the
113 .Ev BLOCKSIZE
114 specification from the environment.
115 .It Fl n
116 Print out the previously obtained statistics from the filesystems.
117 This option should be used if it is possible that one or more
118 filesystems are in a state such that they will not be able to provide
119 statistics without a long delay.
120 When this option is specified,
121 .Nm df
122 will not request new statistics from the filesystems, but will respond
123 with the possibly stale statistics that were previously obtained.
124 .It Fl P
125 Use (the default) 512-byte blocks.
126 This is only useful as a way to override an
127 .Ev BLOCKSIZE
128 specification from the environment.
129 .It Fl T
130 Only print out statistics for filesystems of the specified types.
131 More than one type may be specified in a comma separated list.
132 The list of filesystem types can be prefixed with
133 .Dq no
134 to specify the filesystem types for which action should
135 .Em not
136 be taken.
137 For example, the
138 .Nm df
139 command:
140 .Bd -literal -offset indent
141 df -T nonfs,mfs
142 .Ed
143 .Pp
144 lists all filesystems except those of type
145 .Tn NFS
146 and
147 .Tn MFS .
148 The
149 .Xr lsvfs 1
150 command can be used to find out the types of filesystems
151 that are available on the system.
152 .It Fl t
153 If used with no arguments,
154 this option is a no-op
155 (Mac OS X already prints the total allocated-space figures).
156 If used with an argument, it acts like
157 .Fl T ,
158 but this usage is deprecated and should not be relied upon.
159 .El
160 .Sh ENVIRONMENT
161 .Bl -tag -width BLOCKSIZE
162 .It Ev BLOCKSIZE
163 If the environment variable
164 .Ev BLOCKSIZE
165 is set, the block counts will be displayed in units of that size block.
166 .El
167 .Sh BUGS
168 The
169 .Fl n
170 and
171 .Fl t
172 flags are ignored if a file or filesystem is specified.
173 .Sh LEGACY DESCRIPTION
174 The "capacity" percentage is normally rounded up to the next higher integer.
175 In legacy mode, it is rounded down to the next lower integer.
176 .Pp
177 When the
178 .Fl P
179 option and the
180 .Fl k
181 option are used together,
182 sizes are reported in 1024-blocks.
183 In legacy mode, when the
184 .Fl P
185 option and
186 .Fl k
187 option are used together,
188 the last option specified dictates the reported block size.
189 .Pp
190 The
191 .Fl t
192 option is normally a no-op
193 (Mac OS X already prints the total allocated-space figures).
194 In legacy mode, it is equivalent to
195 .Fl T .
196 .Pp
197 For more information about legacy mode, see
198 .Xr compat 5 .
199 .Sh SEE ALSO
200 .Xr lsvfs 1 ,
201 .Xr quota 1 ,
202 .Xr fstatfs 2 ,
203 .Xr getfsstat 2 ,
204 .Xr statfs 2 ,
205 .Xr getmntinfo 3 ,
206 .Xr compat 5 ,
207 .Xr fstab 5 ,
208 .Xr mount 8 ,
209 .Xr quot 8
210 .Sh HISTORY
211 A
212 .Nm df
213 command appeared in
214 .At v1 .