original/man1/join.1

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
   2 .TH JOIN "1" "January 2016" "GNU coreutils 8.25" "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 EMPTY
  21 replace missing input fields with EMPTY
  22 .TP
  23 \fB\-i\fR, \fB\-\-ignore\-case\fR
  24 ignore differences in case when comparing fields
  25 .TP
  26 \fB\-j\fR FIELD
  27 equivalent to '\-1 FIELD \fB\-2\fR FIELD'
  28 .TP
  29 \fB\-o\fR FORMAT
  30 obey FORMAT while constructing output line
  31 .TP
  32 \fB\-t\fR CHAR
  33 use CHAR as input and output field separator
  34 .TP
  35 \fB\-v\fR FILENUM
  36 like \fB\-a\fR FILENUM, but suppress joined output lines
  37 .TP
  38 \fB\-1\fR FIELD
  39 join on this FIELD of file 1
  40 .TP
  41 \fB\-2\fR FIELD
  42 join on this FIELD of file 2
  43 .TP
  44 \fB\-\-check\-order\fR
  45 check that the input is correctly sorted, even
  46 if all input lines are pairable
  47 .TP
  48 \fB\-\-nocheck\-order\fR
  49 do not check that the input is correctly sorted
  50 .TP
  51 \fB\-\-header\fR
  52 treat the first line in each file as field headers,
  53 print them without trying to pair them
  54 .TP
  55 \fB\-z\fR, \fB\-\-zero\-terminated\fR
  56 line delimiter is NUL, not newline
  57 .TP
  58 \fB\-\-help\fR
  59 display this help and exit
  60 .TP
  61 \fB\-\-version\fR
  62 output version information and exit
  63 .PP
  64 Unless \fB\-t\fR CHAR is given, leading blanks separate fields and are ignored,
  65 else fields are separated by CHAR.  Any FIELD is a field number counted
  66 from 1.  FORMAT is one or more comma or blank separated specifications,
  67 each being 'FILENUM.FIELD' or '0'.  Default FORMAT outputs the join field,
  68 the remaining fields from FILE1, the remaining fields from FILE2, all
  69 separated by CHAR.  If FORMAT is the keyword 'auto', then the first
  70 line of each file determines the number of fields output for each line.
  71 .PP
  72 Important: FILE1 and FILE2 must be sorted on the join fields.
  73 E.g., use "sort \fB\-k\fR 1b,1" if 'join' has no options,
  74 or use "join \fB\-t\fR ''" if 'sort' has no options.
  75 Note, comparisons honor the rules specified by 'LC_COLLATE'.
  76 If the input is not sorted and some lines cannot be joined, a
  77 warning message will be given.
  78 .SH AUTHOR
  79 Written by Mike Haertel.
  80 .SH "REPORTING BUGS"
  81 GNU coreutils online help: <http://www.gnu.org/software/coreutils/>
  82 .br
  83 Report join translation bugs to <http://translationproject.org/team/>
  84 .SH COPYRIGHT
  85 Copyright \(co 2016 Free Software Foundation, Inc.
  86 License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.
  87 .br
  88 This is free software: you are free to change and redistribute it.
  89 There is NO WARRANTY, to the extent permitted by law.
  90 .SH "SEE ALSO"
  91 comm(1), uniq(1)
  92 .PP
  93 .br
  94 Full documentation at: <http://www.gnu.org/software/coreutils/join>
  95 .br
  96 or available locally via: info \(aq(coreutils) join invocation\(aq