Df (Unix)
{{lowercase}}
{{short description|Shell command for reporting available file system space}}
{{Infobox software
| name = df
| logo =
| screenshot = Df-example-command-gimp.gif
| screenshot size =
| caption = Example usage of {{code|df}}
| author = Ken Thompson,
Dennis Ritchie
(AT&T Bell Laboratories)
| developer = Various open-source and commercial developers
| released = {{Start date and age|1971|11|3|df=y}}
| latest release version =
| latest release date =
| operating system = Unix, Unix-like
| platform = Cross-platform
| genre = Command
| website =
}}
df
, short for disk free, is a shell command for reporting the amount of available storage space on file systems on which the user has read access. {{code|df}} is typically implemented using the {{code|statfs()}} or {{code|statvfs()}} system calls.
The Single Unix Specification (SUS) specifies that space is reported in blocks of 512 bytes, and that at a minimum, it reports the file system names and the amount of free space.
Using 512-bytes as the unit of measure is a historical practice and maintains compatibility with ls
and other commands. Notably, the file system need not be constrained to internally use 512-byte blocks. The {{code|-k}} option was added as a compromise measure. It was agreed by the standard developers that 512 bytes was the best default unit because of its complete historical consistency on System V (versus the mixed 512/1024-byte usage on BSD systems), and that a {{code|-k}} option to switch to 1024-byte units was a good compromise. Users who prefer the more logical 1024-byte quantity can use alias
to map {{code|df}} to {{code|df -k}} without breaking many historical scripts relying on the 512-byte units.
The output with {{code|-P}} consists of one line of information for each specified file system, like:
{{angbr|fs name}} {{angbr|total space}} {{angbr|space used}} {{angbr|space free}} {{angbr|percentage used}} {{angbr|fs root}}
where:
;{{angbr|fs name}}
:The name of the file system, in an implementation-defined format.
;{{angbr|total space}}
:The total size of the file system in block size units. The exact meaning of this figure is implementation-defined, but should include {{angbr|space used}}, {{angbr|space free}}, plus any space reserved by the system not normally available to a user.
;{{angbr|space used}}
:The total amount of space allocated to existing files in the file system, in block size units.
;{{angbr|space free}}
:The total amount of space available within the file system for the creation of new files by unprivileged users, in block size units. When this figure is less than or equal to zero, it shall not be possible to create any new files on the file system without first deleting others, unless the process has appropriate privileges. The figure written may be less than zero.
;{{angbr|percentage used}}
:The percentage of the normally available space that is currently allocated to all files on the file system. This shall be calculated using the fraction:
::{{sfrac|{{angbr|space used}}|({{angbr|space used}} + {{angbr|space free}})}}
:expressed as a percentage. This percentage may be greater than 100 if {{angbr|space free}} is less than zero. The percentage value shall be expressed as a positive integer, with any fractional result causing it to be rounded to the next highest integer.
;{{angbr|fs root}}
:The directory below which the file system hierarchy appears
History
The command first appeared in Version 1 AT&T Unix.{{man|1|df|FreeBSD}} The command is part of the X/Open Portability Guide since issue 2 of 1987. It was inherited into the first version of POSIX and the Single Unix Specification (SUS).{{man|cu|df|SUS}} The implementation of {{code|df}} bundled in GNU coreutils was written by Torbjorn Granlund, David MacKenzie, and Paul Eggert.{{man|1|df|ManKier}} The command is available for Windows via UnxUtils.{{Cite web|url=http://unxutils.sourceforge.net/|title=Native Win32 ports of some GNU utilities|website=unxutils.sourceforge.net}}
Use
SUS specifies syntax:
df [-k] [-P|-t] [-del] [file...]
;{{code|-k}}
:Use 1024-byte units, instead of the default 512-byte units, when writing space figures
;{{code|-P}}
:Use a standard, portable, output format
;{{code|file}}
:Select the storage for the file system containing the specified file
Most implementations include extra options. The BSD and GNU coreutils versions include {{code|-h}} (human-readable) which selects to format sizes in metric units (e.g. 10 MB), {{code|-i}} which lists inode usage, and {{code|-l}} which restricts reporting to local filesystems. The GNU implementation includes {{code|-T}} which includes filesystem type information.
Examples
Example output from the {{code|df}} command:
$ df
Filesystem 1K-blocks Used Available Use% Mounted on
udev 48764976 0 48764976 0% /dev
tmpfs 9757068 173100 9583968 2% /run
/dev/sda2 1824504008 723009800 1008791744 42% /
tmpfs 48785328 0 48785328 0% /dev/shm
tmpfs 5120 0 5120 0% /run/lock
tmpfs 48785328 0 48785328 0% /sys/fs/cgroup
/dev/sda1 523248 3672 519576 1% /boot/efi
$ df -i
Filesystem Inodes IUsed IFree IUse% Mounted on
udev 12191244 500 12190744 1% /dev
tmpfs 12196332 702 12195630 1% /run
/dev/sda2 115859456 2583820 113275636 3% /
tmpfs 12196332 1 12196331 1% /dev/shm
tmpfs 12196332 5 12196327 1% /run/lock
tmpfs 12196332 16 12196316 1% /sys/fs/cgroup
/dev/sda1 0 0 0 - /boot/efi
$ df -h
Filesystem Size Used Avail Use% Mounted on
udev 47G 0 47G 0% /dev
tmpfs 9.4G 170M 9.2G 2% /run
/dev/sda2 1.7T 690G 963G 42% /
tmpfs 47G 0 47G 0% /dev/shm
tmpfs 5.0M 0 5.0M 0% /run/lock
tmpfs 47G 0 47G 0% /sys/fs/cgroup
/dev/sda1 511M 3.6M 508M 1% /boot/efi
See also
- {{Annotated link|du (Unix)}}
- {{Annotated link|List of POSIX commands}}
References
{{Reflist}}
External links
{{Wikibooks|Guide to Unix|Commands}}
- {{man|cu|df|SUS|report free disk space}}
=Manual pages=
- [https://www.gnu.org/software/coreutils/manual/html_node/df-invocation.html df] — manual page from GNU coreutils
- {{man|1|df|OpenBSD|display free disk space}}
- [http://www.linfo.org/df.html The df Command] – by The Linux Information Project (LINFO)
{{Unix commands}}
{{Core Utilities commands}}