home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD2.bin / bbs / comm / avmnfax-1.33.lha / avmNfax / GNU / efax.man < prev    next >
Text File  |  1994-05-26  |  28KB  |  595 lines
  1. efax - send/receive faxes using Class 1 or 2 fax modems
  2.  
  3. [ ] [ | ]
  4.  
  5.  
  6. Where _o_p_t_i_o_n_s are:
  7.  
  8. use the fax modem  connected  to  device  _d_e_v.   The  default  is
  9. /dev/fax.
  10.  
  11.  
  12. use option _o_p_t to accommodate a non-standard fax modem  protocol.
  13. See  the  MODEM REQUIREMENTS section below for more details.  The
  14. _o_p_tions are:
  15.  
  16.     1 Use Class 1 fax modem  commands.   The  modem  must  suport
  17. Class 1 commands.  The default is to use Class 2 commands.
  18.  
  19.     a use software adaptive answer method.  If the first  attempt
  20. to answer the call does not result in a data connection within 20
  21. seconds the phone is hung up temporarily and  answered  again  in
  22. fax mode (see "Accepting both fax and data calls" below).
  23.  
  24.     e ignore errors in modem initialization commands.  If  errors
  25. are already being ignored, pay attention to them again.
  26.  
  27.     r reverse bit order during data reception.  Most  modems  re-
  28. quire this option.
  29.  
  30.     x send XON (DC1) instead of DC2 to start data reception.  Ap-
  31. plies to Class 2 only.
  32.  
  33.     z delay an additional 100 milliseconds before each modem ini-
  34. tialization  or  reset command.  The initial delay is 100 ms. For
  35. example, -ozzz produces a 400 ms delay.
  36.  
  37.  
  38. send the command AT_s_t_r to the modem to initialize  it.   Multiple
  39. -i may options be used.
  40.  
  41. send the command AT_s_t_r to the modem to reset it when done.   Mul-
  42. tiple -z may options be used.
  43.  
  44. set the local capabilities to _c_a_p_s.  See the section on capabili-
  45. ties  below  for  the format and meaning of _c_a_p_s.  The default is
  46. 1,3,0,2,0,0,0,0. For Class 2 operation this  option  must  appear
  47. after the modem initialization (-i) option that enables fax mode.
  48.  
  49. set the local identification string to _i_d.  _i_d should be the  lo-
  50. cal telephone number in international format (for example "+1 800
  51. 555 1212").  This option must appear after the modem  initializa-
  52. tion (-i) option that enables fax mode.
  53.  
  54. select types of messages to be printed.  Each  _l_o_w_e_r-_c_a_s_e  letter
  55. in _s_t_r_n_g enables one type of message:
  56.  
  57. e - errors
  58. w - warnings
  59. i - session progress information
  60. n - capability negotiation information
  61. c - modem (AT) commands and responses
  62. h - HDLC frame data (Class 1 only)
  63. m - modem output
  64. a - program arguments
  65. r - reception error details
  66.  
  67.  
  68. The default is "ewin".
  69.  
  70. use UUCP-style lock file _l_k_f to  lock  the  modem  device  before
  71. opening  it.   If  the  device  is  locked,  efax checks every 15
  72. seconds until it is free.  Up to 16 -x options  may  be  used  if
  73. there are several names for the same device.  A `#' prefix on the
  74. file name creates an HDB-style (text) lock file.
  75.  
  76. remove lock file(s) after initializing the  modem.   This  allows
  77. outgoing  calls  to proceed.  When efax detects modem activity it
  78. will attempt to re-lock the device.  If the modem is  now  locked
  79. by  another  program  efax will exit and return 1 (``busy'').  If
  80. efax is run again (e.g. by init) it will then wait until the line
  81. becomes free.
  82.  
  83. don't issue an answer (ATA) command before starting to receive  a
  84. fax.  Use this option when the modem is set to auto-answer (using
  85. S0=_n) or if another program has already answered the call.
  86.  
  87. if a CONNECT (or DATA) response indicates a data call, the  shell
  88. /bin/sh  is  exec(2)'ed  with  _c_m_d  as  its  command.   _c_m_d  is a
  89. printf(3) format that may contain up to 6 %d  escapes  which  are
  90. replaced  by the baud rate following the most recent CONNECT mes-
  91. sage. _c_m_d typically exec's getty(8).
  92.  
  93. ask for page retransmission if more than _n errors  detected,  De-
  94. fault is 10.
  95.  
  96.  
  97. answer phone and receive a fax.  Each fax page  is  stored  in  a
  98. separate  file.   The  file  name  is  created  using  _p_a_t  as  a
  99. strftime(3) format string.  A page number of the form .001, .002,
  100.  ... is appended to the file name.  If _p_a_t is blank (""),  a  de-
  101. fault  string of "%m%d%H%M%S" is used.  If a file already exists,
  102. efax terminates with an error message.
  103.  
  104. dial telephone number _n_u_m and send the fax image  files  _f_i_l_e....
  105. The  telephone  number  _n_u_m is a string that may contain any dial
  106. modifiers that the modem supports, for example, a  T  prefix  for
  107. tone dialing or commas for delays.
  108.  
  109.  
  110. Each page is stored in a separate file.  The images are coded ac-
  111. cording  to the ITU-T (CCITT) Group 3 fax standard, T.4.  The EX-
  112. AMPLES section below shows how Ghostscript and the PBMPlus utili-
  113. ties can be used to create and print these files.
  114.  
  115.  
  116. The operating system must provide short response times  to  avoid
  117. protocol  timeouts.   When  using Class 1 modems the program must
  118. respond to certain events (DCS frame or end of  data)  within  55
  119. milliseconds.   For  Class 2 modems the delay should not exceed 1
  120. or 2 seconds.
  121.  
  122. The operating  system  must  also  provide  sufficient  low-level
  123. buffering  to allow uninterrupted transfer of data from the modem
  124. to a disk file at the selected baud  rate,  typically  9600  bps.
  125. Since  the  fax protocol does not provide end-to-end flow control
  126. the effectiveness of flow control while receiving is  limited  by
  127. the  size of the modem's buffer. This can be less than 100 bytes.
  128. Efax does not use flow control during reception.
  129.  
  130.  
  131. "Group" describes the protocol used to send faxes over the  tele-
  132. phone network.  Efax suports the universal Group 3 standard.  The
  133. "Class" is the protocol used between a computer and a fax  modem.
  134. Efax supports Class 1 and 2 (but not 2.0) fax modems.
  135.  
  136. Most modems (including those based on Rockwell  or  Sierra  chip-
  137. sets)  reverse  the bit order (MSB to LSB) on receive.  This will
  138. cause errors when trying to display or print the received  files.
  139. The  -or  option  should  be specified when receiving faxes using
  140. these modems.
  141.  
  142. While all fax modems support XON/XOFF flow control, most have un-
  143. reliable  hardware  (RTS/CTS)  flow  control  in fax mode.  Since
  144. XON/XOFF flow control adds very little overhead in fax mode, efax
  145. does not support hardware flow control.
  146.  
  147. While some modems have serial buffers of  about  1k  bytes,  many
  148. inexpensive  modems  have  buffers of about one hundred bytes and
  149. are thus more likely to suffer overruns when receiving data.
  150.  
  151. Some modems may need a delay between commands of  more  than  the
  152. default  value  used by efax (100 milliseconds).  If the delay is
  153. too short, commands may not echo properly, may time out,  or  may
  154. give  inconsistent responses.  Use one or more -oz options to in-
  155. crease the delay between modem initialization commands.
  156.  
  157. Class 1 modems should not be used on systems that cannot  guaran-
  158. tee  that  the program will respond to incoming data in less than
  159. 55 milliseconds.  Longer delays may cause  the  fax  protocol  to
  160. fail  in  certain  places (between DCS and TCF or between RTC and
  161. MPS).
  162.  
  163. By default efax sends DC2 to start the data flow from  the  modem
  164. when receiving faxes from Class 2 modems.  A few older modems re-
  165. quire XON instead.  Use of DC2 would cause the modem to  give  an
  166. error  message  and/or  the  program to time out.  The -ox option
  167. should be used in this case.
  168.  
  169. A few older Class 2 modems don't send DC2 or  XON  to  start  the
  170. data  flow  to  the  modem  when  sending faxes.  After waiting 2
  171. seconds efax will print a warning and start sending anyways.
  172.  
  173. The following modems have been reported to work with  efax:  AT&T
  174. DataPort,  ATT/Paradyne,  Boca  modem, Cardinal Digital Fax Modem
  175. (14400) (Class 1), Crosslink 9614FH faxmodem, FuryCard DNE  5005,
  176. Intel  14.4  fax  modem,  MultiTech 1432MU, Practical Peripherals
  177. PM14400FXMT, Supra V32bis, Supra Faxmodem 144LC (Class 1),  Tele-
  178. bit Worldblazer, Twincom 144/DFi, Vobis Fax-Modem (BZT-approved),
  179. Zoom VFX14.4V (Class 1 and 2), ZyXEL U-1496E[+].
  180.  
  181.  
  182.  
  183. Modem initialization commands are supplied as command-line  argu-
  184. ments.
  185.  
  186. The modem must be set up to  issue  verbose(text)  result  codes.
  187. The following command does this:
  188.  
  189. respond to commands with verbose result codes
  190.  
  191. The following commands may be useful in some cases:
  192.  
  193. don't wait for dial tone before dialing.  This  may  be  used  to
  194. send  a  fax  when the call has already been dialed manually.  In
  195. this case use an empty string ("") as the first argument  to  the
  196. -t command.  Use X4 (usual d