summaryrefslogtreecommitdiffstats
path: root/man/join.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 17:39:29 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 17:39:29 +0000
commit8ffec2a3aba6f114784e11f89ef1d57a096ae540 (patch)
treeccebcbad06203e8241a8e7249f8e6c478a3682ea /man/join.1
parentInitial commit. (diff)
downloadcoreutils-8ffec2a3aba6f114784e11f89ef1d57a096ae540.tar.xz
coreutils-8ffec2a3aba6f114784e11f89ef1d57a096ae540.zip
Adding upstream version 8.32.upstream/8.32upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man/join.1')
-rw-r--r--man/join.196
1 files changed, 96 insertions, 0 deletions
diff --git a/man/join.1 b/man/join.1
new file mode 100644
index 0000000..abfdf4d
--- /dev/null
+++ b/man/join.1
@@ -0,0 +1,96 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3.
+.TH JOIN "1" "March 2020" "GNU coreutils 8.32" "User 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
+.\" Add any additional description here
+.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
+\fB\-a\fR FILENUM
+also print unpairable lines from file FILENUM, where
+FILENUM is 1 or 2, corresponding to FILE1 or FILE2
+.TP
+\fB\-e\fR EMPTY
+replace missing input fields with EMPTY
+.TP
+\fB\-i\fR, \fB\-\-ignore\-case\fR
+ignore differences in case when comparing fields
+.TP
+\fB\-j\fR FIELD
+equivalent to '\-1 FIELD \fB\-2\fR FIELD'
+.TP
+\fB\-o\fR FORMAT
+obey FORMAT while constructing output line
+.TP
+\fB\-t\fR CHAR
+use CHAR as input and output field separator
+.TP
+\fB\-v\fR FILENUM
+like \fB\-a\fR FILENUM, but suppress joined output lines
+.TP
+\fB\-1\fR FIELD
+join on this FIELD of file 1
+.TP
+\fB\-2\fR FIELD
+join on this FIELD of file 2
+.TP
+\fB\-\-check\-order\fR
+check that the input is correctly sorted, even
+if all input lines are pairable
+.TP
+\fB\-\-nocheck\-order\fR
+do not check that the input is correctly sorted
+.TP
+\fB\-\-header\fR
+treat the first line in each file as field headers,
+print them without trying to pair them
+.TP
+\fB\-z\fR, \fB\-\-zero\-terminated\fR
+line delimiter is NUL, not newline
+.TP
+\fB\-\-help\fR
+display this help and exit
+.TP
+\fB\-\-version\fR
+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.
+Note, 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 AUTHOR
+Written by Mike Haertel.
+.SH "REPORTING BUGS"
+GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
+.br
+Report any translation bugs to <https://translationproject.org/team/>
+.SH COPYRIGHT
+Copyright \(co 2020 Free Software Foundation, Inc.
+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"
+comm(1), uniq(1)
+.PP
+.br
+Full documentation <https://www.gnu.org/software/coreutils/join>
+.br
+or available locally via: info \(aq(coreutils) join invocation\(aq