Remove advertising header from man pages.
[dragonfly.git] / bin / df / df.1
1 .\" Copyright (c) 1989, 1990, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 4. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     @(#)df.1        8.3 (Berkeley) 5/8/95
29 .\" $FreeBSD: src/bin/df/df.1,v 1.18.2.9 2003/05/07 23:56:14 trhodes Exp $
30 .\" $DragonFly: src/bin/df/df.1,v 1.3 2006/02/17 19:33:30 swildner Exp $
31 .\"
32 .Dd June 10, 2009
33 .Dt DF 1
34 .Os
35 .Sh NAME
36 .Nm df
37 .Nd display free disk space
38 .Sh SYNOPSIS
39 .Nm
40 .Oo
41 .Fl b | h | H | k |
42 .Fl m | P
43 .Oc
44 .Op Fl ailn
45 .Op Fl t Ar type
46 .Op Ar file | filesystem ...
47 .Sh DESCRIPTION
48 The
49 .Nm
50 utility
51 displays statistics about the amount of free disk space on the specified
52 .Ar file system
53 or on the file system of which
54 .Ar file
55 is a part.
56 Values are displayed in 512-byte per block counts.
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 Ds
65 .It Fl a
66 Show all mount points, including those that were mounted with the
67 .Cm ignore
68 option.
69 .It Fl b
70 Use 512-byte blocks rather than the default.  Note that
71 this overrides the
72 .Ev BLOCKSIZE
73 specification from the environment.
74 .It Fl g
75 Use 1073741824-byte (1-Gbyte) blocks rather than the default.  Note that
76 this overrides the
77 .Ev BLOCKSIZE
78 specification from the environment.
79 .It Fl H
80 "Human-readable" output.  Use unit suffixes: Byte, Kilobyte, Megabyte,
81 Gigabyte, Terabyte and Petabyte in order to reduce the number of
82 digits to four or fewer using base 10 for sizes.
83 .It Fl h
84 "Human-readable" output.  Use unit suffixes: Byte, Kilobyte, Megabyte,
85 Gigabyte, Terabyte and Petabyte in order to reduce the number of
86 digits to four or fewer using base 2 for sizes.
87 .It Fl i
88 Include statistics on the number of free inodes.
89 .It Fl k
90 Use 1024-byte (1-Kbyte) blocks rather than the default.  Note that
91 this overrides the
92 .Ev BLOCKSIZE
93 specification from the environment.
94 .It Fl l
95 Only display information about locally-mounted file systems.
96 .It Fl m
97 Use 1048576-byte (1-Mbyte) blocks rather than the default.  Note that
98 this overrides the
99 .Ev BLOCKSIZE
100 specification from the environment.
101 .It Fl n
102 Print out the previously obtained statistics from the file systems.
103 This option should be used if it is possible that one or more
104 file systems are in a state such that they will not be able to provide
105 statistics without a long delay.
106 When this option is specified,
107 .Nm
108 will not request new statistics from the file systems, but will respond
109 with the possibly stale statistics that were previously obtained.
110 .It Fl P
111 Use POSIX compliant output of 512-byte blocks rather than the default.
112 Note that this overrides the
113 .Ev BLOCKSIZE
114 specification from the environment.
115 .It Fl t
116 Only print out statistics for file systems of the specified types.
117 More than one type may be specified in a comma separated list.
118 The list of file system types can be prefixed with
119 .Dq no
120 to specify the file system types for which action should
121 .Em not
122 be taken.
123 For example, the
124 .Nm
125 command:
126 .Bd -literal -offset indent
127 df -t nonfs,nullfs
128 .Ed
129 .Pp
130 lists all file systems except those of type
131 .Tn NFS
132 and
133 .Tn NULLFS .
134 The
135 .Xr lsvfs 1
136 command can be used to find out the types of file systems
137 that are available on the system.
138 .El
139 .Sh ENVIRONMENT
140 .Bl -tag -width BLOCKSIZE
141 .It Ev BLOCKSIZE
142 If the environment variable
143 .Ev BLOCKSIZE
144 is set, the block counts will be displayed in units of that size block.
145 .El
146 .Sh SEE ALSO
147 .Xr lsvfs 1 ,
148 .Xr quota 1 ,
149 .Xr fstatfs 2 ,
150 .Xr getfsstat 2 ,
151 .Xr statfs 2 ,
152 .Xr getmntinfo 3 ,
153 .Xr fstab 5 ,
154 .Xr mount 8 ,
155 .Xr quot 8
156 .Sh HISTORY
157 A
158 .Nm
159 command appeared in
160 .At v1 .
161 .Sh BUGS
162 The
163 .Fl n
164 and
165 .Fl t
166 flags are ignored if a file or file system is specified.