.\" $HeadURL$ $LastChangedRevision$
.TH IOFDB-OUTER-JOIN-OF-INNER-JOINED-KEYS 1 "ADE_APP_TOKEN_RELEASE_DATE_MAN"
.SH NAME
iofdb-outer-join-of-inner-joined-keys \- Perform an outer join on the subsets of two ASCII tables defined by those records whose primary keys appear in an inner join of the same two tables
.br
.ne 5
.SH SYNOPSIS
.B iofdb-outer-join-of-inner-joined-keys
[
.B \-V
|
.B \-\-version
] [
.B \-v
|
.B \-\-verbose
|
.B \-d
.I level
|
.B \-\-debug=\fIlevel\fR 
] [
.B \-h
|
.B \-\-help
] [
.B \-p
|
.B \-\-list\-paths
] 
[
.B \-t
.I separator
]
[
.B \-1
.I fieldindex
]
[
.B \-2
.I fieldindex
]
[
.B \-\-display\-format 
.I displayformat
]
.I file1
.I file2
.br
.ne 5
.SH DESCRIPTION
.B Iofdb-outer-join-of-inner-joined-keys
performs an outer join on those subsets of 
.I file1
and 
.I file2
defined by those records whose primary keys appear in an inner join of the same two files.
.br
.ne 5
.SH CONFIGURATION
None.
.br
.ne 5
.SH OPTIONS
.TP 25
.B \-1 \fIfieldindex\fR
Specify which field in the first table is used for the initial
inner join. Numbering starts at 1. It is expected that this will 
be the primary key.
.TP
.B \-2 \fIfieldindex\fR
Specify which field in the second table is used for the initial
inner join. Numbering starts at 1. It is expected that this will 
be the primary key.
.TP
.B \-d \fIlevel\fR, \fB\-\-debug=\fIlevel\fR
Determines how verbose
.B iofdb-outer-join-of-inner-joined-keys
will be. The message types displayed for the different values of 
.I level
are as follows:
.RS 25
.TP 5
.B 0
internal errors only
.TP
.B 1
internal errors and normal errors 
.TP
.B 2
internal errors, normal errors and warnings
.TP 
.B 3
internal errors, normal errors, warnings and informational messages
.TP 
.B >3
all the above plus application-specific debug messages.
.RE
.TP
.B \-\-display\-format=\fIdisplayformat\R
sets the format of records display: 
.B K12
(the default) displays the key field's value followed by the
entire corresponding record from 
.I file1\fR,
followed by the entire corresponding record from 
.I file2\fR;
.B 1
displays the entire record from
.I file1\fR
(making actually a left join);
.B 2
displays the entire record from
.I file2\fR
(making actually a right join).
.TP
.B \-h\fR, \fB\-\-help
Displays a brief usage message.
.TP
.B \-p\fR, \fB\-\-list\-paths
List the compiled-in paths of various files and directories that
.B iofdb-outer-join-of-inner-joined-keys
uses.
.TP
.B \-t\fI separator\fR
Specifies the field separator used to separate fields in records in both tables.
.TP 
.B \-v\fR, \fB\-\-verbose
Equivalent to
.B \-d 3\fR.
.TP
.B \-V\fR, \fB\-\-version
Print the program's version number and exit.
.br
.ne 5
.SH EXIT STATUS
On success
.B iofdb-outer-join-of-inner-joined-keys
returns zero. On failure it returns non-zero and displays a diagnostic
message.
.br
.ne 5
.SH FILES
None.
.br
.ne 5
.SH ENVIRONMENT VARIABLES
None.
.br
.ne 5
.SH EXAMPLES
None.
.br
.ne 5
.SH CAVEATS
.B Iofdb-outer-join-of-inner-joined-keys 
is intended only to be called by 
.B iofdb\fR(1),
not by humans.
.br
.ne 5
.SH STANDARDS
This manual page documents version ADE_APP_TOKEN_RELEASE_ID of
.B iofdb-outer-join-of-inner-joined-keys\fR.
.br
.ne 5
.SH SEE ALSO
iofdb(1)
.br
.ne 5
.SH AUTHOR
ADE_APP_TOKEN_AUTHOR_NAME <ADE_APP_TOKEN_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2004-ADE_APP_TOKEN_RELEASE_YEAR ADE_APP_TOKEN_AUTHOR_NAME
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.