xref: /freebsd/bin/df/df.1 (revision 57718be8fa0bd5edc11ab9a72e68cc71982939a6)
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.\" 4. 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 January 16, 2014
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 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
50.Ar file system
51or on the file system of which
52.Ar file
53is a part.
54By default block counts are displayed with an assumed block size of
55512 bytes.
56If neither a file or a file system operand is specified,
57statistics for all mounted file systems are displayed
58(subject to the
59.Fl t
60option below).
61.Pp
62The following options are available:
63.Bl -tag -width indent
64.It Fl a
65Show all mount points, including those that were mounted with the
66.Dv MNT_IGNORE
67flag.
68This is implied for file systems specified on the command line.
69.It Fl b
70Explicitly use 512 byte blocks, overriding any
71.Ev BLOCKSIZE
72specification from the environment.
73This is the same as the
74.Fl P
75option.
76The
77.Fl k
78option overrides this option.
79.It Fl c
80Display a grand total.
81.It Fl g
82Use 1073741824 byte (1 Gibibyte) blocks rather than the default.
83This overrides any
84.Ev BLOCKSIZE
85specification from the environment.
86.It Fl h
87.Dq Human-readable
88output.
89Use unit suffixes: Byte, Kibibyte, Mebibyte, Gibibyte, Tebibyte and
90Pebibyte (based on powers of 1024) in order to reduce the number of
91digits to four or fewer.
92.It Fl H
93.Dq Human-readable
94output.
95Use unit suffixes: Byte, Kilobyte, Megabyte,
96Gigabyte, Terabyte and Petabyte (based on powers of 1000) in order to
97reduce the number of
98digits to four or fewer.
99.It Fl i
100Include statistics on the number of free and used inodes.
101In conjunction with the
102.Fl h
103or
104.Fl H
105options, the number of inodes is scaled by powers of 1000.
106.It Fl k
107Use 1024 byte (1 Kibibyte) blocks rather than the default.
108This overrides the
109.Fl P
110option and any
111.Ev BLOCKSIZE
112specification from the environment.
113.It Fl l
114Only display information about locally-mounted file systems.
115.It Fl m
116Use 1048576 byte (1 Mebibyte) blocks rather than the default.
117This overrides any
118.Ev BLOCKSIZE
119specification from the environment.
120.It Fl n
121Print out the previously obtained statistics from the file systems.
122This option should be used if it is possible that one or more
123file systems are in a state such that they will not be able to provide
124statistics without a long delay.
125When this option is specified,
126.Nm
127will not request new statistics from the file systems, but will respond
128with the possibly stale statistics that were previously obtained.
129.It Fl P
130Explicitly use 512 byte blocks, overriding any
131.Ev BLOCKSIZE
132specification from the environment.
133This is the same as the
134.Fl b
135option.
136The
137.Fl k
138option overrides this option.
139.It Fl t
140Only print out statistics for file systems of the specified types.
141More than one type may be specified in a comma separated list.
142The list of file system types can be prefixed with
143.Dq no
144to specify the file system types for which action should
145.Em not
146be taken.
147For example, the
148.Nm
149command:
150.Bd -literal -offset indent
151df -t nonfs,nullfs
152.Ed
153.Pp
154lists all file systems except those of type
155.Tn NFS
156and
157.Tn NULLFS .
158The
159.Xr lsvfs 1
160command can be used to find out the types of file systems
161that are available on the system.
162.It Fl T
163Include file system type.
164.It Fl ,
165(Comma) Print sizes grouped and separated by thousands using the
166non-monetary separator returned by
167.Xr localeconv 3 ,
168typically a comma or period.
169If no locale is set, or the locale does not have a non-monetary separator, this
170option has no effect.
171.El
172.Sh ENVIRONMENT
173.Bl -tag -width BLOCKSIZE
174.It Ev BLOCKSIZE
175Specifies the units in which to report block counts.
176This uses
177.Xr getbsize 3 ,
178which allows units of bytes or numbers scaled with the letters
179.Em k
180(for multiples of 1024 bytes),
181.Em m
182(for multiples of 1048576 bytes) or
183.Em g
184(for gibibytes).
185The allowed range is 512 bytes to 1 GB.
186If the value is outside, it will be set to the appropriate limit.
187.El
188.Sh SEE ALSO
189.Xr lsvfs 1 ,
190.Xr quota 1 ,
191.Xr fstatfs 2 ,
192.Xr getfsstat 2 ,
193.Xr statfs 2 ,
194.Xr getbsize 3 ,
195.Xr getmntinfo 3 ,
196.Xr localeconv 3 ,
197.Xr fstab 5 ,
198.Xr mount 8 ,
199.Xr pstat 8 ,
200.Xr quot 8 ,
201.Xr swapinfo 8
202.Sh STANDARDS
203With the exception of most options,
204the
205.Nm
206utility conforms to
207.St -p1003.1-2004 ,
208which defines only the
209.Fl k , P
210and
211.Fl t
212options.
213.Sh HISTORY
214A
215.Nm
216command appeared in
217.At v1 .
218.Sh BUGS
219The
220.Fl n
221flag is ignored if a file or file system is specified.
222Also, if a mount
223point is not accessible by the user, it is possible that the file system
224information could be stale.
225.Pp
226The
227.Fl b
228and
229.Fl P
230options are identical.
231The former comes from the BSD tradition, and the latter is required
232for
233.St -p1003.1-2004
234conformity.
235