aboutsummaryrefslogtreecommitdiff
path: root/man/head.1
diff options
context:
space:
mode:
authorSoccera1 <[email protected]>2026-07-28 15:54:54 +1000
committerSoccera1 <[email protected]>2026-07-28 15:54:54 +1000
commit6a2f098e72e71437154ec00506e8e736aa8e1026 (patch)
tree63e9f5596be38558dbeb40bb566735759a3ccabb /man/head.1
parenta753f669c9bedfccb9f7f400da018bb487dca5d0 (diff)
downloadbnu-6a2f098e72e71437154ec00506e8e736aa8e1026.tar.gz
bnu-6a2f098e72e71437154ec00506e8e736aa8e1026.zip
Add docs
Diffstat (limited to 'man/head.1')
-rw-r--r--man/head.170
1 files changed, 70 insertions, 0 deletions
diff --git a/man/head.1 b/man/head.1
new file mode 100644
index 0000000..7341727
--- /dev/null
+++ b/man/head.1
@@ -0,0 +1,70 @@
+.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md.
+.TH HEAD "1" "2026-07-28" "BNU 9.11" "BNU Commands"
+.SH NAME
+head \- output the first part of files
+.SH SYNOPSIS
+.B head
+[\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.
+.PP
+Print the first 10 lines of each FILE to standard output.
+With more than one FILE, precede each with a header giving the file name.
+.PP
+With no FILE, or when FILE is \-, read standard input.
+.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#head-c'\fB\-c, \-\-bytes=\,[\-]NUM\fP\X'tty: link'\/\fR
+print the first NUM bytes of each file;
+with the leading '\-', print all but the last NUM bytes of each file
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#head-n'\fB\-n, \-\-lines=\,[\-]NUM\fP\X'tty: link'\/\fR
+print the first NUM lines instead of the first 10;
+with the leading '\-', print all but the last NUM lines of each file
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#head-q'\fB\-q, \-\-quiet, \-\-silent\fP\X'tty: link'
+never print headers giving file names
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#head-v'\fB\-v, \-\-verbose\fP\X'tty: link'
+always print headers giving file names
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#head-z'\fB\-z, \-\-zero\-terminated\fP\X'tty: link'
+line delimiter is NUL, not newline
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/head#head--help'\fB\-\-help\fP\X'tty: link'
+display this help and exit
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/head#head--version'\fB\-\-version\fP\X'tty: link'
+output version information and exit
+.PP
+NUM may have a multiplier suffix:
+b 512, kB 1000, K 1024, MB 1000*1000, M 1024*1024,
+GB 1000*1000*1000, G 1024*1024*1024, and so on for T, P, E, Z, Y, R, Q.
+Binary prefixes can be used, too: KiB=K, MiB=M, and so on.
+.SH AUTHORS
+Upstream GNU Coreutils documentation authors:
+Written by David MacKenzie and Jim Meyering.
+.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"
+\fBtail\fP(1)
+.PP
+.br
+Upstream documentation <https://www.gnu.org/software/coreutils/head>
+.br
+BNU documentation is available locally via: info \(aq(bnu) head invocation\(aq