usr.bin/join/join.1

   1 .\" Copyright (c) 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the Institute of Electrical and Electronics Engineers, Inc.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 4. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)join.1      8.3 (Berkeley) 4/28/95
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd July 5, 2004
  35 .Dt JOIN 1
  36 .Os
  37 .Sh NAME
  38 .Nm join
  39 .Nd relational database operator
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Oo
  43 .Fl a Ar file_number | Fl v Ar file_number
  44 .Oc
  45 .Op Fl e Ar string
  46 .Op Fl o Ar list
  47 .Op Fl t Ar char
  48 .Op Fl 1 Ar field
  49 .Op Fl 2 Ar field
  50 .Ar file1
  51 .Ar file2
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 utility performs an
  56 .Dq equality join
  57 on the specified files
  58 and writes the result to the standard output.
  59 The
  60 .Dq join field
  61 is the field in each file by which the files are compared.
  62 The first field in each line is used by default.
  63 There is one line in the output for each pair of lines in
  64 .Ar file1
  65 and
  66 .Ar file2
  67 which have identical join fields.
  68 Each output line consists of the join field, the remaining fields from
  69 .Ar file1
  70 and then the remaining fields from
  71 .Ar file2 .
  72 .Pp
  73 The default field separators are tab and space characters.
  74 In this case, multiple tabs and spaces count as a single field separator,
  75 and leading tabs and spaces are ignored.
  76 The default output field separator is a single space character.
  77 .Pp
  78 Many of the options use file and field numbers.
  79 Both file numbers and field numbers are 1 based, i.e., the first file on
  80 the command line is file number 1 and the first field is field number 1.
  81 The following options are available:
  82 .Bl -tag -width indent
  83 .It Fl a Ar file_number
  84 In addition to the default output, produce a line for each unpairable
  85 line in file
  86 .Ar file_number .
  87 .It Fl e Ar string
  88 Replace empty output fields with
  89 .Ar string .
  90 .It Fl o Ar list
  91 The
  92 .Fl o
  93 option specifies the fields that will be output from each file for
  94 each line with matching join fields.
  95 Each element of
  96 .Ar list
  97 has either the form
  98 .Ar file_number . Ns Ar field ,
  99 where
 100 .Ar file_number
 101 is a file number and
 102 .Ar field
 103 is a field number, or the form
 104 .Ql 0
 105 .Pq zero ,
 106 representing the join field.
 107 The elements of list must be either comma
 108 .Pq Ql \&,
 109 or whitespace separated.
 110 (The latter requires quoting to protect it from the shell, or, a simpler
 111 approach is to use multiple
 112 .Fl o
 113 options.)
 114 .It Fl t Ar char
 115 Use character
 116 .Ar char
 117 as a field delimiter for both input and output.
 118 Every occurrence of
 119 .Ar char
 120 in a line is significant.
 121 .It Fl v Ar file_number
 122 Do not display the default output, but display a line for each unpairable
 123 line in file
 124 .Ar file_number .
 125 The options
 126 .Fl v Cm 1
 127 and
 128 .Fl v Cm 2
 129 may be specified at the same time.
 130 .It Fl 1 Ar field
 131 Join on the
 132 .Ar field Ns 'th
 133 field of
 134 .Ar file1 .
 135 .It Fl 2 Ar field
 136 Join on the
 137 .Ar field Ns 'th
 138 field of
 139 .Ar file2 .
 140 .El
 141 .Pp
 142 When the default field delimiter characters are used, the files to be joined
 143 should be ordered in the collating sequence of
 144 .Xr sort 1 ,
 145 using the
 146 .Fl b
 147 option, on the fields on which they are to be joined, otherwise
 148 .Nm
 149 may not report all field matches.
 150 When the field delimiter characters are specified by the
 151 .Fl t
 152 option, the collating sequence should be the same as
 153 .Xr sort 1
 154 without the
 155 .Fl b
 156 option.
 157 .Pp
 158 If one of the arguments
 159 .Ar file1
 160 or
 161 .Ar file2
 162 is
 163 .Sq Fl ,
 164 the standard input is used.
 165 .Sh EXIT STATUS
 166 .Ex -std
 167 .Sh COMPATIBILITY
 168 For compatibility with historic versions of
 169 .Nm ,
 170 the following options are available:
 171 .Bl -tag -width indent
 172 .It Fl a
 173 In addition to the default output, produce a line for each unpairable line
 174 in both
 175 .Ar file1
 176 and
 177 .Ar file2 .
 178 .It Fl j1 Ar field
 179 Join on the
 180 .Ar field Ns 'th
 181 field of
 182 .Ar file1 .
 183 .It Fl j2 Ar field
 184 Join on the
 185 .Ar field Ns 'th
 186 field of
 187 .Ar file2 .
 188 .It Fl j Ar field
 189 Join on the
 190 .Ar field Ns 'th
 191 field of both
 192 .Ar file1
 193 and
 194 .Ar file2 .
 195 .It Fl o Ar list ...
 196 Historical implementations of
 197 .Nm
 198 permitted multiple arguments to the
 199 .Fl o
 200 option.
 201 These arguments were of the form
 202 .Ar file_number . Ns Ar field_number
 203 as described
 204 for the current
 205 .Fl o
 206 option.
 207 This has obvious difficulties in the presence of files named
 208 .Pa 1.2 .
 209 .El
 210 .Pp
 211 These options are available only so historic shell scripts do not require
 212 modification and should not be used.
 213 .Sh SEE ALSO
 214 .Xr awk 1 ,
 215 .Xr comm 1 ,
 216 .Xr paste 1 ,
 217 .Xr sort 1 ,
 218 .Xr uniq 1
 219 .Sh STANDARDS
 220 The
 221 .Nm
 222 command conforms to
 223 .St -p1003.1-2001 .