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 August 8, 2017
  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 .Dq Human-readable
 102 output.
 103 Use unit suffixes: Byte, Kilobyte, Megabyte,
 104 Gigabyte, Terabyte and Petabyte (based on powers of 1000) in order to
 105 reduce the number of
 106 digits to four or fewer.
 107 .It Fl i
 108 Include statistics on the number of free and used inodes.
 109 In conjunction with the
 110 .Fl h
 111 or
 112 .Fl H
 113 options, the number of inodes is scaled by powers of 1000.
 114 .It Fl k
 115 Use 1024 byte (1 Kibibyte) blocks rather than the default.
 116 This overrides the
 117 .Fl P
 118 option and any
 119 .Ev BLOCKSIZE
 120 specification from the environment.
 121 .It Fl l
 122 Only display information about locally-mounted file systems.
 123 .It Fl m
 124 Use 1048576 byte (1 Mebibyte) blocks rather than the default.
 125 This overrides any
 126 .Ev BLOCKSIZE
 127 specification from the environment.
 128 .It Fl n
 129 Print out the previously obtained statistics from the file systems.
 130 This option should be used if it is possible that one or more
 131 file systems are in a state such that they will not be able to provide
 132 statistics without a long delay.
 133 When this option is specified,
 134 .Nm
 135 will not request new statistics from the file systems, but will respond
 136 with the possibly stale statistics that were previously obtained.
 137 .It Fl P
 138 Explicitly use 512 byte blocks, overriding any
 139 .Ev BLOCKSIZE
 140 specification from the environment.
 141 This is the same as the
 142 .Fl b
 143 option.
 144 The
 145 .Fl k
 146 option overrides this option.
 147 .It Fl t
 148 Only print out statistics for file systems of the specified types.
 149 More than one type may be specified in a comma separated list.
 150 The list of file system types can be prefixed with
 151 .Dq no
 152 to specify the file system types for which action should
 153 .Em not
 154 be taken.
 155 For example, the
 156 .Nm
 157 command:
 158 .Bd -literal -offset indent
 159 df -t nonfs,nullfs
 160 .Ed
 161 .Pp
 162 lists all file systems except those of type
 163 .Tn NFS
 164 and
 165 .Tn NULLFS .
 166 The
 167 .Xr lsvfs 1
 168 command can be used to find out the types of file systems
 169 that are available on the system.
 170 .It Fl T
 171 Include file system type.
 172 .It Fl ,
 173 (Comma) Print sizes grouped and separated by thousands using the
 174 non-monetary separator returned by
 175 .Xr localeconv 3 ,
 176 typically a comma or period.
 177 If no locale is set, or the locale does not have a non-monetary separator, this
 178 option has no effect.
 179 .El
 180 .Sh ENVIRONMENT
 181 .Bl -tag -width BLOCKSIZE
 182 .It Ev BLOCKSIZE
 183 Specifies the units in which to report block counts.
 184 This uses
 185 .Xr getbsize 3 ,
 186 which allows units of bytes or numbers scaled with the letters
 187 .Em k
 188 (for multiples of 1024 bytes),
 189 .Em m
 190 (for multiples of 1048576 bytes) or
 191 .Em g
 192 (for gibibytes).
 193 The allowed range is 512 bytes to 1 GB.
 194 If the value is outside, it will be set to the appropriate limit.
 195 .El
 196 .Sh SEE ALSO
 197 .Xr lsvfs 1 ,
 198 .Xr quota 1 ,
 199 .Xr fstatfs 2 ,
 200 .Xr getfsstat 2 ,
 201 .Xr statfs 2 ,
 202 .Xr getbsize 3 ,
 203 .Xr getmntinfo 3 ,
 204 .Xr libxo 3 ,
 205 .Xr localeconv 3 ,
 206 .Xr xo_parse_args 3 ,
 207 .Xr fstab 5 ,
 208 .Xr mount 8 ,
 209 .Xr pstat 8 ,
 210 .Xr quot 8 ,
 211 .Xr swapinfo 8
 212 .Sh STANDARDS
 213 With the exception of most options,
 214 the
 215 .Nm
 216 utility conforms to
 217 .St -p1003.1-2004 ,
 218 which defines only the
 219 .Fl k , P
 220 and
 221 .Fl t
 222 options.
 223 .Sh HISTORY
 224 A
 225 .Nm
 226 command appeared in
 227 .At v1 .
 228 .Sh BUGS
 229 The
 230 .Fl n
 231 flag is ignored if a file or file system is specified.
 232 Also, if a mount
 233 point is not accessible by the user, it is possible that the file system
 234 information could be stale.
 235 .Pp
 236 The
 237 .Fl b
 238 and
 239 .Fl P
 240 options are identical.
 241 The former comes from the BSD tradition, and the latter is required
 242 for
 243 .St -p1003.1-2004
 244 conformity.