summaryrefslogtreecommitdiffstats
path: root/man/join.1
blob: b3a8fa49b7555813a639c92bc77e0963d71ba15a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.5.
.TH JOIN "1" "August 2023" "GNU coreutils 9.4" "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 STRING
replace missing (empty) input fields with STRING;
I.e., missing fields specified with '\-12jo' options
.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 2023 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"
\fBcomm\fP(1), \fBuniq\fP(1)
.PP
.br
Full documentation <https://www.gnu.org/software/coreutils/join>
.br
or available locally via: info \(aq(coreutils) join invocation\(aq