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