aboutsummaryrefslogtreecommitdiff
path: root/man/pr.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/pr.1
parenta753f669c9bedfccb9f7f400da018bb487dca5d0 (diff)
downloadbnu-6a2f098e72e71437154ec00506e8e736aa8e1026.tar.gz
bnu-6a2f098e72e71437154ec00506e8e736aa8e1026.zip
Add docs
Diffstat (limited to 'man/pr.1')
-rw-r--r--man/pr.1136
1 files changed, 136 insertions, 0 deletions
diff --git a/man/pr.1 b/man/pr.1
new file mode 100644
index 0000000..aa421f0
--- /dev/null
+++ b/man/pr.1
@@ -0,0 +1,136 @@
+.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md.
+.TH PR "1" "2026-07-28" "BNU 9.11" "BNU Commands"
+.SH NAME
+pr \- convert text files for printing
+.SH SYNOPSIS
+.B pr
+[\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
+Paginate or columnate FILE(s) for printing.
+.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#pr--pages'\fB+FIRST_PAGE[:LAST_PAGE], \-\-pages=\,FIRST_PAGE[:LAST_PAGE]\fP\X'tty: link'\/\fR
+begin [stop] printing with page FIRST_[LAST_]PAGE
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-COLS'\fB\-COLS, \-\-columns=\,COLS\fP\X'tty: link'\/\fR
+output COLS columns and print columns down, unless \fB\-a\fR is used.
+Balance number of lines in the columns on each page
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-a'\fB\-a, \-\-across\fP\X'tty: link'
+print columns across rather than down, used together with \fB\-COLS\fR
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-c'\fB\-c, \-\-show\-control\-chars\fP\X'tty: link'
+use hat notation (^G) and octal backslash notation
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-d'\fB\-d, \-\-double\-space\fP\X'tty: link'
+double space the output
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-D'\fB\-D, \-\-date\-format=\,FORMAT\fP\X'tty: link'\/\fR
+use FORMAT for the header date
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-e'\fB\-e[CHAR[WIDTH]], \-\-expand\-tabs[=\,CHAR[WIDTH]]\fP\X'tty: link'\/\fR
+expand input CHARs (TABs) to tab WIDTH (8)
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-F'\fB\-F, \-f, \-\-form\-feed\fP\X'tty: link'
+use form feeds instead of newlines to separate pages
+(by a 3\-line page header with \fB\-F\fR or a 5\-line header
+and trailer without \fB\-F\fR)
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-h'\fB\-h, \-\-header=\,HEADER\fP\X'tty: link'\/\fR
+use a centered HEADER instead of filename in page header,
+\fB\-h\fR "" prints a blank line, don't use \fB\-h\fR""
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-i'\fB\-i[CHAR[WIDTH]], \-\-output\-tabs[=\,CHAR[WIDTH]]\fP\X'tty: link'\/\fR
+replace spaces with CHARs (TABs) to tab WIDTH (8)
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-J'\fB\-J, \-\-join\-lines\fP\X'tty: link'
+merge full lines, turns off \fB\-W\fR line truncation,
+no column alignment, \fB\-\-sep\-string\fR[=\fI\,STRING\/\fR] sets separators
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-l'\fB\-l, \-\-length=\,PAGE_LENGTH\fP\X'tty: link'\/\fR
+set the page length to PAGE_LENGTH (66) lines
+(default number of lines of text 56, and with \fB\-F\fR 63).
+implies \fB\-t\fR if PAGE_LENGTH <= 10
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-m'\fB\-m, \-\-merge\fP\X'tty: link'
+print all files in parallel, one in each column,
+truncate lines, but join lines of full length with \fB\-J\fR
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-n'\fB\-n[SEP[DIGITS]], \-\-number\-lines[=\,SEP[DIGITS]]\fP\X'tty: link'\/\fR
+number lines, use DIGITS (5) digits, then SEP (TAB),
+default counting starts with 1st line of input file
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-N'\fB\-N, \-\-first\-line\-number=\,NUMBER\fP\X'tty: link'\/\fR
+start counting with NUMBER at 1st line of first
+page printed (see +FIRST_PAGE)
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-o'\fB\-o, \-\-indent=\,MARGIN\fP\X'tty: link'\/\fR
+offset each line with MARGIN (zero) spaces, do not
+affect \fB\-w\fR or \fB\-W\fR, MARGIN will be added to PAGE_WIDTH
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-r'\fB\-r, \-\-no\-file\-warnings\fP\X'tty: link'
+omit warning when a file cannot be opened
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-s'\fB\-s[CHAR], \-\-separator[=\,CHAR]\fP\X'tty: link'\/\fR
+separate columns by a single character, default for CHAR
+is the <TAB> character without \fB\-w\fR and 'no char' with \fB\-w\fR.
+\fB\-s\fR[\fI\,CHAR\/\fR] turns off line truncation of all 3 column
+options (\fB\-COLS\fR|\-a \fB\-COLS\fR|\-m) except \fB\-w\fR is set
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-S'\fB\-S[STRING], \-\-sep\-string[=\,STRING]\fP\X'tty: link'\/\fR
+separate columns by STRING,
+without \fB\-S\fR: Default separator <TAB> with \fB\-J\fR and <space>
+otherwise (same as \fB\-S\fR" "), no effect on column options
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-t'\fB\-t, \-\-omit\-header\fP\X'tty: link'
+omit page headers and trailers; implied if PAGE_LENGTH <= 10
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-T'\fB\-T, \-\-omit\-pagination\fP\X'tty: link'
+omit page headers and trailers,
+eliminate any pagination by form feeds set in input files
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-v'\fB\-v, \-\-show\-nonprinting\fP\X'tty: link'
+use octal backslash notation
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-w'\fB\-w, \-\-width=\,PAGE_WIDTH\fP\X'tty: link'\/\fR
+set page width to PAGE_WIDTH (72) characters for
+multiple text\-column output only, \fB\-s\fR[\fI\,char\/\fR] turns off (72)
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#pr-W'\fB\-W, \-\-page\-width=\,PAGE_WIDTH\fP\X'tty: link'\/\fR
+set page width to PAGE_WIDTH (72) characters always,
+truncate lines, except \fB\-J\fR option is set,
+no interference with \fB\-S\fR or \fB\-s\fR
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/pr#pr--help'\fB\-\-help\fP\X'tty: link'
+display this help and exit
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/pr#pr--version'\fB\-\-version\fP\X'tty: link'
+output version information and exit
+.SH AUTHORS
+Upstream GNU Coreutils documentation authors:
+Written by Pete TerMaat and Roland Huebner.
+.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/pr>
+.br
+BNU documentation is available locally via: info \(aq(bnu) pr invocation\(aq