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