NetBSD/bin/df/df.1

.\"	$NetBSD: df.1,v 1.13 1996/12/11 03:48:42 thorpej 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 df
.Op Fl ikln
.Op Fl t Ar type
.Op Ar file | Ar file_system ...
.Sh DESCRIPTION
.Nm Df
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 df
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 df
utility appeared in
.At v6 .
Make df(1) more liberal (and intelligent) about what it accepts as arguments (for -t and -l flags, specifically). From Hubert Feyrer <feyrer@rfhs8002.fh-regensburg.de>, PR #2869. 1996-12-11 06:48:42 +03:00			`.\" $NetBSD: df.1,v 1.13 1996/12/11 03:48:42 thorpej Exp $`
convert to new RCS id conventions. 1995-03-21 12:01:59 +03:00			`.\"`
Deal with large file systems, and clean up a bit. 1994-09-17 00:59:27 +04:00			`.\" Copyright (c) 1989, 1990, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" 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.`
			`.\"`
convert to new RCS id conventions. 1995-03-21 12:01:59 +03:00			`.\" @(#)df.1 8.2 (Berkeley) 1/13/92`
added rcs ids to all files 1993-03-22 11:04:00 +03:00			`.\"`
Deal with large file systems, and clean up a bit. 1994-09-17 00:59:27 +04:00			`.Dd January 13, 1994`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt DF 1`
			`.Os BSD 4`
			`.Sh NAME`
			`.Nm df`
			`.Nd display free disk space`
			`.Sh SYNOPSIS`
			`.Nm df`
Add `-l' option. 1994-03-11 06:07:27 +03:00			`.Op Fl ikln`
Add `-t' option from Matthew Green, hacked a bit by me. 1995-01-14 02:23:41 +03:00			`.Op Fl t Ar type`
			`.Op Ar file \| Ar file_system ...`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh DESCRIPTION`
			`.Nm Df`
			`displays statistics about the amount of free disk space on the specified`
Add `-t' option from Matthew Green, hacked a bit by me. 1995-01-14 02:23:41 +03:00			`.Ar file_system`
			`or on the file system of which`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Ar file`
			`is a part.`
Deal with large file systems, and clean up a bit. 1994-09-17 00:59:27 +04:00			`Values are displayed in 512-byte per block block counts.`
Add `-t' option from Matthew Green, hacked a bit by me. 1995-01-14 02:23:41 +03:00			`If neither a file or a`
			`.Ar file_system`
			`operand is specified,`
			`statistics for all mounted file systems are displayed`
Deal with large file systems, and clean up a bit. 1994-09-17 00:59:27 +04:00			`(subject to the`
			`.Fl l`
Add `-t' option from Matthew Green, hacked a bit by me. 1995-01-14 02:23:41 +03:00			`and`
			`.Fl t`
			`options below).`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.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.`
Add `-l' option. 1994-03-11 06:07:27 +03:00			`.It Fl l`
Add `-t' option from Matthew Green, hacked a bit by me. 1995-01-14 02:23:41 +03:00			`Display statistics only about mounted file systems with the MNT_LOCAL`
Make df(1) more liberal (and intelligent) about what it accepts as arguments (for -t and -l flags, specifically). From Hubert Feyrer <feyrer@rfhs8002.fh-regensburg.de>, PR #2869. 1996-12-11 06:48:42 +03:00			`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.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.It Fl n`
Add `-t' option from Matthew Green, hacked a bit by me. 1995-01-14 02:23:41 +03:00			`Print out the previously obtained statistics from the file systems.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`This option should be used if it is possible that one or more`
Add `-t' option from Matthew Green, hacked a bit by me. 1995-01-14 02:23:41 +03:00			`file systems are in a state such that they will not be able to provide`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`statistics without a long delay.`
			`When this option is specified,`
			`.Nm df`
Add `-t' option from Matthew Green, hacked a bit by me. 1995-01-14 02:23:41 +03:00			`will not request new statistics from the file systems, but will respond`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`with the possibly stale statistics that were previously obtained.`
Document the `-t' option as in umount(8). 1995-01-30 21:14:55 +03:00			`.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`
Make df(1) more liberal (and intelligent) about what it accepts as arguments (for -t and -l flags, specifically). From Hubert Feyrer <feyrer@rfhs8002.fh-regensburg.de>, PR #2869. 1996-12-11 06:48:42 +03:00			`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.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.El`
ENVIRONMENTAL -> ENVIRONMENT 1995-12-05 05:41:35 +03:00			`.Sh ENVIRONMENT VARIABLES`
Incorporate new version using getbsize(), with -k flag added. 1993-08-06 21:05:08 +04:00			`.Bl -tag -width BLOCKSIZE`
			`.It Ev BLOCKSIZE`
ENVIRONMENTAL -> ENVIRONMENT 1995-12-05 05:41:35 +03:00			`If the environment variable`
Incorporate new version using getbsize(), with -k flag added. 1993-08-06 21:05:08 +04:00			`.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`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.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 df`
Use "utility" instead of "command". Modern definitions of these terms are distinct (See POSIX.2 glossary). A utility is a executable, script or shell builtin; while a command can be any of those things plus lists, pipelines, compound commands (if, for, while) and shell function definitions. 1995-07-25 23:36:36 +04:00			`utility appeared in`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.At v6 .`