xref: /freebsd/bin/df/df.1 (revision 2ed3236082a4473c1da8f72c1ebc071a7b54321f)
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 October 5, 2020
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
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.
111.It Fl k
112Use 1024 byte (1 Kibibyte) blocks rather than the default.
113This overrides the
114.Fl P
115option and any
116.Ev BLOCKSIZE
117specification from the environment.
118.It Fl l
119Only display information about locally-mounted file systems.
120.It Fl m
121Use 1048576 byte (1 Mebibyte) blocks rather than the default.
122This overrides any
123.Ev BLOCKSIZE
124specification from the environment.
125.It Fl n
126Print out the previously obtained statistics from the file systems.
127This option should be used if it is possible that one or more
128file systems are in a state such that they will not be able to provide
129statistics without a long delay.
130When this option is specified,
131.Nm
132will not request new statistics from the file systems, but will respond
133with the possibly stale statistics that were previously obtained.
134.It Fl P
135Explicitly use 512 byte blocks, overriding any
136.Ev BLOCKSIZE
137specification from the environment.
138This is the same as the
139.Fl b
140option.
141The
142.Fl k
143option overrides this option.
144.It Fl t
145Only print out statistics for file systems of the specified types.
146More than one type may be specified in a comma separated list.
147The list of file system types can be prefixed with
148.Dq no
149to specify the file system types for which action should
150.Em not
151be taken.
152For example, the
153.Nm
154command:
155.Bd -literal -offset indent
156df -t nonfs,nullfs
157.Ed
158.Pp
159lists all file systems except those of type NFS and NULLFS.
160The
161.Xr lsvfs 1
162command can be used to find out the types of file systems
163that are available on the system.
164.It Fl T
165Include file system type.
166.It Fl ,
167(Comma) Print sizes grouped and separated by thousands using the
168non-monetary separator returned by
169.Xr localeconv 3 ,
170typically a comma or period.
171If no locale is set, or the locale does not have a non-monetary separator, this
172option has no effect.
173.El
174.Sh ENVIRONMENT
175.Bl -tag -width BLOCKSIZE
176.It Ev BLOCKSIZE
177Specifies the units in which to report block counts.
178This uses
179.Xr getbsize 3 ,
180which allows units of bytes or numbers scaled with the letters
181.Em k
182(for multiples of 1024 bytes),
183.Em m
184(for multiples of 1048576 bytes) or
185.Em g
186(for gibibytes).
187The allowed range is 512 bytes to 1 GB.
188If the value is outside, it will be set to the appropriate limit.
189.El
190.Sh EXAMPLES
191Show human readable free disk space for all mount points including file system
192type:
193.Bd -literal -offset indent
194$ df -ahT
195Filesystem   Type        Size    Used   Avail Capacity  Mounted on
196/dev/ada1p2  ufs         213G    152G     44G    78%    /
197devfs        devfs       1.0K    1.0K      0B   100%    /dev
198/dev/ada0p1  ufs         1.8T    168G    1.5T    10%    /data
199linsysfs     linsysfs    4.0K    4.0K      0B   100%    /compat/linux/sys
200/dev/da0     msdosfs     7.6G    424M    7.2G     5%    /mnt/usb
201.Ed
202.Pp
203Show previously collected data including inode statistics except for devfs or
204linsysfs file systems.
205Note that the
206.Dq no
207prefix affects all the file systems in the list and the
208.Fl t
209option can be specified only once:
210.Bd -literal -offset indent
211$ df -i -n -t nodevfs,linsysfs
212Filesystem   1K-blocks      Used      Avail Capacity iused     ifree %iused
213Mounted on
214/dev/ada1p2  223235736 159618992   45757888    78% 1657590  27234568    6%   /
215/dev/ada0p1 1892163184 176319420 1564470712    10% 1319710 243300576    1%
216/data
217/dev/da0       7989888    433664    7556224     5%       0         0  100%
218/mnt/usb
219.Ed
220.Pp
221Show human readable information for the file system containing the file
222.Pa /etc/rc.conf
223:
224.Bd -literal -offset indent
225$ df -h /etc/rc.conf
226Filesystem     Size    Used   Avail Capacity  Mounted on
227/dev/ada1p2    213G    152G     44G    78%    /
228.Ed
229.Pp
230Same as above but specifying some file system:
231.Bd -literal -offset indent
232$ df -h /dev/ada1p2
233Filesystem     Size    Used   Avail Capacity  Mounted on
234/dev/ada1p2    213G    152G     44G    78%    /
235.Ed
236.Sh SEE ALSO
237.Xr lsvfs 1 ,
238.Xr quota 1 ,
239.Xr fstatfs 2 ,
240.Xr getfsstat 2 ,
241.Xr statfs 2 ,
242.Xr getbsize 3 ,
243.Xr getmntinfo 3 ,
244.Xr libxo 3 ,
245.Xr localeconv 3 ,
246.Xr xo_parse_args 3 ,
247.Xr fstab 5 ,
248.Xr mount 8 ,
249.Xr pstat 8 ,
250.Xr quot 8 ,
251.Xr swapinfo 8
252.Sh STANDARDS
253With the exception of most options,
254the
255.Nm
256utility conforms to
257.St -p1003.1-2004 ,
258which defines only the
259.Fl k , P
260and
261.Fl t
262options.
263.Sh HISTORY
264A
265.Nm
266command appeared in
267.At v1 .
268.Sh BUGS
269The
270.Fl n
271flag is ignored if a file or file system is specified.
272Also, if a mount
273point is not accessible by the user, it is possible that the file system
274information could be stale.
275.Pp
276The
277.Fl b
278and
279.Fl P
280options are identical.
281The former comes from the BSD tradition, and the latter is required
282for
283.St -p1003.1-2004
284conformity.
285