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