bin/df/df.1

.\"-
.\" Copyright (c) 1989, 1990, 1993
.\"     The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)df.1        8.3 (Berkeley) 5/8/95
.\" $FreeBSD: stable/9/bin/df/df.1 233139 2012-03-19 01:04:26Z eadler $
.\"
.Dd March 3, 2012
.Dt DF 1
.Os
.Sh NAME
.Nm df
.Nd display free disk space
.Sh SYNOPSIS
.Nm
.Op Fl b | g | H | h | k | m | P
.Op Fl acilnT
.Op Fl t Ar type
.Op Ar file | filesystem ...
.Sh DESCRIPTION
The
.Nm
utility
displays statistics about the amount of free disk space on the specified
.Ar file system
or on the file system of which
.Ar file
is a part.
Values are displayed in 512-byte per block counts.
If neither a file or a file system operand is specified,
statistics for all mounted file systems are displayed
(subject to the
.Fl t
option below).
.Pp
The following options are available:
.Bl -tag -width indent
.It Fl a
Show all mount points, including those that were mounted with the
.Dv MNT_IGNORE
flag.
This is implied for file systems specified on the command line.
.It Fl b
Use 512-byte blocks rather than the default.
Note that
this overrides the
.Ev BLOCKSIZE
specification from the environment.
.It Fl c
Display a grand total.
.It Fl g
Use 1073741824-byte (1-Gbyte) blocks rather than the default.
Note that
this overrides the
.Ev BLOCKSIZE
specification from the environment.
.It Fl H
.Dq Human-readable
output.
Use unit suffixes: Byte, Kilobyte, Megabyte,
Gigabyte, Terabyte and Petabyte in order to reduce the number of
digits to four or fewer using base 10 for sizes.
.It Fl h
.Dq Human-readable
output.
Use unit suffixes: Byte, Kilobyte, Megabyte,
Gigabyte, Terabyte and Petabyte in order to reduce the number of
digits to four or fewer using base 2 for sizes.
Inodes statistics, if enabled with
.Fl i ,
are always printed in base 10.
.It Fl i
Include statistics on the number of free inodes.
.It Fl k
Use 1024-byte (1-Kbyte) blocks rather than the default.
Note that
this overrides the
.Ev BLOCKSIZE
specification from the environment.
.It Fl l
Only display information about locally-mounted file systems.
.It Fl m
Use 1048576-byte (1-Mbyte) blocks rather than the default.
Note that
this overrides the
.Ev BLOCKSIZE
specification from the environment.
.It Fl n
Print out the previously obtained statistics from the file systems.
This option should be used if it is possible that one or more
file systems are in a state such that they will not be able to provide
statistics without a long delay.
When this option is specified,
.Nm
will not request new statistics from the file systems, but will respond
with the possibly stale statistics that were previously obtained.
.It Fl P
Use POSIX compliant output of 512-byte blocks rather than the default.
Note that this overrides the
.Ev BLOCKSIZE
specification from the environment.
.It Fl t
Only print out statistics for file systems of the specified types.
More than one type may be specified in a comma separated list.
The list of file system types can be prefixed with
.Dq no
to specify the file system types for which action should
.Em not
be taken.
For example, the
.Nm
command:
.Bd -literal -offset indent
df -t nonfs,nullfs
.Ed
.Pp
lists all file systems except those of type
.Tn NFS
and
.Tn NULLFS .
The
.Xr lsvfs 1
command can be used to find out the types of file systems
that are available on the system.
.It Fl T
Include file system type.
.El
.Sh ENVIRONMENT
.Bl -tag -width BLOCKSIZE
.It Ev BLOCKSIZE
If the environment variable
.Ev BLOCKSIZE
is set, the block counts will be displayed in units of that size block.
.El
.Sh SEE ALSO
.Xr lsvfs 1 ,
.Xr pstat 1 ,
.Xr quota 1 ,
.Xr swapinfo 1 ,
.Xr fstatfs 2 ,
.Xr getfsstat 2 ,
.Xr statfs 2 ,
.Xr getmntinfo 3 ,
.Xr fstab 5 ,
.Xr mount 8 ,
.Xr quot 8
.Sh HISTORY
A
.Nm
command appeared in
.At v1 .
.Sh BUGS
The
.Fl n
flag is ignored if a file or file system is specified.
Also, if a mount
point is not accessible by the user, it is possible that the file system
information could be stale.
Revision:	9664
Committed:	Sun Oct 22 23:20:00 2017 UTC (6 years, 6 months ago) by laffer1
File size:	5463 byte(s)
Log Message:	tag freebsd rev 9.r249549
#	Content
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: stable/9/bin/df/df.1 233139 2012-03-19 01:04:26Z eadler $
31	.\"
32	.Dd March 3, 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
45	The
46	.Nm
47	utility
48	displays statistics about the amount of free disk space on the specified
49	.Ar file system
50	or on the file system of which
51	.Ar file
52	is a part.
53	Values are displayed in 512-byte per block counts.
54	If neither a file or a file system operand is specified,
55	statistics for all mounted file systems are displayed
56	(subject to the
57	.Fl t
58	option below).
59	.Pp
60	The following options are available:
61	.Bl -tag -width indent
62	.It Fl a
63	Show all mount points, including those that were mounted with the
64	.Dv MNT_IGNORE
65	flag.
66	This is implied for file systems specified on the command line.
67	.It Fl b
68	Use 512-byte blocks rather than the default.
69	Note that
70	this overrides the
71	.Ev BLOCKSIZE
72	specification from the environment.
73	.It Fl c
74	Display a grand total.
75	.It Fl g
76	Use 1073741824-byte (1-Gbyte) blocks rather than the default.
77	Note that
78	this overrides the
79	.Ev BLOCKSIZE
80	specification from the environment.
81	.It Fl H
82	.Dq Human-readable
83	output.
84	Use unit suffixes: Byte, Kilobyte, Megabyte,
85	Gigabyte, Terabyte and Petabyte in order to reduce the number of
86	digits to four or fewer using base 10 for sizes.
87	.It Fl h
88	.Dq Human-readable
89	output.
90	Use unit suffixes: Byte, Kilobyte, Megabyte,
91	Gigabyte, Terabyte and Petabyte in order to reduce the number of
92	digits to four or fewer using base 2 for sizes.
93	Inodes statistics, if enabled with
94	.Fl i ,
95	are always printed in base 10.
96	.It Fl i
97	Include statistics on the number of free inodes.
98	.It Fl k
99	Use 1024-byte (1-Kbyte) blocks rather than the default.
100	Note that
101	this overrides the
102	.Ev BLOCKSIZE
103	specification from the environment.
104	.It Fl l
105	Only display information about locally-mounted file systems.
106	.It Fl m
107	Use 1048576-byte (1-Mbyte) blocks rather than the default.
108	Note that
109	this overrides the
110	.Ev BLOCKSIZE
111	specification from the environment.
112	.It Fl n
113	Print out the previously obtained statistics from the file systems.
114	This option should be used if it is possible that one or more
115	file systems are in a state such that they will not be able to provide
116	statistics without a long delay.
117	When this option is specified,
118	.Nm
119	will not request new statistics from the file systems, but will respond
120	with the possibly stale statistics that were previously obtained.
121	.It Fl P
122	Use POSIX compliant output of 512-byte blocks rather than the default.
123	Note that this overrides the
124	.Ev BLOCKSIZE
125	specification from the environment.
126	.It Fl t
127	Only print out statistics for file systems of the specified types.
128	More than one type may be specified in a comma separated list.
129	The list of file system types can be prefixed with
130	.Dq no
131	to specify the file system types for which action should
132	.Em not
133	be taken.
134	For example, the
135	.Nm
136	command:
137	.Bd -literal -offset indent
138	df -t nonfs,nullfs
139	.Ed
140	.Pp
141	lists all file systems except those of type
142	.Tn NFS
143	and
144	.Tn NULLFS .
145	The
146	.Xr lsvfs 1
147	command can be used to find out the types of file systems
148	that are available on the system.
149	.It Fl T
150	Include file system type.
151	.El
152	.Sh ENVIRONMENT
153	.Bl -tag -width BLOCKSIZE
154	.It Ev BLOCKSIZE
155	If the environment variable
156	.Ev BLOCKSIZE
157	is set, the block counts will be displayed in units of that size block.
158	.El
159	.Sh SEE ALSO
160	.Xr lsvfs 1 ,
161	.Xr pstat 1 ,
162	.Xr quota 1 ,
163	.Xr swapinfo 1 ,
164	.Xr fstatfs 2 ,
165	.Xr getfsstat 2 ,
166	.Xr statfs 2 ,
167	.Xr getmntinfo 3 ,
168	.Xr fstab 5 ,
169	.Xr mount 8 ,
170	.Xr quot 8
171	.Sh HISTORY
172	A
173	.Nm
174	command appeared in
175	.At v1 .
176	.Sh BUGS
177	The
178	.Fl n
179	flag is ignored if a file or file system is specified.
180	Also, if a mount
181	point is not accessible by the user, it is possible that the file system
182	information could be stale.