[apple/file_cmds.git] / df / df.1

.\"	$NetBSD: df.1,v 1.14 1997/10/20 08:51:31 enami Exp $
.\"
.\" Copyright (c) 1989, 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)df.1	8.2 (Berkeley) 1/13/92
.\"
.Dd January 13, 1994
.Dt DF 1
.Os BSD 4
.Sh NAME
.Nm df
.Nd display free disk space
.Sh SYNOPSIS
.Nm
.Op Fl ikln
.Op Fl t Ar type
.Op Ar file | Ar file_system ...
.Sh DESCRIPTION
.Nm
displays statistics about the amount of free disk space on the specified
.Ar file_system
or on the file system of which
.Ar file
is a part.
Values are displayed in 512-byte per block block counts.
If neither a file or a
.Ar file_system
operand is specified,
statistics for all mounted file systems are displayed
(subject to the
.Fl l
and
.Fl t
options below).
.Pp
The following options are available:
.Bl -tag -width Ds
.It Fl i
Include statistics on the number of free inodes.
.It Fl k
By default, all sizes are reported in 512-byte block counts.
The
.Fl k
option causes the numbers to be reported in kilobyte counts.
.It Fl l
Display statistics only about mounted file systems with the MNT_LOCAL
flag set.  If a non-local file system is given as an argument, a
warning is issued and no information is given on that file system.
.It Fl n
Print out the previously obtained statistics from the file systems.
This option should be used if it is possible that one or more
file systems are in a state such that they will not be able to provide
statistics without a long delay.
When this option is specified,
.Nm
will not request new statistics from the file systems, but will respond
with the possibly stale statistics that were previously obtained.
.It Fl t Ar type
Is used to indicate the actions should only be taken on
filesystems of the specified type.
More than one type may be specified in a comma separated list.
The list of filesystem types can be prefixed with
.Dq no
to specify the filesystem types for which action should
.Em not
be taken.  If a file system is given on the command line that is not of
the specified type, a warning is issued and no information is given on
that file system.
.El
.Sh ENVIRONMENT VARIABLES
.Bl -tag -width BLOCKSIZE
.It Ev BLOCKSIZE
If the environment variable
.Ev BLOCKSIZE
is set, and the
.Fl k
option is not specified, the block counts will be displayed in units of that
size block.
.El
.Sh SEE ALSO
.Xr quota 1 ,
.Xr statfs 2 ,
.Xr fstatfs 2 ,
.Xr getfsstat 2 ,
.Xr getmntinfo 3 ,
.Xr fstab 5 ,
.Xr mount 8 ,
.Xr quot 8
.Sh HISTORY
A
.Nm
utility appeared in
.At v6 .
Commit	Line	Data
44a7a5ab A	1	.\" $NetBSD: df.1,v 1.14 1997/10/20 08:51:31 enami Exp $
	2	.\"
	3	.\" Copyright (c) 1989, 1990, 1993
	4	.\" The Regents of the University of California. All rights reserved.
	5	.\"
	6	.\" Redistribution and use in source and binary forms, with or without
	7	.\" modification, are permitted provided that the following conditions
	8	.\" are met:
	9	.\" 1. Redistributions of source code must retain the above copyright
	10	.\" notice, this list of conditions and the following disclaimer.
	11	.\" 2. Redistributions in binary form must reproduce the above copyright
	12	.\" notice, this list of conditions and the following disclaimer in the
	13	.\" documentation and/or other materials provided with the distribution.
	14	.\" 3. All advertising materials mentioning features or use of this software
	15	.\" must display the following acknowledgement:
	16	.\" This product includes software developed by the University of
	17	.\" California, Berkeley and its contributors.
	18	.\" 4. Neither the name of the University nor the names of its contributors
	19	.\" may be used to endorse or promote products derived from this software
	20	.\" without specific prior written permission.
	21	.\"
	22	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	23	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	24	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	25	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	26	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	27	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	28	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	29	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	30	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	31	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	32	.\" SUCH DAMAGE.
	33	.\"
	34	.\" @(#)df.1 8.2 (Berkeley) 1/13/92
	35	.\"
	36	.Dd January 13, 1994
	37	.Dt DF 1
	38	.Os BSD 4
	39	.Sh NAME
	40	.Nm df
	41	.Nd display free disk space
	42	.Sh SYNOPSIS
	43	.Nm
	44	.Op Fl ikln
	45	.Op Fl t Ar type
	46	.Op Ar file \| Ar file_system ...
	47	.Sh DESCRIPTION
	48	.Nm
	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	Values are displayed in 512-byte per block block counts.
	55	If neither a file or a
	56	.Ar file_system
	57	operand is specified,
	58	statistics for all mounted file systems are displayed
	59	(subject to the
	60	.Fl l
	61	and
	62	.Fl t
	63	options below).
	64	.Pp
65	The following options are available:
66	.Bl -tag -width Ds
67	.It Fl i
68	Include statistics on the number of free inodes.
69	.It Fl k
70	By default, all sizes are reported in 512-byte block counts.
71	The
72	.Fl k
73	option causes the numbers to be reported in kilobyte counts.
74	.It Fl l
75	Display statistics only about mounted file systems with the MNT_LOCAL
76	flag set. If a non-local file system is given as an argument, a
77	warning is issued and no information is given on that file system.
78	.It Fl n
79	Print out the previously obtained statistics from the file systems.
80	This option should be used if it is possible that one or more
81	file systems are in a state such that they will not be able to provide
82	statistics without a long delay.
83	When this option is specified,
84	.Nm
85	will not request new statistics from the file systems, but will respond
86	with the possibly stale statistics that were previously obtained.
87	.It Fl t Ar type
88	Is used to indicate the actions should only be taken on
89	filesystems of the specified type.
90	More than one type may be specified in a comma separated list.
91	The list of filesystem types can be prefixed with
92	.Dq no
93	to specify the filesystem types for which action should
94	.Em not
95	be taken. If a file system is given on the command line that is not of
96	the specified type, a warning is issued and no information is given on
97	that file system.
98	.El
99	.Sh ENVIRONMENT VARIABLES
100	.Bl -tag -width BLOCKSIZE
101	.It Ev BLOCKSIZE
102	If the environment variable
103	.Ev BLOCKSIZE
104	is set, and the
105	.Fl k
106	option is not specified, the block counts will be displayed in units of that
107	size block.
108	.El
109	.Sh SEE ALSO
110	.Xr quota 1 ,
111	.Xr statfs 2 ,
112	.Xr fstatfs 2 ,
113	.Xr getfsstat 2 ,
114	.Xr getmntinfo 3 ,
115	.Xr fstab 5 ,
116	.Xr mount 8 ,
117	.Xr quot 8
118	.Sh HISTORY
119	A
120	.Nm
121	utility appeared in
122	.At v6 .