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