faxrcvd.1m
上传用户:weiyuanprp
上传日期:2020-05-20
资源大小:1169k
文件大小:7k
源码类别:

传真(Fax)编程

开发平台:

C/C++

  1. ." $Id: faxrcvd.1m,v 1.8 2009/02/15 03:54:55 faxguy Exp $
  2. ."
  3. ." HylaFAX Facsimile Software
  4. ."
  5. ." Copyright (c) 1993-1996 Sam Leffler
  6. ." Copyright (c) 1993-1996 Silicon Graphics, Inc.
  7. ." HylaFAX is a trademark of Silicon Graphics
  8. ." 
  9. ." Permission to use, copy, modify, distribute, and sell this software and 
  10. ." its documentation for any purpose is hereby granted without fee, provided
  11. ." that (i) the above copyright notices and this permission notice appear in
  12. ." all copies of the software and related documentation, and (ii) the names of
  13. ." Sam Leffler and Silicon Graphics may not be used in any advertising or
  14. ." publicity relating to the software without the specific, prior written
  15. ." permission of Sam Leffler and Silicon Graphics.
  16. ." 
  17. ." THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, 
  18. ." EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY 
  19. ." WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.  
  20. ." 
  21. ." IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
  22. ." ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
  23. ." OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  24. ." WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF 
  25. ." LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 
  26. ." OF THIS SOFTWARE.
  27. ."
  28. .if n .po 0
  29. .ds Fx fIHylas-1FAXs+1fP
  30. .TH FAXRCVD ${MANNUM1_8} "May 28, 2001"
  31. .SH NAME
  32. faxrcvd - *(Fx notification script for received facsimile
  33. .SH SYNOPSIS
  34. .B ${SPOOL}/bin/faxrcvd
  35. .I qfile
  36. .I devid
  37. .I commid
  38. .I error-msg
  39. [
  40. .I callid-1
  41. [
  42. .I callid-2
  43. [
  44. .I ...
  45. [
  46. .I callid-n
  47. ] ] ] ]
  48. .SH DESCRIPTION
  49. .B bin/faxrcvd
  50. is the command script invoked by the facsimile server whenever
  51. a facsimile is received.  It is designed to be customizable by the
  52. administrator.  (Ideally this is done by creating a customized faxrcvd script
  53. in a different filename or by copying the default script to a different filename,
  54. customizing that new file, and then using
  55. .B FaxRcvdCmd
  56. in the modem config file to point
  57. .IR faxgetty (${MANNUM1_8})
  58. at the customized script.  See
  59. .IR hylafax-config (${MANNUM4_5}).)
  60. .P
  61. The default script sends electronic mail to the 
  62. .I FaxMaster
  63. user describing the content of the facsimile and other useful information
  64. such as the time spent receiving the document.
  65. The arguments are:
  66. .TP 10
  67. .B qfile
  68. the pathname of the received 
  69. .SM TIFF
  70. file relative to the root of the spooling hierarchy.
  71. .TP
  72. .B devid
  73. the modem device on which the facsimile was received.
  74. .TP 
  75. .B commid
  76. the communication identifier for the inbound call.
  77. .TP
  78. .B error-msg
  79. an error message that is non-null if an error was encountered
  80. during the receive operation.
  81. .TP
  82. .B callid
  83. the value of various identification indicators from the call
  84. .SH NOTES
  85. This script can route facsimile directly to the intended recipient.
  86. To do this create a shell script
  87. .B etc/FaxDispatch
  88. in the spooling area that sets
  89. .I SENDTO
  90. to the receiver's electronic mail address.  For example,
  91. .sp
  92. .nf
  93. .ft C
  94. s-1case "$SENDER" in
  95. *1*510*526*1212*) SENDTO=sam;;          # Sam's test rig in Berkeley
  96. *1*415*390*1212*) SENDTO=raster@asd;;   # 7L Xerox room, used for scanning
  97. *5107811212)      SENDTO=peebles@mti;;  # stuff from home
  98. esac
  99. case "$DEVICE" in
  100. ttyS1)            SENDTO=john;;         # all faxes received on ttyS1
  101. ttyLT0)           SENDTO=mary@home;;    # all faxes received on ttyLT0
  102. esac
  103. case "$CIDNUMBER" in
  104. 435*)        SENDTO=lee; FILETYPE=pdf;; # all faxes from area code 435
  105. 5059627777)  SENDTO=amy; FILETYPE=tif;; # Amy wants faxes in TIFF
  106. esacs+1
  107. case "$SUBADDR" in
  108. 53)          SENDTO=FaxMaster;;         # without double-notification
  109. roger)       SENDTO=roger;;             # possible text subaddressing
  110. esacs+1
  111. .ft R
  112. .fi
  113. .sp
  114. Note that you must match any embedded white space.
  115. The facsimile will be sent as a MIME-encoded PostScript document
  116. as default.
  117. .TP
  118. .I BCCTO
  119. controls the blind copy recipient of the received fax notification.  It is
  120. given as an e-mail address.
  121. .TP
  122. .I CALLIDn
  123. is equivalent to the nth call identification parameter
  124. .TP
  125. .I CCTO
  126. controls the copy recipient of the received fax notification.  It is
  127. given as an e-mail address.
  128. .TP
  129. .I CIDNAME
  130. is equivalent to
  131. .B CALLID2
  132. above.
  133. .TP
  134. .I CIDNUMBER
  135. is equivalent to
  136. .B CALLID1
  137. above.
  138. .TP
  139. .I DEVICE
  140. is equivalent to
  141. .B device
  142. above.
  143. .TP
  144. .I FILETYPE
  145. controls the filetype of the image attachment.  Current
  146. filetype options are ``ps'', ``tif'', and ``pdf''.
  147. Multiple values may be specified by separating them with
  148. whitespace. In that case a separate attachment is created
  149. for each filetype.
  150. .TP
  151. .I FROMADDR
  152. controls the sender of the received fax notification.  It is
  153. given as an e-mail address.
  154. .TP
  155. .I LANG
  156. controls the localization of the text of the received fax notification.
  157. .TP
  158. .I MSG
  159. is equivalent to
  160. .B error-msg
  161. above.
  162. .TP
  163. .I NOTIFY_FAXMASTER
  164. (an underscore ``_'' character is between NOTIFY and FAXMASTER)
  165. indicates whether or not the HylaFAX administrator should be notified
  166. regarding incoming facsimile.  Default is ``always''.  Also available are
  167. ``never'', which means to never send any received facsimile notification,
  168. and ``errors'', which means to send notification only if there were
  169. reception errors.
  170. .TP
  171. .I RECV_DATA_CONVERSION
  172. Indicates whether TIFF files saved to disk by HylaFAX should be converted
  173. in place to another compression data format.
  174. At this time the only available option is ``JBIG:2D-MMR'' which causes
  175. TIFF files using JBIG compression to be converted to 2D-MMR (G4)
  176. compression. Since the majority of TIFF file viewers lacks JBIG support,
  177. this setting may be useful if JBIG-compressed fax receiving is enabled
  178. (see ``Class1JBIGSupport'' config option) and the received fax files are
  179. to be directly accessed by users, either through HylaFAX clients such as
  180. WHFC or via a shared directory.
  181. Note that if the received faxes are viewed/accessed only as email
  182. attachments then there's no need to use this setting: TIFF email
  183. attachments are automatically sent as 2D-MMR (G4) when the on disk
  184. compression data format is JBIG.
  185. .TP
  186. .I SENDER
  187. is the received TSI of the fax sender.
  188. .TP
  189. .I SENDTO
  190. controls the recipient of the received fax notification.  It is
  191. given as an e-mail address.  To indicate multiple recipients 
  192. .I SENDTO
  193. should be given a list of addresses separated by whitespace.
  194. .TP
  195. .I SUBADDR
  196. the received subaddress value, communicated by the sender for 
  197. post-reception routing purposes
  198. .TP
  199. Other shell variables are available.  Consult the faxrcvd script directly.
  200. .SH FILES
  201. .nf
  202. .ta w'${SBIN}/faxinfo    'u
  203. ${SPOOL} spooling area
  204. ${SBIN}/faxinfo for printing information about the facsimile
  205. ${TIFFBIN}/fax2ps for converting s-1TIFFs+1 to PostScript
  206. ${SENDMAIL} for delivering mail
  207. .fi
  208. .SH "SEE ALSO"
  209. .IR faxd (${MANNUM1_8}),
  210. .IR hylafax-server (${MANNUM4_5}),
  211. .IR recvq (${MANNUM4_5})