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