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 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 .It Fl k
 113 Use 1024 byte (1 Kibibyte) blocks rather than the default.
 114 This overrides the
 115 .Fl P
 116 option and any
 117 .Ev BLOCKSIZE
 118 specification from the environment.
 119 .It Fl l
 120 Select locally-mounted file system for display.
 121 If used in combination with the
 122 .Fl t Ar type
 123 option, file system types will be added or excluded acccording to the
 124 parameters of that option.
 125 .It Fl m
 126 Use 1048576 byte (1 Mebibyte) blocks rather than the default.
 127 This overrides any
 128 .Ev BLOCKSIZE
 129 specification from the environment.
 130 .It Fl n
 131 Print out the previously obtained statistics from the file systems.
 132 This option should be used if it is possible that one or more
 133 file systems are in a state such that they will not be able to provide
 134 statistics without a long delay.
 135 When this option is specified,
 136 .Nm
 137 will not request new statistics from the file systems, but will respond
 138 with the possibly stale statistics that were previously obtained.
 139 .It Fl P
 140 Explicitly use 512 byte blocks, overriding any
 141 .Ev BLOCKSIZE
 142 specification from the environment.
 143 This is the same as the
 144 .Fl b
 145 option.
 146 The
 147 .Fl k
 148 option overrides this option.
 149 .It Fl t Ar type
 150 Select file systems to display.
 151 More than one type may be specified in a comma separated list.
 152 The list of file system types can be prefixed with
 153 .Dq no
 154 to specify the file system types for which action should
 155 .Em not
 156 be taken.
 157 If used in combination with the
 158 .Fl l
 159 option, the parameters of this option will modify the list of
 160 locally-mounted file systems selected by the
 161 .Fl l
 162 option.
 163 For example, the
 164 .Nm
 165 command:
 166 .Bd -literal -offset indent
 167 df -t nonfs,nullfs
 168 .Ed
 169 .Pp
 170 lists all file systems except those of type NFS and NULLFS.
 171 The
 172 .Xr lsvfs 1
 173 command can be used to find out the types of file systems
 174 that are available on the system.
 175 .It Fl T
 176 Include file system type.
 177 .It Fl ,
 178 (Comma) Print sizes grouped and separated by thousands using the
 179 non-monetary separator returned by
 180 .Xr localeconv 3 ,
 181 typically a comma or period.
 182 If no locale is set, or the locale does not have a non-monetary separator, this
 183 option has no effect.
 184 .El
 185 .Sh ENVIRONMENT
 186 .Bl -tag -width BLOCKSIZE
 187 .It Ev BLOCKSIZE
 188 Specifies the units in which to report block counts.
 189 This uses
 190 .Xr getbsize 3 ,
 191 which allows units of bytes or numbers scaled with the letters
 192 .Em k
 193 (for multiples of 1024 bytes),
 194 .Em m
 195 (for multiples of 1048576 bytes) or
 196 .Em g
 197 (for gibibytes).
 198 The allowed range is 512 bytes to 1 GB.
 199 If the value is outside, it will be set to the appropriate limit.
 200 .El
 201 .Sh EXAMPLES
 202 Show human readable free disk space for all mount points including file system
 203 type:
 204 .Bd -literal -offset indent
 205 $ df -ahT
 206 Filesystem   Type        Size    Used   Avail Capacity  Mounted on
 207 /dev/ada1p2  ufs         213G    152G     44G    78%    /
 208 devfs        devfs       1.0K    1.0K      0B   100%    /dev
 209 /dev/ada0p1  ufs         1.8T    168G    1.5T    10%    /data
 210 linsysfs     linsysfs    4.0K    4.0K      0B   100%    /compat/linux/sys
 211 /dev/da0     msdosfs     7.6G    424M    7.2G     5%    /mnt/usb
 212 .Ed
 213 .Pp
 214 Show previously collected data including inode statistics except for devfs or
 215 linsysfs file systems.
 216 Note that the
 217 .Dq no
 218 prefix affects all the file systems in the list and the
 219 .Fl t
 220 option can be specified only once:
 221 .Bd -literal -offset indent
 222 $ df -i -n -t nodevfs,linsysfs
 223 Filesystem   1K-blocks      Used      Avail Capacity iused     ifree %iused
 224 Mounted on
 225 /dev/ada1p2  223235736 159618992   45757888    78% 1657590  27234568    6%   /
 226 /dev/ada0p1 1892163184 176319420 1564470712    10% 1319710 243300576    1%
 227 /data
 228 /dev/da0       7989888    433664    7556224     5%       0         0  100%
 229 /mnt/usb
 230 .Ed
 231 .Pp
 232 Show human readable information for the file system containing the file
 233 .Pa /etc/rc.conf :
 234 .Bd -literal -offset indent
 235 $ df -h /etc/rc.conf
 236 Filesystem     Size    Used   Avail Capacity  Mounted on
 237 /dev/ada1p2    213G    152G     44G    78%    /
 238 .Ed
 239 .Pp
 240 Same as above but specifying some file system:
 241 .Bd -literal -offset indent
 242 $ df -h /dev/ada1p2
 243 Filesystem     Size    Used   Avail Capacity  Mounted on
 244 /dev/ada1p2    213G    152G     44G    78%    /
 245 .Ed
 246 .Sh SEE ALSO
 247 .Xr lsvfs 1 ,
 248 .Xr quota 1 ,
 249 .Xr fstatfs 2 ,
 250 .Xr getfsstat 2 ,
 251 .Xr statfs 2 ,
 252 .Xr getbsize 3 ,
 253 .Xr getmntinfo 3 ,
 254 .Xr libxo 3 ,
 255 .Xr localeconv 3 ,
 256 .Xr xo_parse_args 3 ,
 257 .Xr fstab 5 ,
 258 .Xr mount 8 ,
 259 .Xr pstat 8 ,
 260 .Xr quot 8 ,
 261 .Xr swapinfo 8
 262 .Sh STANDARDS
 263 With the exception of most options,
 264 the
 265 .Nm
 266 utility conforms to
 267 .St -p1003.1-2004 ,
 268 which defines only the
 269 .Fl k , P
 270 and
 271 .Fl t
 272 options.
 273 .Sh HISTORY
 274 A
 275 .Nm
 276 command appeared in
 277 .At v1 .
 278 .Sh BUGS
 279 The
 280 .Fl n
 281 flag is ignored if a file or file system is specified.
 282 Also, if a mount
 283 point is not accessible by the user, it is possible that the file system
 284 information could be stale.
 285 .Pp
 286 The
 287 .Fl b
 288 and
 289 .Fl P
 290 options are identical.
 291 The former comes from the BSD tradition, and the latter is required
 292 for
 293 .St -p1003.1-2004
 294 conformity.