.\"  $HeadURL$ $LastChangedRevision$
.\"
.TH FADCAT 1 "18 January 2004"
.ne 5
.SH NAME
fadcat \- Concatenate FAD files
.br
.ne 5
.SH SYNOPSIS
.B fadcat
[
.B \-V
|
.B \-\-version
] [
.B \-v
|
.B \-\-verbose
|
.B \-d
.I level
|
.B \-\-debug=\fIlevel
] [
.B \-h
|
.B \-\-help
] [
.B \-p
|
.B \-\-list\-paths
] 
[
.B \-o
.I outfile 
|
.B \-\-file=\fIoutfile
] [
.B \-g 
.I regexp
|
.B \-\-grep=\fIregexp
] [
.I infile \fR ...
]
.br
.ne 5
.SH DESCRIPTION
This manual page documents version SPPSYM_RELEASE_ID of
.B fadcat\fR.
.PP
.B Fadcat
reads the contents of FAD files whose names are specified by 
.I infile\fR,
or it reads standard input if no names are supplied. It 
concatenates the input files, in much the same manner
as 
.B cat\fR(1))
and writes the result to standard output.
.PP
.B Fadcat
can read and write plain files or files compressed with 
either
.B compress\fR(1)
or 
.B gzip\fR(1), 
but only if they have the correct file extension and are
specified on the command line, rather than fed through
standard input.
.br
.ne 5
.SH CONFIGURATION
None.
.br
.ne 5
.SH OPTIONS
.TP 25
.B \-d \fIlevel\fR, \fB\-\-debug=\fIlevel\fR
Determines how verbose
.B fadcat
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 \-g\fR, \fB\-\-grep=\fIregexp\fR
output only those lines which match the specified Perl regular
expression (see
.B perlre\fR(1)).
.TP
.B \-h\fR, \fB\-\-help
Displays a brief usage message.
.TP
.B \-o,\fR, \fB\-\-file=\fIoutfile
Writes the database to 
.I outfile\fR.
The default is to write to standard output.
.TP
.B \-p\fR, \fB\-\-list\-paths
List the compiled-in paths of various files and directories that
.B fadcat
uses.
.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 fadcat
returns zero. On failure it returns non-zero and displays a diagnostic
message.
.br
.ne 5
.SH FILES
.TP 25
.B /var/tmp/fadcat.\fIpid\fB.*
temporary file used to delegate sorting to 
.B sort\fR(1)
.br
.ne 5
.SH ENVIRONMENT VARIABLES
None.
.br
.ne 5
.SH EXAMPLES
The following command merges two FAD files, saving the result:
.IP
.nf
.fam C
.B fadcat file1.fad file2.fad > fad3.fad
.fam T
.fi
.br
.PP
This will extract records from fad3.fad for files
whose name contains the text \(oqfoo', formatting
it into a correctly headered FAD file and send
it to file \(oqfoo.fad':
.IP
.nf
.fam C
.B fadcat -g foo -o foo.fad fad3.fad
.fam T
.fi
.br
.ne 5
.SH CAVEATS
None.
.br
.ne 5
.SH SEE ALSO
perlre(1), fad(5), find(1), faddiff(1), compress(1), gzip(1), cat(1)
.br
.ne 5
.SH AUTHOR
SPPSYM_AUTHOR_NAME <SPPSYM_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 1995-SPPSYM_RELEASE_YEAR SPPSYM_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.