bin/df/df.1

   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 .\" 3. 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$
  31 .\"
  32 .Dd October 5, 2020
  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 -libxo
  41 .Op Fl b | g | H | h | k | m | P
  42 .Op Fl acilnT
  43 .Op Fl \&,
  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 By default block counts are displayed with an assumed block size of
  56 512 bytes.
  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 indent
  65 .It Fl -libxo
  66 Generate output via
  67 .Xr libxo 3
  68 in a selection of different human and machine readable formats.
  69 See
  70 .Xr xo_parse_args 3
  71 for details on command line arguments.
  72 .It Fl a
  73 Show all mount points, including those that were mounted with the
  74 .Dv MNT_IGNORE
  75 flag.
  76 This is implied for file systems specified on the command line.
  77 .It Fl b
  78 Explicitly use 512 byte blocks, overriding any
  79 .Ev BLOCKSIZE
  80 specification from the environment.
  81 This is the same as the
  82 .Fl P
  83 option.
  84 The
  85 .Fl k
  86 option overrides this option.
  87 .It Fl c
  88 Display a grand total.
  89 .It Fl g
  90 Use 1073741824 byte (1 Gibibyte) blocks rather than the default.
  91 This overrides any
  92 .Ev BLOCKSIZE
  93 specification from the environment.
  94 .It Fl h
  95 .Dq Human-readable
  96 output.
  97 Use unit suffixes: Byte, Kibibyte, Mebibyte, Gibibyte, Tebibyte and
  98 Pebibyte (based on powers of 1024) in order to reduce the number of
  99 digits to four or fewer.
 100 .It Fl H , Fl Fl si
 101 Same as
 102 .Fl h
 103 but based on powers of 1000.
 104 .It Fl i
 105 Include statistics on the number of free and used inodes.
 106 In conjunction with the
 107 .Fl h
 108 or
 109 .Fl H
 110 options, the number of inodes is scaled by powers of 1000.
 111 .It Fl k
 112 Use 1024 byte (1 Kibibyte) blocks rather than the default.
 113 This overrides the
 114 .Fl P
 115 option and any
 116 .Ev BLOCKSIZE
 117 specification from the environment.
 118 .It Fl l
 119 Only display information about locally-mounted file systems.
 120 .It Fl m
 121 Use 1048576 byte (1 Mebibyte) blocks rather than the default.
 122 This overrides any
 123 .Ev BLOCKSIZE
 124 specification from the environment.
 125 .It Fl n
 126 Print out the previously obtained statistics from the file systems.
 127 This option should be used if it is possible that one or more
 128 file systems are in a state such that they will not be able to provide
 129 statistics without a long delay.
 130 When this option is specified,
 131 .Nm
 132 will not request new statistics from the file systems, but will respond
 133 with the possibly stale statistics that were previously obtained.
 134 .It Fl P
 135 Explicitly use 512 byte blocks, overriding any
 136 .Ev BLOCKSIZE
 137 specification from the environment.
 138 This is the same as the
 139 .Fl b
 140 option.
 141 The
 142 .Fl k
 143 option overrides this option.
 144 .It Fl t
 145 Only print out statistics for file systems of the specified types.
 146 More than one type may be specified in a comma separated list.
 147 The list of file system types can be prefixed with
 148 .Dq no
 149 to specify the file system types for which action should
 150 .Em not
 151 be taken.
 152 For example, the
 153 .Nm
 154 command:
 155 .Bd -literal -offset indent
 156 df -t nonfs,nullfs
 157 .Ed
 158 .Pp
 159 lists all file systems except those of type NFS and NULLFS.
 160 The
 161 .Xr lsvfs 1
 162 command can be used to find out the types of file systems
 163 that are available on the system.
 164 .It Fl T
 165 Include file system type.
 166 .It Fl ,
 167 (Comma) Print sizes grouped and separated by thousands using the
 168 non-monetary separator returned by
 169 .Xr localeconv 3 ,
 170 typically a comma or period.
 171 If no locale is set, or the locale does not have a non-monetary separator, this
 172 option has no effect.
 173 .El
 174 .Sh ENVIRONMENT
 175 .Bl -tag -width BLOCKSIZE
 176 .It Ev BLOCKSIZE
 177 Specifies the units in which to report block counts.
 178 This uses
 179 .Xr getbsize 3 ,
 180 which allows units of bytes or numbers scaled with the letters
 181 .Em k
 182 (for multiples of 1024 bytes),
 183 .Em m
 184 (for multiples of 1048576 bytes) or
 185 .Em g
 186 (for gibibytes).
 187 The allowed range is 512 bytes to 1 GB.
 188 If the value is outside, it will be set to the appropriate limit.
 189 .El
 190 .Sh EXAMPLES
 191 Show human readable free disk space for all mount points including file system
 192 type:
 193 .Bd -literal -offset indent
 194 $ df -ahT
 195 Filesystem   Type        Size    Used   Avail Capacity  Mounted on
 196 /dev/ada1p2  ufs         213G    152G     44G    78%    /
 197 devfs        devfs       1.0K    1.0K      0B   100%    /dev
 198 /dev/ada0p1  ufs         1.8T    168G    1.5T    10%    /data
 199 linsysfs     linsysfs    4.0K    4.0K      0B   100%    /compat/linux/sys
 200 /dev/da0     msdosfs     7.6G    424M    7.2G     5%    /mnt/usb
 201 .Ed
 202 .Pp
 203 Show previously collected data including inode statistics except for devfs or
 204 linsysfs file systems.
 205 Note that the
 206 .Dq no
 207 prefix affects all the file systems in the list and the
 208 .Fl t
 209 option can be specified only once:
 210 .Bd -literal -offset indent
 211 $ df -i -n -t nodevfs,linsysfs
 212 Filesystem   1K-blocks      Used      Avail Capacity iused     ifree %iused
 213 Mounted on
 214 /dev/ada1p2  223235736 159618992   45757888    78% 1657590  27234568    6%   /
 215 /dev/ada0p1 1892163184 176319420 1564470712    10% 1319710 243300576    1%
 216 /data
 217 /dev/da0       7989888    433664    7556224     5%       0         0  100%
 218 /mnt/usb
 219 .Ed
 220 .Pp
 221 Show human readable information for the file system containing the file
 222 .Pa /etc/rc.conf
 223 :
 224 .Bd -literal -offset indent
 225 $ df -h /etc/rc.conf
 226 Filesystem     Size    Used   Avail Capacity  Mounted on
 227 /dev/ada1p2    213G    152G     44G    78%    /
 228 .Ed
 229 .Pp
 230 Same as above but specifying some file system:
 231 .Bd -literal -offset indent
 232 $ df -h /dev/ada1p2
 233 Filesystem     Size    Used   Avail Capacity  Mounted on
 234 /dev/ada1p2    213G    152G     44G    78%    /
 235 .Ed
 236 .Sh SEE ALSO
 237 .Xr lsvfs 1 ,
 238 .Xr quota 1 ,
 239 .Xr fstatfs 2 ,
 240 .Xr getfsstat 2 ,
 241 .Xr statfs 2 ,
 242 .Xr getbsize 3 ,
 243 .Xr getmntinfo 3 ,
 244 .Xr libxo 3 ,
 245 .Xr localeconv 3 ,
 246 .Xr xo_parse_args 3 ,
 247 .Xr fstab 5 ,
 248 .Xr mount 8 ,
 249 .Xr pstat 8 ,
 250 .Xr quot 8 ,
 251 .Xr swapinfo 8
 252 .Sh STANDARDS
 253 With the exception of most options,
 254 the
 255 .Nm
 256 utility conforms to
 257 .St -p1003.1-2004 ,
 258 which defines only the
 259 .Fl k , P
 260 and
 261 .Fl t
 262 options.
 263 .Sh HISTORY
 264 A
 265 .Nm
 266 command appeared in
 267 .At v1 .
 268 .Sh BUGS
 269 The
 270 .Fl n
 271 flag is ignored if a file or file system is specified.
 272 Also, if a mount
 273 point is not accessible by the user, it is possible that the file system
 274 information could be stale.
 275 .Pp
 276 The
 277 .Fl b
 278 and
 279 .Fl P
 280 options are identical.
 281 The former comes from the BSD tradition, and the latter is required
 282 for
 283 .St -p1003.1-2004
 284 conformity.