1FAXINFO(8C)                                                        FAXINFO(8C)
2
3
4

NAME

6       faxinfo - print information about a received facsimile
7

SYNOPSIS

9       Basic usage:
10
11       /usr/sbin/faxinfo [ -b ] [ -n ] [ -D ] file.tif [ file2.tif [...] ]
12
13       Formatting shortcuts:
14
15       /usr/sbin/faxinfo  [  -C  delim  | -c delim | -r ] file.tif [ file2.tif
16       [...] ]
17
18       Raw formatting:
19
20       /usr/sbin/faxinfo [ -S fmt ] [ -s fmt ] [ -e fmt ] [ -E fmt ]  file.tif
21       [ file2.tif [...] ]
22

DESCRIPTION

24       faxinfo  prints  descriptive information on the standard output about a
25       received facsimile file.  For example:
26
27              /var/spool/hylafax/recvq/fax00017.tif:
28                  Sender: +14159657824
29                   Pages: 3
30                 Quality: Normal
31                    Page: North American Letter
32                Received: 1996:01:19 13:51:02
33              TimeToRecv: 0:39
34              SignalRate: 14400 bit/s
35              DataFormat: 2-D MR
36              ErrCorrect: No
37                 CallID1: 4159657824
38                 CallID2: 1000
39
40       This information is typically included in the notification mail  gener‐
41       ated by the faxrcvd(8C) script when a facsimile is received by HylaFAX.
42
43       -n     suppresses the printing of the filename.
44
45       -b     strips any leading directory of the filename before printing
46
47       -D     prints the actual print strings being used for debug purposes
48
49       Formatting shortcuts:
50
51       -C delim
52              Sets the format to a quoted CSV, shortcut to
53              -S '"%s"' -s ',"' -e '"' -E '\n'
54
55       -c delim
56              Sets the format to a CSV, shortcut to:
57              -S '%s' -s ',' -e '' -E '\n'
58
59       -r     Sets the format to raw values, shortcut to:
60              -S '' -s '' -e '0 -E ''
61
62       Raw formating:
63
64       -S fmt used to start each fax, it is passed one parameter, the fax file
65              name
66
67       -s fmt used to start each field, it is passed one parameter, the  field
68              name
69
70       -e fmt used  to  end  each field, it is passed one parameter, the field
71              name
72
73       -E fmt used to end each fax, it is passed one parameter, the  fax  file
74              name
75

NOTES

77       The information that faxinfo prints is obtained from the tags stored in
78       the TIFF image that is written by the HylaFAX software.  If faxinfo  is
79       presented  with an invalid TIFF image it may print uninteresting infor‐
80       mation.  Similarly if a TIFF image that was not written by  HylaFAX  is
81       supplied  as  an argument then only partial information may be printed—
82       this is because HylaFAX stores certain information in private tags that
83       other TIFF writers may not emit.
84
85       Use  of  the  raw fmt options allows direct control of the print format
86       strings used to format the output.  These  format  strings  are  passed
87       directly  to  printf,  with  basic \<char> sequences being interpreted,
88       including \n, \r, and \t, and can be used to make the output conform to
89       specific requirements, like peculiar CVS, tables, HTML, etc.
90
91       The  order  of the options is important.  They are parsed from first to
92       last, and any later options will override settings of previous ones.
93

ERRORS

95       faxinfo returns 0 on success and 1 if the file passed  as  argument  is
96       not valid.
97

SEE ALSO

99       hylafax-server(5F), faxrcvd(8C), faxgetty(8C)
100
101
102
103                               November 15, 1996                   FAXINFO(8C)