.\"	$Id$
.\"
.\" HylaFAX Facsimile Software
.\"
.\" Copyright (c) 1995-1996 Sam Leffler
.\" Copyright (c) 1995-1996 Silicon Graphics, Inc.
.\" HylaFAX is a trademark of Silicon Graphics
.\" 
.\" Permission to use, copy, modify, distribute, and sell this software and 
.\" its documentation for any purpose is hereby granted without fee, provided
.\" that (i) the above copyright notices and this permission notice appear in
.\" all copies of the software and related documentation, and (ii) the names of
.\" Sam Leffler and Silicon Graphics may not be used in any advertising or
.\" publicity relating to the software without the specific, prior written
.\" permission of Sam Leffler and Silicon Graphics.
.\" 
.\" THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
.\" EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
.\" WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
.\" 
.\" IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
.\" ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
.\" OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
.\" WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
.\" LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
.\" OF THIS SOFTWARE.
.\"
.if n .po 0
.ds Fx \fIHyla\s-1FAX\s+1\fP
.TH FAXINFO 8 "November 15, 1996"
.SH NAME
faxinfo \- print information about a received facsimile
.SH SYNOPSIS
Basic usage:
.PP
.B /usr/sbin/faxinfo
[
.B \-b
] [
.B \-n
] [
.B \-D
]
.I file.tif
[
.I file2.tif
[...] ]
.PP
Formatting shortcuts:
.PP
.B /usr/sbin/faxinfo
[
.B \-C delim
|
.B \-c delim
|
.B \-r
]
.I file.tif
[
.I file2.tif
] ]
.PP
Raw formatting:
.PP
.B /usr/sbin/faxinfo
[
.B \-S
fmt ] [
.B \-s
fmt ] [
.B \-e
fmt ] [
.B \-E
fmt ]
.I file.tif
[
.I file2.tif
] ]
.SH DESCRIPTION
.I faxinfo
prints descriptive information on the standard output
about a received facsimile file.
For example:
.sp
.nf
.RS
\s-1\fC/var/spool/hylafax/recvq/fax00017.tif:
    Sender: +14159657824
     Pages: 3
   Quality: Normal
      Page: North American Letter
  Received: 1996:01:19 13:51:02
TimeToRecv: 0:39
SignalRate: 14400 bit/s
DataFormat: 2-D MR\fP\s+1
ErrCorrect: No
   CallID1: 2152345678
   CallID2: 1234
.RE
.fi
.PP
This information is typically included in the notification
mail generated by the
.IR faxrcvd (8)
script when a facsimile is received by \*(Fx.
.PP
.TP
.B \-n
suppresses the printing of the filename.
.TP
.B \-b
strips any leading directory of the filename before printing
.TP
.B \-D
prints the actual print strings being used for debug purposes
.PP
Formatting shortcuts:
.TP
.B \-C delim
Sets the format to a quoted CSV, shortcut to
.nf
\-S '"%s"' \-s ',"' \-e '"' \-E '\\n'
.fi
.TP
.B \-c delim
Sets the format to a CSV, shortcut to:
.nf
\-S '%s' \-s ',' \-e '' \-E '\\n'
.fi
.TP
.B \-r
Sets the format to raw values, shortcut to:
.nf
\-S '' \-s '' \-e '\n' \-E ''
.fi
.PP
Raw formating:
.TP
.B \-S fmt
used to start each fax, it is passed one parameter, the fax file name
.TP
.B \-s fmt
used to start each field, it is passed one parameter, the field name
.TP
.B \-e fmt
used to end each field, it is passed one parameter, the field name
.TP
.B \-E fmt
used to end each fax, it is passed one parameter, the fax file name
.SH NOTES
The information that
.I faxinfo
prints is obtained from the tags stored in the
.SM TIFF
image that is written by the \*(Fx software.
If 
.I faxinfo
is presented with an invalid 
.SM TIFF
image it may print uninteresting information.
Similarly if a
.SM TIFF
image that was not written by \*(Fx is supplied as an argument
then only partial information may be printed\(emthis is
because \*(Fx stores certain information in private tags that
other 
.SM TIFF
writers may not emit.
.PP
Use of the raw 
.I fmt
options to allow you to directly control the print format
strings used when formating the output.  These format strings are passed directly
to printf, with basic \\<char> sequences being interpreted, including \\n, \\r, 
and \\t, and can be used to make the faxinfo output conform to specific requirements,
like peculiar CVS, tables, HTML, etc.
.PP
The order of the options is important.  They are parsed from first to last, so any
later options will override settings of previous ones.
.SH ERRORS
.I faxinfo
return
.B 0
on success and
.B 1
if the file passed as argument is not valid.
.SH "SEE ALSO"
.IR hylafax-server (5),
.IR faxrcvd (8),
.IR faxgetty (8)