1FAXRCVD(8C) FAXRCVD(8C)
2
6 faxrcvd - HylaFAX notification program for received facsimile
7
9 /var/spool/hylafax/bin/faxrcvd qfile devid commid error-msg [ callid-1
10 [ callid-2 [ ... [ callid-n ] ] ] ]
11
13 bin/faxrcvd is the program invoked by the facsimile server whenever a
14 facsimile is received. It is designed to be customizable by the admin‐
15 istrator. (Ideally this is done by creating a customized faxrcvd pro‐
16 gram in a different filename or by copying the default program to a
17 different filename, customizing that new file, and then using FaxRcvd‐
18 Cmd in the modem config file to point faxgetty(8C) at the customized
19 program. See hylafax-config(5F).)
20 The default program sends electronic mail to the FaxMaster user
22 describing the content of the facsimile and other useful information
23 such as the time spent receiving the document. The arguments are:
24 qfile the pathname of the received TIFF file relative to the root
26 of the spooling hierarchy.
27 devid the modem device on which the facsimile was received.
29 commid the communication identifier for the inbound call.
31 error-msg an error message that is non-null if an error was encountered
33 during the receive operation.
34 callid the value of various identification indicators from the call
36
38 This program can route facsimile directly to the intended recipient.
39 To do this create a shell script etc/FaxDispatch in the spooling area
40 that sets SENDTO to the receiver's electronic mail address. For exam‐
41 ple,
42 case "$SENDER" in
44 *1*510*526*1212*) SENDTO=sam;; # Sam's test rig in Berkeley
45 *1*415*390*1212*) SENDTO=raster@asd;; # 7L Xerox room, used for scanning
46 *5107811212) SENDTO=peebles@mti;; # stuff from home
47 esac
48 case "$DEVICE" in
49 ttyS1) SENDTO=john;; # all faxes received on ttyS1
50 ttyLT0) SENDTO=mary@home;; # all faxes received on ttyLT0
51 esac
52 case "$CIDNUMBER" in
53 435*) SENDTO=lee; FILETYPE=pdf;; # all faxes from area code 435
54 5059627777) SENDTO=amy; FILETYPE=tif;; # Amy wants faxes in TIFF
55 esac
56 case "$CALLID4" in
57 7890) SENDTO=user1@domain;; # DID 7890 received at $CALLID4
58 7891) SENDTO=user2@domain;; # DID 7891 received at $CALLID4
59 7892) SENDTO=user3@domain;; # DID 7892 received at $CALLID4
60 esac
61 case "$SUBADDR" in
62 53) SENDTO=FaxMaster;; # without double-notification
63 roger) SENDTO=roger;; # possible text subaddressing
64 esac
65 Note that you must match any embedded white space. The facsimile will
67 be sent as a MIME-encoded PostScript document as default.
68 BCCTO controls the blind copy recipient of the received fax notifica‐
70 tion. It is given as an e-mail address.
71 CALLIDn
73 is equivalent to the nth call identification parameter
74 CCTO controls the copy recipient of the received fax notification.
76 It is given as an e-mail address.
77 CIDNAME
79 is equivalent to CALLID2 above.
80 CIDNUMBER
82 is equivalent to CALLID1 above.
83 DEVICE is equivalent to device above.
85 FILETYPE
87 controls the filetype of the image attachment. Current filetype
88 options are ``ps'', ``tif'', ``pdf'', and ``none''. Multiple
89 values may be specified by separating them with whitespace. In
90 that case a separate attachment is created for each filetype.
91 FROMADDR
93 controls the sender of the received fax notification. It is
94 given as an e-mail address.
95 LANG controls the localization of the text of the received fax noti‐
97 fication.
98 MSG is equivalent to error-msg above.
100 NOTIFY_FAXMASTER
102 (an underscore ``_'' character is between NOTIFY and FAXMASTER)
103 indicates whether or not the HylaFAX administrator should be
104 notified regarding incoming facsimile. Default is ``always''.
105 Also available are ``never'', which means to never send any
106 received facsimile notification, and ``errors'', which means to
107 send notification only if there were reception errors.
108 RECV_DATA_CONVERSION
110 Indicates whether TIFF files saved to disk by HylaFAX should be
111 converted in place to another compression data format. At this
112 time the only available option is ``JBIG:MMR'' which causes TIFF
113 files using JBIG compression to be converted to 2D-MMR (G4) com‐
114 pression. Since the majority of TIFF file viewers lack JBIG sup‐
115 port, this setting may be useful if JBIG-compressed fax receiv‐
116 ing is enabled (see ``Class1JBIGSupport'' config option) and the
117 received fax files are to be directly accessed by users, either
118 through HylaFAX clients such as WHFC or via a shared directory.
119 Note that if the received faxes are viewed/accessed only as
120 email attachments then there's no need to use this setting: TIFF
121 email attachments are automatically sent as 2D-MMR (G4) when the
122 on disk compression data format is JBIG.
123 SENDER is the received TSI of the fax sender.
125 SENDTO controls the recipient of the received fax notification. It is
127 given as an e-mail address. To indicate multiple recipients
128 SENDTO should be given a list of addresses separated by white‐
129 space.
130 SUBADDR
132 the received subaddress value, communicated by the sender for
133 post-reception routing purposes
134 Other shell variables are available. Consult the faxrcvd script
136 directly.
137
139 /var/spool/hylafax spooling area
140 /usr/sbin/faxinfo for printing information about the facsimile
141 /usr/bin/fax2ps for converting TIFF to PostScript
142 /usr/sbin/sendmail for delivering mail
143
145 faxd(8C), hylafax-server(5F), recvq(5F)
146 May 28, 2001 FAXRCVD(8C)