Debian Codegraph @

upstream/debian-trixie/man1/join.1

raw
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.50.1.
2 .TH JOIN "1" "June 2025" "GNU coreutils 9.7" "User Commands"
3 .SH NAME
4 join \- join lines of two files on a common field
5 .SH SYNOPSIS
6 .B join
7 [\fI\,OPTION\/\fR]... \fI\,FILE1 FILE2\/\fR
8 .SH DESCRIPTION
9 .\" Add any additional description here
10 .PP
11 For each pair of input lines with identical join fields, write a line to
12 standard output. The default join field is the first, delimited by blanks.
13 .PP
14 When FILE1 or FILE2 (not both) is \-, read standard input.
15 .TP
16 \fB\-a\fR FILENUM
17 also print unpairable lines from file FILENUM, where
18 FILENUM is 1 or 2, corresponding to FILE1 or FILE2
19 .TP
20 \fB\-e\fR STRING
21 replace missing (empty) input fields with STRING;
22 I.e., missing fields specified with '\-12jo' options
23 .TP
24 \fB\-i\fR, \fB\-\-ignore\-case\fR
25 ignore differences in case when comparing fields
26 .TP
27 \fB\-j\fR FIELD
28 equivalent to '\-1 FIELD \fB\-2\fR FIELD'
29 .TP
30 \fB\-o\fR FORMAT
31 obey FORMAT while constructing output line
32 .TP
33 \fB\-t\fR CHAR
34 use CHAR as input and output field separator
35 .TP
36 \fB\-v\fR FILENUM
37 like \fB\-a\fR FILENUM, but suppress joined output lines
38 .TP
39 \fB\-1\fR FIELD
40 join on this FIELD of file 1
41 .TP
42 \fB\-2\fR FIELD
43 join on this FIELD of file 2
44 .TP
45 \fB\-\-check\-order\fR
46 check that the input is correctly sorted, even
47 if all input lines are pairable
48 .TP
49 \fB\-\-nocheck\-order\fR
50 do not check that the input is correctly sorted
51 .TP
52 \fB\-\-header\fR
53 treat the first line in each file as field headers,
54 print them without trying to pair them
55 .TP
56 \fB\-z\fR, \fB\-\-zero\-terminated\fR
57 line delimiter is NUL, not newline
58 .TP
59 \fB\-\-help\fR
60 display this help and exit
61 .TP
62 \fB\-\-version\fR
63 output version information and exit
64 .PP
65 Unless \fB\-t\fR CHAR is given, leading blanks separate fields and are ignored,
66 else fields are separated by CHAR. Any FIELD is a field number counted
67 from 1. FORMAT is one or more comma or blank separated specifications,
68 each being 'FILENUM.FIELD' or '0'. Default FORMAT outputs the join field,
69 the remaining fields from FILE1, the remaining fields from FILE2, all
70 separated by CHAR. If FORMAT is the keyword 'auto', then the first
71 line of each file determines the number of fields output for each line.
72 .PP
73 Important: FILE1 and FILE2 must be sorted on the join fields.
74 E.g., use "sort \fB\-k\fR 1b,1" if 'join' has no options,
75 or use "join \fB\-t\fR ''" if 'sort' has no options.
76 Comparisons honor the rules specified by 'LC_COLLATE'.
77 If the input is not sorted and some lines cannot be joined, a
78 warning message will be given.
79 .SH AUTHOR
80 Written by Mike Haertel.
81 .SH "REPORTING BUGS"
82 GNU coreutils online help: <https://www.gnu.org/software/coreutils/>
83 .br
84 Report any translation bugs to <https://translationproject.org/team/>
85 .SH "SEE ALSO"
86 \fBcomm\fP(1), \fBuniq\fP(1)
87 .PP
88 .br
89 Full documentation <https://www.gnu.org/software/coreutils/join>
90 .br
91 or available locally via: info \(aq(coreutils) join invocation\(aq
92 .PP
93 .br
94 Packaged by Debian (9.7\-3)
95 .br
96 Copyright \(co 2025 Free Software Foundation, Inc.
97 .br
98 License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
99 .br
100 This is free software: you are free to change and redistribute it.
101 .br
102 There is NO WARRANTY, to the extent permitted by law.