Fix rewrite error which appeared in rev 1.3.
[dragonfly.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 .\" $DragonFly: src/bin/df/df.1,v 1.3 2006/02/17 19:33:30 swildner Exp $
35 .\"
36 .Dd May 8, 1995
37 .Dt DF 1
38 .Os
39 .Sh NAME
40 .Nm df
41 .Nd display free disk space
42 .Sh SYNOPSIS
43 .Nm
44 .Oo
45 .Fl b | h | H | k |
46 .Fl m | P
47 .Oc
48 .Op Fl ailn
49 .Op Fl t Ar type
50 .Op Ar file | filesystem ...
51 .Sh DESCRIPTION
52 The
53 .Nm
54 utility
55 displays statistics about the amount of free disk space on the specified
56 .Ar file system
57 or on the file system of which
58 .Ar file
59 is a part.
60 Values are displayed in 512-byte per block counts.
61 If neither a file or a file system operand is specified,
62 statistics for all mounted file systems are displayed
63 (subject to the
64 .Fl t
65 option below).
66 .Pp
67 The following options are available:
68 .Bl -tag -width Ds
69 .It Fl a
70 Show all mount points, including those that were mounted with the MNT_IGNORE
71 flag.
72 .It Fl b
73 Use 512-byte blocks rather than the default.  Note that
74 this overrides the
75 .Ev BLOCKSIZE
76 specification from the environment.
77 .It Fl g
78 Use 1073741824-byte (1-Gbyte) blocks rather than the default.  Note that
79 this overrides the
80 .Ev BLOCKSIZE
81 specification from the environment.
82 .It Fl H
83 "Human-readable" output.  Use unit suffixes: Byte, Kilobyte, Megabyte,
84 Gigabyte, Terabyte and Petabyte in order to reduce the number of
85 digits to four or fewer using base 10 for sizes.
86 .It Fl h
87 "Human-readable" output.  Use unit suffixes: Byte, Kilobyte, Megabyte,
88 Gigabyte, Terabyte and Petabyte in order to reduce the number of
89 digits to four or fewer using base 2 for sizes.
90 .It Fl i
91 Include statistics on the number of free inodes.
92 .It Fl k
93 Use 1024-byte (1-Kbyte) blocks rather than the default.  Note that
94 this overrides the
95 .Ev BLOCKSIZE
96 specification from the environment.
97 .It Fl l
98 Only display information about locally-mounted file systems.
99 .It Fl m
100 Use 1048576-byte (1-Mbyte) blocks rather than the default.  Note that
101 this overrides the
102 .Ev BLOCKSIZE
103 specification from the environment.
104 .It Fl n
105 Print out the previously obtained statistics from the file systems.
106 This option should be used if it is possible that one or more
107 file systems are in a state such that they will not be able to provide
108 statistics without a long delay.
109 When this option is specified,
110 .Nm
111 will not request new statistics from the file systems, but will respond
112 with the possibly stale statistics that were previously obtained.
113 .It Fl P
114 Use POSIX compliant output of 512-byte blocks rather than the default.
115 Note that this overrides the
116 .Ev BLOCKSIZE
117 specification from the environment.
118 .It Fl t
119 Only print out statistics for file systems of the specified types.
120 More than one type may be specified in a comma separated list.
121 The list of file system types can be prefixed with
122 .Dq no
123 to specify the file system types for which action should
124 .Em not
125 be taken.
126 For example, the
127 .Nm
128 command:
129 .Bd -literal -offset indent
130 df -t nonfs,nullfs
131 .Ed
132 .Pp
133 lists all file systems except those of type
134 .Tn NFS
135 and
136 .Tn NULLFS .
137 The
138 .Xr lsvfs 1
139 command can be used to find out the types of file systems
140 that are available on the system.
141 .El
142 .Sh ENVIRONMENT
143 .Bl -tag -width BLOCKSIZE
144 .It Ev BLOCKSIZE
145 If the environment variable
146 .Ev BLOCKSIZE
147 is set, the block counts will be displayed in units of that size block.
148 .El
149 .Sh SEE ALSO
150 .Xr lsvfs 1 ,
151 .Xr quota 1 ,
152 .Xr fstatfs 2 ,
153 .Xr getfsstat 2 ,
154 .Xr statfs 2 ,
155 .Xr getmntinfo 3 ,
156 .Xr fstab 5 ,
157 .Xr mount 8 ,
158 .Xr quot 8
159 .Sh HISTORY
160 A
161 .Nm
162 command appeared in
163 .At v1 .
164 .Sh BUGS
165 The
166 .Fl n
167 and
168 .Fl t
169 flags are ignored if a file or file system is specified.