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