home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / btfax099 / btfmanul.asc < prev   
Text File  |  1993-11-21  |  20KB  |  411 lines

  1.  
  2.          BT-Fax is (c) 1993, Bo Andersson and distributed as FREEWARE
  3.  
  4. This program may be used and distributed freely on a non-profit basis. It may
  5. be distributed freely on BBS's as long as users wishing to download it may do
  6. so without any ridiculous 1:2 ratio being imposed.
  7.  
  8. The author accepts no responsibility for damage or loss of data caused by use
  9. of the program.
  10.  
  11. -------------------------------------------------------------------------------
  12. -------------------------------------------------------------------------------
  13.  
  14.  
  15. *** Description of BT-Fax v.0.99 ***
  16.  
  17. BT-Fax is a Class 2 module for the reception of fax pages in conjunction with a
  18. mailer (front-end) program. The text format is primarily intended for use with
  19. BinkleyTerm. The only requirement for the 'mailer' program is that it must
  20. recognize faxes (+FCON) and be able to hand over to another program.
  21.  
  22. BT-Fax is Class 2 command compatible and works with any modem capable of
  23. handling class 2. Even Zyxel modems function with BT-Fax.
  24.  
  25.  
  26. *** Program changes v.0.97 -> v.0.98 ***
  27.  
  28. - Can write NetMail after Fax (successful/unsuccessful).
  29. - Can save directly in STraightFax format.
  30. - Elapsed time is correctly calculated. This despite the fact that no one has
  31.   pointed out the fact that time could be shown as 00:02:64. :-D
  32. - Shows how a page ended when in QFax mode.
  33. - Strips fill bits resulting in smaller fax pages.
  34.  
  35. *** Program changes v.0.98 -> v.0.99 ***
  36.  
  37. - Saving in STraightFax format has been improved. It sometimes happened that
  38.   fill bits were inserted at the beginning of each fax page. STFax couldn't
  39.   handle these and, as a result, only a blank page would be displayed. Neither
  40.   BTFaxCvt nor STFaxFix need longer be used in order to view pages in
  41.   STraightFax format. This, of course, assumes the use of -s.
  42.  
  43. - The amount of remaining space on the relevant partition is now shown
  44.   correctly even when you're using more than 2 sectors per cluster.
  45.  
  46. - A couple of minor bugs have been removed. 
  47.  
  48.  
  49. *** Commands ***
  50.  
  51. The commands which can be sent to the program are:
  52.  
  53. -p -p:\path\   Search path to the directory in which incoming faxes are to be
  54.                saved. If no search path is indicated the pages will be saved to
  55.                the current path (normally where Binkley is stored).
  56.  
  57. -d -d500       Disk space in kB, default is 300kB. Sets the minimum remaining
  58.                disk space necessary to start/continue reception after saving
  59.                each page. Keep in mind that the space remaining on the hard
  60.                drive may be less than the value entered here after the previous
  61.                page has been saved.
  62.  
  63. -q Qfax        Writes, as does QFax, TM-Fax in the header for each page. QFax
  64.                doesn't bother with it, but newer versions of the Hackfax viewer
  65.                require it's presence.
  66.  
  67. -s STraightFax Saves pages directly in StraightFax format (STFax).
  68.  
  69. -m Mail        Letters written to a NetMail area will contain the same info as
  70.                that used in the BTFax logfile.
  71.  
  72. -n NoLog       Do NOT write to the Log file. If this command isn't used the log
  73.                will be written to BINKFAX.LOG using the same search path as the
  74.                log file for BINKLEY.CFG.
  75.  
  76. -b BitStripOff Normally BT-Fax "strips" fill bits. If this should lead to
  77.                problems, using -b turns the function off. "Empty" bytes ARE
  78.                removed but EOL (End of Line) bits are ignored. This does NOT
  79.                work in STFax mode which requires the fill bits to be stripped.
  80.  
  81. -t Test        Nothing is "stripped" at all. The fax page is saved exactly as
  82.                it's received which means that it takes up more space on your
  83.                hard disk. This command should, in principle, *NEVER* be used!
  84.  
  85.      Neither the order in which these switches are set nor the use of upper or
  86. lower case letters is of any importance. The commands can be written with or
  87. without the use of spaces.
  88.  
  89.      It should be noted that if -s (STFax) is used BT-Fax will ignore the
  90. presence of -q, -b or -t on the command line. This due to the fact that STFax
  91. must be able to calculate EOL bits in order to display the fax.
  92.  
  93.      If both -b and -t are used, the last one entered on the command line is
  94. the active one.
  95.  
  96.      Incoming faxes are given the file name month-day-hour-min.format-nr:
  97. QFax.format becomes mmddhhmm.Fnr and STFax-format becomes mmddhhmm.Jnr.
  98.  
  99.      If QFax format is being used one of the following will be included in the
  100. Info box:
  101.  
  102. RTC OK     The fax page has ended correctly. If anything is missing it's
  103.            because the fax sender didn't send it! :-D
  104.  
  105. Buff.Full  The fax page is larger than 200kB. I've never seen such a page, so
  106.            if anyone should ever get one I'd like a look at it!!
  107.  
  108. TimeOut C  TimeOut in phase C, reception of fax data. Happens if, for instance,
  109.            the connection should be broken.
  110.  
  111.      When -m is used, the following information is taken from BINKLEY.CFG (If
  112. BinkleyTerm isn't being used you put a configuration file named BINKLEY.CFG in
  113. the same folder as the 'mailer' program and BT-Fax):
  114.  
  115. Sysop     Bo Andersson
  116. Address   90:1101/113.0@nest
  117. Statuslog d:\logfiles\binkley.log
  118. NetMail   d:\mail\0001
  119.  
  120. The keyword Fax must also be included in BINKLEY.CFG:
  121. Fax d:\binkley\btfax098.ttp -pD:\FAX_IN\ -d500 -s -m
  122. saves fax pages to D:\FAX_IN\ in STraightFax format and writes a NetMail.
  123.  
  124. Beginning with v. 3.10-b2, Binkley ST uses a new keyword:
  125. Afterfax + program name
  126. which is run directly after either the built-in or a separate fax reception 
  127. module.
  128.  
  129.  
  130. *** Modem strings ***
  131.  
  132. An init string which seems to work well for most sysops is:
  133.  
  134. Init ATZ|~AT+FAA=1+FLID="YOUR_ID"|
  135. Answer AT+FDCC=1,3,0,2,0,0,0,0;+FCR=1|~ATA|
  136.  
  137. Longer init strings than this can be used beginning with Binkley v.3.10a-b3. If
  138. you use a shortened FDCC string (for example FDCC=1,3,0,2) you can put
  139. everything in init and only have ATA| in the answer string. This allows you to
  140. avoid "Ring - OK" every time Binkley answers.
  141.  
  142. +FAA=1 sets the modem to answer as either Data or FAX (Adaptive Answer). The
  143. modem then passes on CONNECT xxx (Data) or +FCON (FAX) to Binkley. On Data,
  144. Binkley is used as usual and on FAX it turns over to BT-Fax.
  145.  
  146. +FCLASS=x should NOT be used as it locks the modem in EITHER Data OR Fax mode.
  147.  
  148. +FLID is your local ID string. This string is displayed to the person sending
  149. to you and can be your telephone number or BBS name. FLID may contain up to 20
  150. characters. You can see how many and which characters your modem can handle by
  151. writing AT+FLID=? (from the comms program). If the value returned is (for
  152. example): (20) (32-127), it means that a maximum of 20 characters, all of which
  153. lie within ASCII range 32-127, may be used. Keep in mind that most modems
  154. filter out empty characters (space).
  155.  
  156. +FDCC (DCE Capabilities Parameters) reports what your modem can handle to the
  157. sender. The syntax is: FDCC:VR,BR,WD,LN,DF,EC,BF,ST (see Table 1) and should
  158. be FDCC:1,3,0,2,0,0,0,0. It's usually enough if you give your resolution and
  159. speed: FDCC:1,3 (196 lpi, 9600 bps). If you use FDCC:1,5 (196 lpi, 14400 bps)
  160. problems MAY occur. These usually appear in the form of the page being "forced"
  161. to 98 lpi or that you get CONNECT at 7200 bps. When changing FDCC, the value
  162. should be copied to FDIS. Supra owners have, however, tried using FDIS
  163. directly, instead of FDCC and achieved better results. You'll have to
  164. experiment a little to see what works best with your own modem.
  165.  
  166. +FCR=1 means that you modem is ready to receive fax pages. FCR=0 would then
  167. indicate that you're out of paper. :-)
  168.  
  169.  
  170. *** The Screen ***
  171.  
  172. This is approximately how BT-Fax will look on your screen:
  173.  
  174.   ____________________________________________________________________________
  175.  | Transmit Station ID: <None>                     Free diskspace:   1234 kB  |
  176.  | VR:               BR:               WD:               LN:                  |
  177.  | DF:               EC:               BF:               ST:                  |
  178.  | FPTS:                              FET:                                    |
  179.  | Modem in:               Modem out:               Page nr:       FHNG:  --  |
  180.  | Path M:\                                                                   |
  181.  |____________________________________________________________________________|
  182.  BT-Fax 0.99 by Bo Andersson 2:203/203.5 and Bertil Jagard 2:203/221.0 FreeWare
  183.  
  184. Transmit Station ID:
  185. <None>        if it's missing. The sender hasn't sent an FTSI.
  186. Unknown       The sender has sent an empty FTSI (1-20 spaces).
  187. string        The sender's FTSI (usually a telephone number).
  188.  
  189. Free disk space: --- kB
  190.  
  191.      The amount of free space on the partition where incoming faxes are saved.
  192.  
  193. VR:,BR:,WD:,LN:,DF:,EC:,BF:,ST:
  194.  
  195.      See Table 1 for information.
  196.  
  197. FPTS: (Receive Page Transfer Status)
  198.  
  199.      Seems to be relatively unused. Most Fax modems seem to have their own
  200. "standard" answers. Maybe the problem will be solved in future ROM uppgrades?
  201.  
  202. FET: (Post Page Message Response)
  203.  
  204.      This doesn't seem to be completely developed either. Despite all the faxes
  205. which have been received, only 2 values have been returned; another page
  206. (= FET:0) and no more pages (= FET:2). If anyone's got more information
  207. concerning FPTS and FET please contact me.
  208.  
  209. Modem in:
  210.  
  211.      What was last received by the modem. The most interesting thing is
  212. Connect which is when reception goes into Phase C (receiving faxpage).
  213.  
  214. Modem out:
  215.  
  216.      What's being sent to the modem.
  217.  
  218. Page nr:
  219.  
  220.      The number of the page being received.
  221.  
  222. FHNG:
  223.  
  224.      If FHNG: 00 then everything's functioned correctly. Table 2 shows the
  225. meaning of the codes.
  226.  
  227. Path M:\
  228.  
  229.      Shows the search path to where fax pages are saved.
  230.  
  231.  
  232. *** Table 1 ***
  233.  
  234. T.30 Session Subparameter Codes
  235.  
  236.  .-----------------------------------------------------------------.
  237.  |  Label |  Function     |  Value  |  Description                 |
  238.  |--------|---------------|---------|------------------------------|
  239.  |  VR    |  Vertical     |   0     |  Normal, 98 lpi              |
  240.  |        |  resolution   |   1     |  Fine, 196 lpi               |
  241.  |--------|---------------|---------|------------------------------|
  242.  |  BR    |  Bit Rate     |   0     |  2400 bit/s V.27 ter         |
  243.  |        |               |   1     |  4800 bit/s V.27 ter         |
  244.  |        |  (See note 1) |   2     |  7200 bit/s V.29 or v.17     |
  245.  |        |               |   3     |  9600 bit/s V.29 or v.17     |
  246.  |        |               | **4     |  12000 bit/s V.33 or v.17    |
  247.  |        |               | **5     |  14400 bit/s V.33 or v.17    |
  248.  |--------|---------------|---------|------------------------------|
  249.  |  WD    | Page Width    |   0     |  1728 pixels in 215 mm       |
  250.  |        |               |   1     |  2048 pixels in 255 mm       |
  251.  |        |               |   2     |  2432 pixels in 303 mm       |
  252.  |        |               |  *3     |  1216 pixels in 151 mm       |
  253.  |        |               |  *4     |   864 pixels in 107 mm       |
  254.  |--------|---------------|---------|------------------------------|
  255.  |  LN    |  Page Length  |   0     |  A4, 297 mm                  |
  256.  |        |               |  *1     |  B4, 364 mm                  |
  257.  |        |               |  *2     |  unlimited length            |
  258.  |--------|---------------|---------|------------------------------|
  259.  |  DF    |  Data         |   0     |  1-D modified Huffman        |
  260.  |        |  Compression  |   1     |  2-D modified Read           |
  261.  |        |  Format       |  *2     |  2-D uncompressed mode       |
  262.  |        |               |  *3     |  2-D modified Read           |
  263.  |--------|---------------|---------|------------------------------|
  264.  |  EC    |  Error        |   0     |  Disable ECM                 |
  265.  |        |  Correction   |  *1     |  Enable ECM,64 bytes/frame   |
  266.  |        |  (Annex       |  *2     |  Enable ECM,256 bytes/frame  |
  267.  |        |   A/T.30)     |         |                              |
  268.  |        |  (See Note 2) |         |                              |
  269.  |--------|---------------|---------|------------------------------|
  270.  |  BF    |  Binary File  |   0     |  Disable BFT                 |
  271.  |        |  Transfer     |  *1     |  Enable BFT                  |
  272.  |        |  (See Note 3) |         |                              |
  273.  |--------|---------------|---------|------------------------------|
  274.  |  ST    |  Scan Time/   |         |  VR=normal   VR=fine         |
  275.  |        |  Line         |   0     |    0 ms        0 ms          |
  276.  |        |               |   1     |    5 ms        5 ms          |
  277.  |        |               |   2     |    10 ms       5 ms          |
  278.  |        |               |   3     |    10 ms       10 ms         |
  279.  |        |               |   4     |    20 ms       10 ms         |
  280.  |        |               |   5     |    20 ms       20 ms         |
  281.  |        |               |   6     |    40 ms       20 ms         |
  282.  |        |               |   7     |    40 ms       40 ms         |
  283.  |--------|---------------|---------|------------------------------|
  284.  |  NOTES: 1: CCITT T.30 does not provide for the answering        |
  285.  |            station to specify all speeds exactly using the DIS  |
  286.  |            frame.  Implementation of some BR codes (e.g.code 2) |
  287.  |            by an answering DCE is manufacturer specific.        |
  288.  |                                                                 |
  289.  |         * =Not supported                                        |
  290.  |        ** =RC144AC only                                         |
  291.  |                                                                 |
  292.  |         2: ECM has been implemented in Supra's version 1.200C.  |
  293.  |            ECM transmit works correctly, and ECM receive works, |
  294.  |            but does not tell the transmitting machine that the  |
  295.  |            fax was received correctly.                          |
  296.  |                                                                 |
  297.  |        3:  BFT has been implemented in Supra's version 1.200C.  |
  298.  |            BFT transmit works correctly, and BFT receive works, |
  299.  |            but does not tell the transmitting machine that the  |
  300.  |            file was received correctly.                         |
  301.  |                                                                 |
  302.  '-----------------------------------------------------------------'
  303.  
  304.  
  305. *** Tabell 2 ***
  306.  
  307. Hangup Status Codes - Shown as FHNG: xx
  308.  
  309.  .------------------------------------------------------------.
  310.  |    Code  |  Cause Description                              |
  311.  |----------|-------------------------------------------------|
  312.  |     0-9  |  CALL PLACEMENT AND TERMINATION                 |
  313.  |----------|-------------------------------------------------|
  314.  |       0  |  Normal and proper end of connection            |
  315.  |       1  |  Ring Detect without successful handshake       |
  316.  |       2  |  Call aborted, from +FK or AN                   |
  317.  |       3  |  No Loop Current                                |
  318.  |----------|-------------------------------------------------|
  319.  |   10-19  |  TRANSMIT PHASE A & MISCELLANEOUS ERRORS        |
  320.  |----------|-------------------------------------------------|
  321.  |      10  |  Unspecified Phase A error                      |
  322.  |      11  |  No Answer (T.30 T1 timeout)                    |
  323.  |----------|-------------------------------------------------|
  324.  |   20-39  |  TRANSMIT PHASE B HANGUP CODES                  |
  325.  |----------|-------------------------------------------------|
  326.  |      20  |  Unspecified Transmit Phase B error             |
  327.  |      21  |  Remote cannot receive or send                  |
  328.  |      22  |  COMREC error in transmit Phase B               |
  329.  |      23  |  COMREC invalid command received                |
  330.  |      24  |  RSPEC error                                    |
  331.  |      25  |  DCS sent three times without response          |
  332.  |      26  |  DIS/DTC received 3 times; DCS not recognized   |
  333.  |      27  |  Failure to train at 2400 bps or +FMINSP value  |
  334.  |      28  |  RSPREC invalid response received               |
  335.  |----------|-------------------------------------------------|
  336.  |   40-49  |  TRANSMIT PHASE C HANGUP CODES                  |
  337.  |----------|-------------------------------------------------|
  338.  |      40  |  Unspecified Transmit Phase C error             |
  339.  |      43  |  DTE to DCE data underflow                      |
  340.  |----------|-------------------------------------------------|
  341.  |   50-69  |  TRANSMIT PHASE D HANGUP CODES                  |
  342.  |----------|-------------------------------------------------|
  343.  |      50  |  Unspecified Transmit Phase D error             |
  344.  |      51  |  RSPREC error                                   |
  345.  |      52  |  No response to MPS repeated 3 times            |
  346.  |      53  |  Invalid response to MPS                        |
  347.  |      54  |  No response to EOP repeated 3 times            |
  348.  |      55  |  Invalid response to EOM                        |
  349.  |      56  |  No response to EOM repeated 3 times            |
  350.  |      57  |  Invalid response to EOM                        |
  351.  |      58  |  Unable to continue after PIN or PIP            |
  352.  |----------|-------------------------------------------------|
  353.  |   70-89  |  RECEIVE PHASE B HANGUP CODES                   |
  354.  |----------|-------------------------------------------------|
  355.  |      70  |  Unspecified Receive Phase B error              |
  356.  |      71  |  RSPREC error                                   |
  357.  |      72  |  COMREC error                                   |
  358.  |      73  |  T.30 T2 timeout, expected page not received    |
  359.  |      74  |  T.30 T1 timeout after EOM received             |
  360.  |----------|-------------------------------------------------|
  361.  |   90-99  |  RECEIVE PHASE C HANGUP CODES                   |
  362.  |----------|-------------------------------------------------|
  363.  |      90  |  Unspecified Receive Phase C error              |
  364.  |      91  |  Missing EOL after 5 seconds                    |
  365.  |      92  |  Unused code                                    |
  366.  |      93  |  DCE to DTE buffer overflow                     |
  367.  |      94  |  Bad CRC or frame (ECM or BFT modes)            |
  368.  |----------|-------------------------------------------------|
  369.  | 100-119  |  RECEIVE PHASE D HANGUP CODES                   |
  370.  |----------|-------------------------------------------------|
  371.  |     100  |  Unspecified Receive Phase D errors             |
  372.  |     101  |  RSPREC invalid response received               |
  373.  |     102  |  COMREC invalid response received               |
  374.  |     103  |  Unable to continue after PIN or PIP            |
  375.  |----------|-------------------------------------------------|
  376.  | 120-255  |  RESERVED CODES                                 |
  377.  '------------------------------------------------------------'
  378.  
  379.      These tables have been 'ripped off' from Supra's information about fax
  380. modems (In turn, Supra has taken them from Rockwell's manual :-)
  381.  
  382.  
  383. *** Miscellaneous ***
  384.  
  385. - If you information, documents or anything else about faxes, I'd appreciate it
  386. if you'd notify me of the file name and where I might request it.
  387.  
  388. - You can also send me various modem settings (functional or not). Don't forget
  389. to mention what modem they're for. It could be of help to someone who can't get
  390. things to work.
  391.  
  392. - If you like the program or have suggestions - SEND A NETMAIL!
  393.  
  394. - I'd like to thank those that reacted in some fashion and, above all, to those
  395. who have sent me netmail!!!!
  396.  
  397.  
  398.      Greetings from
  399.  
  400.      Bo Andersson
  401.  
  402.  
  403. Questions, suggestions and requests may be sent to:
  404.  
  405. Bo Andersson 2:203/203.5@fidonet or 90:1101/113.0@nest
  406.  
  407. or
  408.  
  409. Bertil Jagard 2:203/221.0@fidonet or 90:1101/104.0@nest
  410.  
  411.