aboutsummaryrefslogtreecommitdiff
path: root/man/df.1
diff options
context:
space:
mode:
authorSoccera1 <[email protected]>2026-07-28 16:08:14 +1000
committerSoccera1 <[email protected]>2026-07-28 16:08:48 +1000
commit9846f087eb28bf11df740675ef487657ded39b69 (patch)
treee91dbd19b524f9432da6bcb86b1fc193e0d02e26 /man/df.1
parent7fa396c9ef22b32a0b05e94aaa0266dd3e7515f8 (diff)
parent6a2f098e72e71437154ec00506e8e736aa8e1026 (diff)
downloadbnu-refactor/single-call-commands.tar.gz
bnu-refactor/single-call-commands.zip
Merge branch 'master' into refactor/single-call-commandsrefactor/single-call-commands
# Conflicts: # README.md
Diffstat (limited to 'man/df.1')
-rw-r--r--man/df.1127
1 files changed, 127 insertions, 0 deletions
diff --git a/man/df.1 b/man/df.1
new file mode 100644
index 0000000..0abe7a4
--- /dev/null
+++ b/man/df.1
@@ -0,0 +1,127 @@
+.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md.
+.TH DF "1" "2026-07-28" "BNU 9.11" "BNU Commands"
+.SH NAME
+df \- report file system space usage
+.SH SYNOPSIS
+.B df
+[\fI\,OPTION\/\fR]... [\fI\,FILE\/\fR]...
+.SH DESCRIPTION
+.\" This page is derived from GNU Coreutils documentation.
+This page documents BNU, an independent Bun implementation compatible with
+GNU Coreutils 9.11.
+This manual page
+describes the BNU implementation of
+.BR df .
+.B df
+displays the amount of space available on the file system
+containing each file name argument. If no file name is given, the
+space available on all currently mounted file systems is shown.
+Space is shown in 1K blocks by default, unless the environment
+variable POSIXLY_CORRECT is set, in which case 512-byte blocks are
+used.
+.PP
+If an argument is the absolute file name of a device node containing a
+mounted file system,
+.B df
+shows the space available on that file system rather than on the
+file system containing the device node. This version of
+.B df
+cannot show the space available on unmounted file systems, because on
+most kinds of systems doing so requires non-portable intimate
+knowledge of file system structures.
+.SH OPTIONS
+.PP
+Show information about the file system on which each FILE resides,
+or all file systems by default.
+.PP
+Mandatory arguments to long options are mandatory for short options too.
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df-a'\fB\-a, \-\-all\fP\X'tty: link'
+include pseudo, duplicate, inaccessible file systems
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df-B'\fB\-B, \-\-block\-size=\,SIZE\fP\X'tty: link'\/\fR
+scale sizes by SIZE before printing them; see SIZE format below;
+E.g., '\-BM' prints sizes in units of 1,048,576 bytes
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df-h'\fB\-h, \-\-human\-readable\fP\X'tty: link'
+print sizes in powers of 1024 (e.g., 1023M)
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df-H'\fB\-H, \-\-si\fP\X'tty: link'
+print sizes in powers of 1000 (e.g., 1.1G)
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df-i'\fB\-i, \-\-inodes\fP\X'tty: link'
+list inode information instead of block usage
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df-k'\fB\-k\fP\X'tty: link'
+like \fB\-\-block\-size\fR=\fI\,1K\/\fR
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df-l'\fB\-l, \-\-local\fP\X'tty: link'
+limit listing to local file systems
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df--no-sync'\fB\-\-no\-sync\fP\X'tty: link'
+do not invoke sync before getting usage info (default)
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df--output'\fB\-\-output[=FIELD_LIST]\fP\X'tty: link'
+use the output format defined by FIELD_LIST,
+or print all fields if FIELD_LIST is omitted
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df-P'\fB\-P, \-\-portability\fP\X'tty: link'
+use the POSIX output format
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df--sync'\fB\-\-sync\fP\X'tty: link'
+invoke sync before getting usage info
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df--total'\fB\-\-total\fP\X'tty: link'
+elide all entries insignificant to available space,
+and produce a grand total
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df-t'\fB\-t, \-\-type=\,TYPE\fP\X'tty: link'\/\fR
+limit listing to file systems of type TYPE
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df-T'\fB\-T, \-\-print\-type\fP\X'tty: link'
+print file system type
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df-x'\fB\-x, \-\-exclude\-type=\,TYPE\fP\X'tty: link'\/\fR
+limit listing to file systems not of type TYPE
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#df-v'\fB\-v\fP\X'tty: link'
+(ignored)
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/df#df--help'\fB\-\-help\fP\X'tty: link'
+display this help and exit
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/df#df--version'\fB\-\-version\fP\X'tty: link'
+output version information and exit
+.PP
+Display values are in units of the first available SIZE from \fB\-\-block\-size\fR,
+and the DF_BLOCK_SIZE, BLOCK_SIZE and BLOCKSIZE environment variables.
+Otherwise, units default to 1024 bytes (or 512 if POSIXLY_CORRECT is set).
+.PP
+The SIZE argument is an integer and optional unit (example: 10K is 10*1024).
+Units are K,M,G,T,P,E,Z,Y,R,Q (powers of 1024) or KB,MB,... (powers of 1000).
+Binary prefixes can be used, too: KiB=K, MiB=M, and so on.
+.PP
+FIELD_LIST is a comma\-separated list of columns to be included. Valid
+field names are: 'source', 'fstype', 'itotal', 'iused', 'iavail', 'ipcent',
+\&'size', 'used', 'avail', 'pcent', 'file' and 'target' (see info page).
+.SH AUTHORS
+Upstream GNU Coreutils documentation authors:
+Written by Torbjorn Granlund, David MacKenzie, and Paul Eggert.
+.br
+Adapted for BNU; the BNU implementation is independent.
+.SH "REPORTING BUGS"
+Report BNU bugs at <https://github.com/Soccera1/bnu/issues>.
+.br
+For upstream GNU Coreutils, see <https://www.gnu.org/software/coreutils/>.
+.SH COPYRIGHT
+Copyright \(co 2026 Free Software Foundation, Inc.
+.br
+This manual page was adapted for BNU in 2026.
+License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
+.br
+This is free software: you are free to change and redistribute it.
+There is NO WARRANTY, to the extent permitted by law.
+.SH "SEE ALSO"
+Upstream documentation <https://www.gnu.org/software/coreutils/df>
+.br
+BNU documentation is available locally via: info \(aq(bnu) df invocation\(aq