1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
.\" $Id: faxrcvd.1m,v 1.9 2004/02/01 03:28:58 lhoward Exp $
.\"
.\" HylaFAX Facsimile Software
.\"
.\" Copyright (c) 1993-1996 Sam Leffler
.\" Copyright (c) 1993-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 FAXRCVD ${MANNUM1_8} "May 28, 2001"
.SH NAME
faxrcvd \- \*(Fx notification script for received facsimile
.SH SYNOPSIS
.B ${SPOOL}/bin/faxrcvd
.I qfile
.I devid
.I commid
.I error-msg
.I cidnumber
.I cidname
.SH DESCRIPTION
.B bin/faxrcvd
is the command script invoked by the facsimile server whenever
a facsimile is received.
The default script sends electronic mail to the
.I FaxMaster
user describing the content of the facsimile and other useful information
such as the time spent receiving the document.
The arguments are:
.TP 10
.B qfile
the pathname of the received
.SM TIFF
file relative to the root of the spooling hierarchy.
.TP
.B devid
the modem device on which the facsimile was received.
.TP
.B commid
the communication identifier for the inbound call.
.TP
.B error-msg
an error message that is non-null if an error was encountered
during the receive operation.
.TP
.B cidnumber
the value of
.B CIDNumber
when using
.B QualifyCID
.TP
.B cidname
the value of
.B CIDName
when using
.B QualifyCID
.SH NOTES
This script can route facsimile directly to the intended receipient.
To do this create a shell script
.B etc/FaxDispatch
in the spooling area that sets
.I SENDTO
to the receiver's electronic mail address. For example,
.sp
.nf
.ft C
\s-1case "$SENDER" in
*1*510*526*1212*) SENDTO=sam;; # Sam's test rig in Berkeley
*1*415*390*1212*) SENDTO=raster@asd;; # 7L Xerox room, used for scanning
*5107811212) SENDTO=peebles@mti;; # stuff from home
esac
case "$DEVICE" in
ttyS1) SENDTO=john;; # all faxes received on ttyS1
ttyLT0) SENDTO=mary@home;; # all faxes received on ttyLT0
esac
case "$CIDNUMBER" in
435*) SENDTO=lee; FILETYPE=pdf;; # all faxes from area code 435
5059627777) SENDTO=amy; FILETYPE=tif;; # Amy wants faxes in TIFF
esac\s+1
case "$SUBADDR" in
53) SENDTO=FaxMaster;; # without double-notification
roger) SENDTO=roger;; # possible text subaddressing
esac\s+1
.ft R
.fi
.sp
Note that you must match any embedded white space.
The facsimile will be sent as a MIME-encoded PostScript document
as default.
.TP
.I CIDNAME
is equivalent to
.B CIDName
above.
.TP
.I CIDNUMBER
is equivalent to
.B CIDNumber
above.
.TP
.I DEVICE
is equivalent to
.B device
above.
.TP
.I FILETYPE
controls the filetype of the image attachment. Current
filetype options are ``ps'', ``tif'', and ``pdf''.
.TP
.I FROMADDR
controls the sender of the received fax notification. It is
given as an e-mail address.
.TP
.I MSG
is equivalent to
.B error-msg
above.
.TP
.I NOTIFY_FAXMASTER
(an underscore ``_'' character is between NOTIFY and FAXMASTER)
indicates whether or not the HylaFAX administrator should be notified
regarding incoming facsimile. Default is ``always''. Also available are
``never'', which means to never send any received facsimile notification,
and ``errors'', which means to send notification only if there were
reception errors.
.TP
.I SENDER
is the received TSI of the fax sender.
.TP
.I SENDTO
controls the recipient of the received fax notification. It is
given as an e-mail address.
.TP
.I SUBADDR
the received subaddress value, communicated by the sender for
post-reception routing purposes
.TP
Other shell variables are available. Consult the faxrcvd script directly.
.SH FILES
.nf
.ta \w'${SBIN}/faxinfo 'u
${SPOOL} spooling area
${SBIN}/faxinfo for printing information about the facsimile
${TIFFBIN}/fax2ps for converting \s-1TIFF\s+1 to PostScript
${SENDMAIL} for delivering mail
.fi
.SH "SEE ALSO"
.IR faxd (${MANNUM1_8}),
.IR hylafax-server (${MANNUM4_5}),
.IR recvq (${MANNUM4_5})
|
