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