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