xref: /freebsd/bin/df/df.1 (revision 5bb3134a8c21cb87b30e135ef168483f0333dabb)
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
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.
112.It Fl k
113Use 1024 byte (1 Kibibyte) blocks rather than the default.
114This overrides the
115.Fl P
116option and any
117.Ev BLOCKSIZE
118specification from the environment.
119.It Fl l
120Only display information about locally-mounted file systems.
121.It Fl m
122Use 1048576 byte (1 Mebibyte) blocks rather than the default.
123This overrides any
124.Ev BLOCKSIZE
125specification from the environment.
126.It Fl n
127Print out the previously obtained statistics from the file systems.
128This option should be used if it is possible that one or more
129file systems are in a state such that they will not be able to provide
130statistics without a long delay.
131When this option is specified,
132.Nm
133will not request new statistics from the file systems, but will respond
134with the possibly stale statistics that were previously obtained.
135.It Fl P
136Explicitly use 512 byte blocks, overriding any
137.Ev BLOCKSIZE
138specification from the environment.
139This is the same as the
140.Fl b
141option.
142The
143.Fl k
144option overrides this option.
145.It Fl t
146Only print out statistics for file systems of the specified types.
147More than one type may be specified in a comma separated list.
148The list of file system types can be prefixed with
149.Dq no
150to specify the file system types for which action should
151.Em not
152be taken.
153For example, the
154.Nm
155command:
156.Bd -literal -offset indent
157df -t nonfs,nullfs
158.Ed
159.Pp
160lists all file systems except those of type NFS and NULLFS.
161The
162.Xr lsvfs 1
163command can be used to find out the types of file systems
164that are available on the system.
165.It Fl T
166Include file system type.
167.It Fl ,
168(Comma) Print sizes grouped and separated by thousands using the
169non-monetary separator returned by
170.Xr localeconv 3 ,
171typically a comma or period.
172If no locale is set, or the locale does not have a non-monetary separator, this
173option has no effect.
174.El
175.Sh ENVIRONMENT
176.Bl -tag -width BLOCKSIZE
177.It Ev BLOCKSIZE
178Specifies the units in which to report block counts.
179This uses
180.Xr getbsize 3 ,
181which allows units of bytes or numbers scaled with the letters
182.Em k
183(for multiples of 1024 bytes),
184.Em m
185(for multiples of 1048576 bytes) or
186.Em g
187(for gibibytes).
188The allowed range is 512 bytes to 1 GB.
189If the value is outside, it will be set to the appropriate limit.
190.El
191.Sh EXAMPLES
192Show human readable free disk space for all mount points including file system
193type:
194.Bd -literal -offset indent
195$ df -ahT
196Filesystem   Type        Size    Used   Avail Capacity  Mounted on
197/dev/ada1p2  ufs         213G    152G     44G    78%    /
198devfs        devfs       1.0K    1.0K      0B   100%    /dev
199/dev/ada0p1  ufs         1.8T    168G    1.5T    10%    /data
200linsysfs     linsysfs    4.0K    4.0K      0B   100%    /compat/linux/sys
201/dev/da0     msdosfs     7.6G    424M    7.2G     5%    /mnt/usb
202.Ed
203.Pp
204Show previously collected data including inode statistics except for devfs or
205linsysfs file systems.
206Note that the
207.Dq no
208prefix affects all the file systems in the list and the
209.Fl t
210option can be specified only once:
211.Bd -literal -offset indent
212$ df -i -n -t nodevfs,linsysfs
213Filesystem   1K-blocks      Used      Avail Capacity iused     ifree %iused
214Mounted on
215/dev/ada1p2  223235736 159618992   45757888    78% 1657590  27234568    6%   /
216/dev/ada0p1 1892163184 176319420 1564470712    10% 1319710 243300576    1%
217/data
218/dev/da0       7989888    433664    7556224     5%       0         0  100%
219/mnt/usb
220.Ed
221.Pp
222Show human readable information for the file system containing the file
223.Pa /etc/rc.conf :
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