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 .\" 4. 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 November 16, 2012
  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 b | g | H | h | k | m | P
  41 .Op Fl acilnT
  42 .Op Fl t Ar type
  43 .Op Ar file | filesystem ...
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility
  48 displays statistics about the amount of free disk space on the specified
  49 .Ar file system
  50 or on the file system of which
  51 .Ar file
  52 is a part.
  53 By default block counts are displayed with an assumed block size of
  54 512 bytes.
  55 If neither a file or a file system operand is specified,
  56 statistics for all mounted file systems are displayed
  57 (subject to the
  58 .Fl t
  59 option below).
  60 .Pp
  61 The following options are available:
  62 .Bl -tag -width indent
  63 .It Fl a
  64 Show all mount points, including those that were mounted with the
  65 .Dv MNT_IGNORE
  66 flag.
  67 This is implied for file systems specified on the command line.
  68 .It Fl b
  69 Explicitly use 512 byte blocks, overriding any
  70 .Ev BLOCKSIZE
  71 specification from the environment.
  72 This is the same as the
  73 .Fl P
  74 option.
  75 The
  76 .Fl k
  77 option overrides this option.
  78 .It Fl c
  79 Display a grand total.
  80 .It Fl g
  81 Use 1073741824 byte (1 Gibibyte) blocks rather than the default.
  82 This overrides any
  83 .Ev BLOCKSIZE
  84 specification from the environment.
  85 .It Fl H
  86 .Dq Human-readable
  87 output.
  88 Use unit suffixes: Byte, Kibibyte, Mebibyte, Gibibyte, Tebibyte and
  89 Pebibyte (based on powers of 1024) in order to reduce the number of
  90 digits to four or fewer.
  91 .It Fl h
  92 .Dq Human-readable
  93 output.
  94 Use unit suffixes: Byte, Kilobyte, Megabyte,
  95 Gigabyte, Terabyte and Petabyte (based on powers of 1000) in order to
  96 reduce the number of
  97 digits to four or fewer.
  98 .It Fl i
  99 Include statistics on the number of free and used inodes.
 100 In conjunction with the
 101 .Fl h
 102 or
 103 .Fl H
 104 options, the number of inodes is scaled by powers of 1000.
 105 .It Fl k
 106 Use 1024 byte (1 Kibibyte) blocks rather than the default.
 107 This overrides the
 108 .Fl P
 109 option and any
 110 .Ev BLOCKSIZE
 111 specification from the environment.
 112 .It Fl l
 113 Only display information about locally-mounted file systems.
 114 .It Fl m
 115 Use 1048576 byte (1 Mebibyte) blocks rather than the default.
 116 This overrides any
 117 .Ev BLOCKSIZE
 118 specification from the environment.
 119 .It Fl n
 120 Print out the previously obtained statistics from the file systems.
 121 This option should be used if it is possible that one or more
 122 file systems are in a state such that they will not be able to provide
 123 statistics without a long delay.
 124 When this option is specified,
 125 .Nm
 126 will not request new statistics from the file systems, but will respond
 127 with the possibly stale statistics that were previously obtained.
 128 .It Fl P
 129 Explicitly use 512 byte blocks, overriding any
 130 .Ev BLOCKSIZE
 131 specification from the environment.
 132 This is the same as the
 133 .Fl b
 134 option.
 135 The
 136 .Fl k
 137 option overrides this option.
 138 .It Fl t
 139 Only print out statistics for file systems of the specified types.
 140 More than one type may be specified in a comma separated list.
 141 The list of file system types can be prefixed with
 142 .Dq no
 143 to specify the file system types for which action should
 144 .Em not
 145 be taken.
 146 For example, the
 147 .Nm
 148 command:
 149 .Bd -literal -offset indent
 150 df -t nonfs,nullfs
 151 .Ed
 152 .Pp
 153 lists all file systems except those of type
 154 .Tn NFS
 155 and
 156 .Tn NULLFS .
 157 The
 158 .Xr lsvfs 1
 159 command can be used to find out the types of file systems
 160 that are available on the system.
 161 .It Fl T
 162 Include file system type.
 163 .It Fl ,
 164 (Comma) Print sizes grouped and separated by thousands using the
 165 non-monetary separator returned by
 166 .Xr localeconv 3 ,
 167 typically a comma or period.
 168 If no locale is set, or the locale does not have a non-monetary separator, this
 169 option has no effect.
 170 .El
 171 .Sh ENVIRONMENT
 172 .Bl -tag -width BLOCKSIZE
 173 .It Ev BLOCKSIZE
 174 Specifies the units in which to report block counts.
 175 This uses
 176 .Xr getbsize 3 ,
 177 which allows units of bytes or numbers scaled with the letters
 178 .Em k
 179 (for multiples of 1024 bytes),
 180 .Em m
 181 (for multiples of 1048576 bytes) or
 182 .Em g
 183 (for gibibytes).
 184 The allowed range is 512 bytes to 1 GB.
 185 If the value is outside, it will be set to the appropriate limit.
 186 .El
 187 .Sh SEE ALSO
 188 .Xr lsvfs 1 ,
 189 .Xr quota 1 ,
 190 .Xr fstatfs 2 ,
 191 .Xr getfsstat 2 ,
 192 .Xr statfs 2 ,
 193 .Xr getbsize 3 ,
 194 .Xr getmntinfo 3 ,
 195 .Xr localeconv 3 ,
 196 .Xr fstab 5 ,
 197 .Xr mount 8 ,
 198 .Xr quot 8 .
 199 .Sh STANDARDS
 200 With the exception of most options,
 201 the
 202 .Nm
 203 utility conforms to
 204 .St -p1003.1-2004 ,
 205 which defines only the
 206 .Fl k , P
 207 and
 208 .Fl t
 209 options.
 210 .Sh HISTORY
 211 A
 212 .Nm
 213 command appeared in
 214 .At v1 .
 215 .Sh BUGS
 216 The
 217 .Fl n
 218 flag is ignored if a file or file system is specified.
 219 Also, if a mount
 220 point is not accessible by the user, it is possible that the file system
 221 information could be stale.
 222 .Pp
 223 The
 224 .Fl b
 225 and
 226 .Fl P
 227 options are identical.
 228 The former comes from the BSD tradition, and the latter is required
 229 for
 230 .St -p1003.1-2004
 231 conformity.