xref: /freebsd/bin/df/df.1 (revision edf8578117e8844e02c0121147f45e4609b30680)
1.\"-
2.\" Copyright (c) 1989, 1990, 1993
3.\"	The Regents of the University of California.  All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. Neither the name of the University nor the names of its contributors
14.\"    may be used to endorse or promote products derived from this software
15.\"    without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\"     @(#)df.1	8.3 (Berkeley) 5/8/95
30.\"
31.Dd March 29, 2023
32.Dt DF 1
33.Os
34.Sh NAME
35.Nm df
36.Nd display free disk space
37.Sh SYNOPSIS
38.Nm
39.Op Fl -libxo
40.Op Fl b | g | H | h | k | m | P
41.Op Fl acilnT
42.Op Fl \&,
43.Op Fl t Ar type
44.Op Ar file | filesystem ...
45.Sh DESCRIPTION
46The
47.Nm
48utility
49displays statistics about the amount of free disk space on the specified
50mounted
51.Ar file system
52or on the file system of which
53.Ar file
54is a part.
55By default block counts are displayed with an assumed block size of
56512 bytes.
57If neither a file or a file system operand is specified,
58statistics for all mounted file systems are displayed
59(subject to the
60.Fl t
61option below).
62.Pp
63The following options are available:
64.Bl -tag -width indent
65.It Fl -libxo
66Generate output via
67.Xr libxo 3
68in a selection of different human and machine readable formats.
69See
70.Xr xo_parse_args 3
71for details on command line arguments.
72.It Fl a
73Show all mount points, including those that were mounted with the
74.Dv MNT_IGNORE
75flag.
76This is implied for file systems specified on the command line.
77.It Fl b
78Explicitly use 512 byte blocks, overriding any
79.Ev BLOCKSIZE
80specification from the environment.
81This is the same as the
82.Fl P
83option.
84The
85.Fl k
86option overrides this option.
87.It Fl c
88Display a grand total.
89.It Fl g
90Use 1073741824 byte (1 Gibibyte) blocks rather than the default.
91This overrides any
92.Ev BLOCKSIZE
93specification from the environment.
94.It Fl h
95.Dq Human-readable
96output.
97Use unit suffixes: Byte, Kibibyte, Mebibyte, Gibibyte, Tebibyte and
98Pebibyte (based on powers of 1024) in order to reduce the number of
99digits to four or fewer.
100.It Fl H , Fl Fl si
101Same as
102.Fl h
103but based on powers of 1000.
104.It Fl i
105Include statistics on the number of free and used inodes.
106In conjunction with the
107.Fl h
108or
109.Fl H
110options, the number of inodes is scaled by powers of 1000.
111In case the filesystem has no inodes then
112.Sq -
113is displayed instead of the usage percentage.
114.It Fl k
115Use 1024 byte (1 Kibibyte) blocks rather than the default.
116This overrides the
117.Fl P
118option and any
119.Ev BLOCKSIZE
120specification from the environment.
121.It Fl l
122Select locally-mounted file system for display.
123If used in combination with the
124.Fl t Ar type
125option, file system types will be added or excluded acccording to the
126parameters of that option.
127.It Fl m
128Use 1048576 byte (1 Mebibyte) blocks rather than the default.
129This overrides any
130.Ev BLOCKSIZE
131specification from the environment.
132.It Fl n
133Print out the previously obtained statistics from the file systems.
134This option should be used if it is possible that one or more
135file systems are in a state such that they will not be able to provide
136statistics without a long delay.
137When this option is specified,
138.Nm
139will not request new statistics from the file systems, but will respond
140with the possibly stale statistics that were previously obtained.
141.It Fl P
142Explicitly use 512 byte blocks, overriding any
143.Ev BLOCKSIZE
144specification from the environment.
145This is the same as the
146.Fl b
147option.
148The
149.Fl k
150option overrides this option.
151.It Fl t Ar type
152Select file systems to display.
153More than one type may be specified in a comma separated list.
154The list of file system types can be prefixed with
155.Dq no
156to specify the file system types for which action should
157.Em not
158be taken.
159If used in combination with the
160.Fl l
161option, the parameters of this option will modify the list of
162locally-mounted file systems selected by the
163.Fl l
164option.
165For example, the
166.Nm
167command:
168.Bd -literal -offset indent
169df -t nonfs,nullfs
170.Ed
171.Pp
172lists all file systems except those of type NFS and NULLFS.
173The
174.Xr lsvfs 1
175command can be used to find out the types of file systems
176that are available on the system.
177.It Fl T
178Include file system type.
179.It Fl ,
180(Comma) Print sizes grouped and separated by thousands using the
181non-monetary separator returned by
182.Xr localeconv 3 ,
183typically a comma or period.
184If no locale is set, or the locale does not have a non-monetary separator, this
185option has no effect.
186.El
187.Sh ENVIRONMENT
188.Bl -tag -width BLOCKSIZE
189.It Ev BLOCKSIZE
190Specifies the units in which to report block counts.
191This uses
192.Xr getbsize 3 ,
193which allows units of bytes or numbers scaled with the letters
194.Em k
195(for multiples of 1024 bytes),
196.Em m
197(for multiples of 1048576 bytes) or
198.Em g
199(for gibibytes).
200The allowed range is 512 bytes to 1 GB.
201If the value is outside, it will be set to the appropriate limit.
202.El
203.Sh EXAMPLES
204Show human readable free disk space for all mount points including file system
205type:
206.Bd -literal -offset indent
207$ df -ahT
208Filesystem   Type        Size    Used   Avail Capacity  Mounted on
209/dev/ada1p2  ufs         213G    152G     44G    78%    /
210devfs        devfs       1.0K    1.0K      0B   100%    /dev
211/dev/ada0p1  ufs         1.8T    168G    1.5T    10%    /data
212linsysfs     linsysfs    4.0K    4.0K      0B   100%    /compat/linux/sys
213/dev/da0     msdosfs     7.6G    424M    7.2G     5%    /mnt/usb
214.Ed
215.Pp
216Show previously collected data including inode statistics except for devfs or
217linsysfs file systems.
218Note that the
219.Dq no
220prefix affects all the file systems in the list and the
221.Fl t
222option can be specified only once:
223.Bd -literal -offset indent
224$ df -i -n -t nodevfs,linsysfs
225Filesystem   1K-blocks      Used      Avail Capacity iused     ifree %iused
226Mounted on
227/dev/ada1p2  223235736 159618992   45757888    78% 1657590  27234568    6%   /
228/dev/ada0p1 1892163184 176319420 1564470712    10% 1319710 243300576    1%
229/data
230/dev/da0       7989888    433664    7556224     5%       0         0  100%
231/mnt/usb
232.Ed
233.Pp
234Show human readable information for the file system containing the file
235.Pa /etc/rc.conf :
236.Bd -literal -offset indent
237$ df -h /etc/rc.conf
238Filesystem     Size    Used   Avail Capacity  Mounted on
239/dev/ada1p2    213G    152G     44G    78%    /
240.Ed
241.Pp
242Same as above but specifying some file system:
243.Bd -literal -offset indent
244$ df -h /dev/ada1p2
245Filesystem     Size    Used   Avail Capacity  Mounted on
246/dev/ada1p2    213G    152G     44G    78%    /
247.Ed
248.Sh NOTES
249For non-Unix file systems, the reported values of used and free inodes
250may have a different meaning than that of used and available files and
251directories.
252An example is msdosfs, which in the case of FAT12 or FAT16 file systems
253reports the number of available and free root directory entries instead
254of inodes
255.Po
256where 1 to 21 such directory entries are required to store
257each file or directory name or disk label
258.Pc .
259.Sh SEE ALSO
260.Xr lsvfs 1 ,
261.Xr quota 1 ,
262.Xr fstatfs 2 ,
263.Xr getfsstat 2 ,
264.Xr statfs 2 ,
265.Xr getbsize 3 ,
266.Xr getmntinfo 3 ,
267.Xr libxo 3 ,
268.Xr localeconv 3 ,
269.Xr xo_parse_args 3 ,
270.Xr fstab 5 ,
271.Xr mount 8 ,
272.Xr pstat 8 ,
273.Xr quot 8 ,
274.Xr swapinfo 8
275.Sh STANDARDS
276With the exception of most options,
277the
278.Nm
279utility conforms to
280.St -p1003.1-2004 ,
281which defines only the
282.Fl k , P
283and
284.Fl t
285options.
286.Sh HISTORY
287A
288.Nm
289command appeared in
290.At v1 .
291.Sh BUGS
292The
293.Fl n
294flag is ignored if a file or file system is specified.
295Also, if a mount
296point is not accessible by the user, it is possible that the file system
297information could be stale.
298.Pp
299The
300.Fl b
301and
302.Fl P
303options are identical.
304The former comes from the BSD tradition, and the latter is required
305for
306.St -p1003.1-2004
307conformity.
308