aboutsummaryrefslogtreecommitdiff
path: root/man/join.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/join.1
parent7fa396c9ef22b32a0b05e94aaa0266dd3e7515f8 (diff)
parent6a2f098e72e71437154ec00506e8e736aa8e1026 (diff)
downloadbnu-9846f087eb28bf11df740675ef487657ded39b69.tar.gz
bnu-9846f087eb28bf11df740675ef487657ded39b69.zip
Merge branch 'master' into refactor/single-call-commandsrefactor/single-call-commands
# Conflicts: # README.md
Diffstat (limited to 'man/join.1')
-rw-r--r--man/join.1104
1 files changed, 104 insertions, 0 deletions
diff --git a/man/join.1 b/man/join.1
new file mode 100644
index 0000000..1ecada6
--- /dev/null
+++ b/man/join.1
@@ -0,0 +1,104 @@
+.\" Adapted for BNU from the GNU Coreutils 9.11 manual page; see doc/README.md.
+.TH JOIN "1" "2026-07-28" "BNU 9.11" "BNU Commands"
+.SH NAME
+join \- join lines of two files on a common field
+.SH SYNOPSIS
+.B join
+[\fI\,OPTION\/\fR]... \fI\,FILE1 FILE2\/\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
+For each pair of input lines with identical join fields, write a line to
+standard output. The default join field is the first, delimited by blanks.
+.PP
+When FILE1 or FILE2 (not both) is \-, read standard input.
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join-a'\fB\-a FILENUM\fP\X'tty: link'
+also print unpairable lines from file FILENUM,
+where FILENUM is 1 or 2, corresponding to FILE1 or FILE2
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join-e'\fB\-e STRING\fP\X'tty: link'
+replace missing (empty) input fields with STRING;
+I.e., missing fields specified with '\-12jo' options
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join-i'\fB\-i, \-\-ignore\-case\fP\X'tty: link'
+ignore differences in case when comparing fields
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join-j'\fB\-j FIELD\fP\X'tty: link'
+equivalent to '\-1 FIELD \fB\-2\fR FIELD'
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join-o'\fB\-o FORMAT\fP\X'tty: link'
+obey FORMAT while constructing output line
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join-t'\fB\-t CHAR\fP\X'tty: link'
+use CHAR as input and output field separator
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join-v'\fB\-v FILENUM\fP\X'tty: link'
+like \fB\-a\fR FILENUM, but suppress joined output lines
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join-1'\fB\-1 FIELD\fP\X'tty: link'
+join on this FIELD of file 1
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join-2'\fB\-2 FIELD\fP\X'tty: link'
+join on this FIELD of file 2
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join--check-order'\fB\-\-check\-order\fP\X'tty: link'
+check that the input is correctly sorted, even
+if all input lines are pairable
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join--nocheck-order'\fB\-\-nocheck\-order\fP\X'tty: link'
+do not check that the input is correctly sorted
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join--header'\fB\-\-header\fP\X'tty: link'
+treat the first line in each file as field headers,
+print them without trying to pair them
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/manual/coreutils.html#join-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/join#join--help'\fB\-\-help\fP\X'tty: link'
+display this help and exit
+.TP
+\X'tty: link https://www.gnu.org/software/coreutils/join#join--version'\fB\-\-version\fP\X'tty: link'
+output version information and exit
+.PP
+Unless \fB\-t\fR CHAR is given, leading blanks separate fields and are ignored,
+else fields are separated by CHAR. Any FIELD is a field number counted
+from 1. FORMAT is one or more comma or blank separated specifications,
+each being 'FILENUM.FIELD' or '0'. Default FORMAT outputs the join field,
+the remaining fields from FILE1, the remaining fields from FILE2, all
+separated by CHAR. If FORMAT is the keyword 'auto', then the first
+line of each file determines the number of fields output for each line.
+.PP
+Important: FILE1 and FILE2 must be sorted on the join fields.
+E.g., use "sort \fB\-k\fR 1b,1" if 'join' has no options,
+or use "join \fB\-t\fR ''" if 'sort' has no options.
+Comparisons honor the rules specified by 'LC_COLLATE'.
+If the input is not sorted and some lines cannot be joined, a
+warning message will be given.
+.SH AUTHORS
+Upstream GNU Coreutils documentation authors:
+Written by Mike Haertel.
+.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"
+\fBcomm\fP(1), \fBuniq\fP(1)
+.PP
+.br
+Upstream documentation <https://www.gnu.org/software/coreutils/join>
+.br
+BNU documentation is available locally via: info \(aq(bnu) join invocation\(aq