home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-386-Vol-2of3.iso / b / bfx200.zip / BFX.DOC < prev    next >
Text File  |  1992-12-02  |  15KB  |  529 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.                                       BFX
  25.  
  26.                     Copyright (c) 1992 Richard D. Fothergill
  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.                                                       Richard D. Fothergill
  55.                                                            the Oak Hill BBS
  56.                                                           141 Oak Hill Road
  57.                                                       Pittsfield, MA  01201
  58.                                                   Data/FAX - (413) 499-7245
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.      WHAT IS BFX?
  72.  
  73.      When  I purchased my ZyXEL U-1496 Modem/Fax I wanted an easy way to be
  74.      able to accept fax and modem calls on the same line.  This would allow
  75.      me  to continue  to operate my  BBS software  and be  in a position to
  76.      receive  faxes.  I  tried BinkleyTerm  and FrontDoor.   Both excellent
  77.      programs,  but way more than I needed or wanted, not having a need for
  78.      network  mailers or a  built in terminal  program.  I wanted something
  79.      simple, small, easy to setup and maintain that could take advantage of
  80.      the  capabilities of the  ZyXEL.  Thus the  beginning of BFX.  BFX may
  81.      work  with other Fax/Modems  however it has  only been tested with the
  82.      ZyXEL.
  83.  
  84.      WHAT CAN I DO WITH BFX?
  85.  
  86.      You  run BFX instead of your BBS software.  BFX will answer the phone,
  87.      decide what the incoming call is and exit with an errorlevel which you
  88.      can  use in a  batch file for  subsequent operations.  A BBS call will
  89.      also  create a batch file  to call your BBS software.  In addition you
  90.      can  program up to 10 events  with a preset time of execution and exit
  91.      errorlevel and up to three configurable menu items that will appear as
  92.      selections  on the pop-up menu within BFX.  When BFX encounters one of
  93.      these  it will  exit with  your predetermined  errorlevel.  Again, you
  94.      control  further processing in your batch file.  BFX will also monitor
  95.      the  ability to communicate with  the modem.  If BFX detects a loss of
  96.      the  ability to communicate with the modem it will halt execution with
  97.      an errorlevel of 5 and return control to your BBS.BAT batch file.
  98.  
  99.      REQUIREMENTS
  100.  
  101.      Fax/Modem capable of generating a FAX  connection string and BBS / Fax
  102.      software capable of executing after a connection has been established.
  103.  
  104.      Configurable Menu Items and CallerID logging are only available in the
  105.      registered  version.   If you  would  like to  receive  the registered
  106.      version,  send your name and  address along with a check for $25.00 US
  107.      to:
  108.  
  109.          Richard Fothergill
  110.          141 Oak Hill Road
  111.          Pittsfield, MA  01201
  112.  
  113.      Please specify either 5-1/4" or 3-1/2" disk size.
  114.  
  115.      Support  is available on  the Oak Hill  BBS - (413) 499-7245 running a
  116.      ZyXEL U-1496S.
  117.  
  118.      DISCLAIMER
  119.  
  120.      IN  NO EVENT WILL  I BE LIABLE  TO YOU FOR  ANY DAMAGES, INCLUDING ANY
  121.      LOST  PROFITS,  LOST  SAVINGS  OR  OTHER  INCIDENTAL  OR CONSEQUENTIAL
  122.      DAMAGES  ARISING OUT OF YOUR  USE OR INABILITY  TO USE BFX, OR FOR ANY
  123.      CLAIM BY ANY OTHER PARTY.
  124.  
  125.      I would like to express my thanks to Bill Derrer, Laura Fiorilla, Tony
  126.      Sharp and George Vandebunte for their assistance in testing BFX.
  127.  
  128.  
  129.  
  130.      BFX                                               -1-
  131.      Copr (c) 1992 Richard D. Fothergill
  132.  
  133.  
  134.  
  135.  
  136.  
  137.      INSTALLATION
  138.  
  139.      There are two files that you must create to run BFX.  They are BBS.BAT
  140.      and BFX.CFG.  I have included in this archive samples of each that you
  141.      can  modify  with  any  ASCII  text  editor.   I  will  discuss  these
  142.      individually.  First a few rules regarding errorlevels.
  143.  
  144.      ERRORLEVELS
  145.  
  146.      Errorlevels  0 -  30  are reserved  for use  by  BFX.  There  are five
  147.      hardcoded errorlevels assigned in this version of BFX.
  148.  
  149.           0 - Terminate
  150.           5 - Modem Error
  151.          10 - Local Logon
  152.          20 - DATA Connection
  153.          30 - FAX Connection
  154.  
  155.      Errorlevels  31  -  255 can  be  assigned  by the  user  to  events or
  156.      configurable menu items.
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.      BFX                                               -2-
  197.      Copr (c) 1992 Richard D. Fothergill
  198.  
  199.  
  200.  
  201.  
  202.  
  203.      BBS.BAT
  204.  
  205.      This  batch file is the heart of your BBS/FAX system.  It controls all
  206.      activity  and execution.  You do  not have to use the name BBS.BAT, it
  207.      can be any name of your choosing.  The following is the BBS.BAT file I
  208.      use.
  209.  
  210.      @ECHO OFF
  211.      :LOOP
  212.        f:
  213.        cd \sf
  214.        cls
  215.        bfx
  216.        if errorlevel 70 goto EVENT0
  217.        if errorlevel 50 goto CFG2
  218.        if errorlevel 40 goto CFG1
  219.        if errorlevel 30 goto FAXCALL
  220.        if errorlevel 20 goto DATACALL
  221.        if errorlevel 10 goto LOCAL
  222.        if errorlevel  5 goto MODEMERR
  223.        if errorlevel  0 goto END
  224.      :EVENT0
  225.        call sfmaint
  226.        goto loop
  227.      :FAXCALL
  228.        rcvfax 1 f:\sf\fax
  229.        goto loop
  230.      :DATACALL
  231.        call bbsexe
  232.        sfchkup
  233.        goto loop
  234.      :LOCAL
  235.        spitfire 0
  236.        goto loop
  237.      :CFG1
  238.        e:
  239.        cd \gt
  240.        call gt
  241.        goto loop
  242.      :CFG2
  243.        e:
  244.        cd \dosfax
  245.        dosfax
  246.        goto loop
  247.      :MODEMERR
  248.        echo A problem with your modem exists!
  249.      :END
  250.  
  251.      The  loop: label is  where execution of  the batch file will return to
  252.      after  any activity other  than a normal  exit or modem error.  BFX is
  253.      started and awaits a caller.  If a call is received, a scheduled event
  254.      occurs or a configurable menu item is selected, BFX will exit with the
  255.      corresponding  errorlevel.  Be  sure to  complete each errorlevel exit
  256.      with a goto loop so that control will always return to this batch file
  257.      and if you are starting a BATch file use the DOS CALL command.
  258.  
  259.  
  260.  
  261.  
  262.      BFX                                               -3-
  263.      Copr (c) 1992 Richard D. Fothergill
  264.  
  265.  
  266.  
  267.  
  268.  
  269.      BFX.CFG
  270.  
  271.      This  is the  configuration file  you setup  to inform  BFX of certain
  272.      parameters  it  needs   to  function.   The   following  is  a  sample
  273.      configuration file.
  274.  
  275.      PN=2
  276.      PB=38400
  277.      PP=N
  278.      PL=8
  279.      PS=1
  280.      PC=ARQ
  281.      MI=ATM0V1E0S2=1H0X7#B1+FCLASS=6
  282.      MA=ATA
  283.      MY=ATH0
  284.      MN=ATH1
  285.      MR=ATZ
  286.      MD=3
  287.      BB=SPITFIRE
  288.      BS=
  289.      BP=/C
  290.      BE=/E
  291.      GR=2
  292.      GT=120
  293.      GM=>> BFX >> logging on to...
  294.      GC=NO
  295.      GV=C
  296.      FP=F:\ZFAX\ZFAX.COM
  297.      FC=4
  298.      FS=F:\SF\FAX\*.*
  299.      C1=GTPowerComm,40
  300.      C2=Dosfax,50
  301.      E0=DAILY MAINTENANCE,03:00,70
  302.  
  303.      There  are no  spaces allowed in  this file  between the parameter and
  304.      either  side of the  = sign.  The  items should appear in the sequence
  305.      listed  but it  is not  required.  It  is required  that all parameter
  306.      identifiers be upper case.
  307.  
  308.      The parameters and their definitions are as follows:
  309.  
  310.      PN  The communications port you have your modem on.
  311.      PB  The baud rate to initialize your modem to.
  312.      PP  Parity
  313.      PL  Data length
  314.      PS  Stop Bits
  315.      MI  Your initialization string for modem/fax reception.  Please
  316.          include E0 and V1 in your init string so that modem responses will
  317.          display in the status window correctly.
  318.      MA  Modem answer string.
  319.      MY  Modem onhook string.
  320.      MN  Modem offhook string.
  321.      MR  Modem reset string.
  322.      MD  Modem delay.  Sets the no. of ticks to delay before sending
  323.          commands to the modem.  If you experience Modem Failure errors you
  324.          can try increasing or decreasing this value.
  325.      BB  The name you would like placed in the BBSEXE.BAT file.
  326.  
  327.  
  328.      BFX                                               -4-
  329.      Copr (c) 1992 Richard D. Fothergill
  330.  
  331.  
  332.  
  333.  
  334.  
  335.      BS  The text you would like to preceed the connect speed parameter in
  336.          BBSEXE.BAT
  337.      BP  The text you would like to preceed the baud rate parameter in the
  338.          BBSEXE.BAT file.  Spitfire requires that the parameter read
  339.          /C<comport>.  Check your BBS software.
  340.      BE  The text you would like in BBSEXE.BAT to notify your BBS software
  341.          that an error correcting connection has been made.
  342.      GR  The number of rings on which you would like BFX to answer the
  343.          call.
  344.      GT  Sleep time out seconds.  This is the amount of time BFX will wait
  345.          before blanking the screen.  A display of the program name and
  346.          current time will appear at random locations to remind you of the
  347.          program running.  If ST=0 then screen blanking is disabled.
  348.      GM  Log on message.  This is sent to the caller just before BFX exits
  349.          on a data connection.
  350.      GC* Tells BFX whether CID logging should be active.  If NO then CID
  351.          information will appear in the status window only.  If YES then
  352.          the CID information will be written to the BFX.LOG file right
  353.          after the connection information.  BFX will also generate a plain
  354.          ASCII text file containing the current callers ID information in
  355.          the event you have a program that can make use of it.  The name of
  356.          this file is CALLERID.DAT.
  357.      GV  Tells BFX which color set to use.  Normally BFX will determine the
  358.          correct color set, either Monochrome or Color, on start up.  If
  359.          you have a paper white VGA monitor or for some reason BFX selects
  360.          an incompatible color set you can override that by setting GV=M
  361.          for monochrome or GV=C for color.
  362.      FP  The full path and complete file name of your Fax Viewer.
  363.      FC  The command line paramters your Fax viewer needs to startup.
  364.      FS  The full path and search parameters for your Fax file directory.
  365.      C1 - C3*
  366.          These are configurable menu items.  The format for each line is:
  367.          Description (20 chars. max.),Errorlevel.  The description will
  368.          appear in the pop-up menu and when selected BFX will exit with the
  369.          assigned errorlevel.  This can be used to run your communications
  370.          program or send fax software as an example.
  371.      E0 - E9
  372.          Up to 10 events that you can execute at a specific time.  The
  373.          format for each line is:
  374.                    Description (40 chars. max), Time, Errorlevel
  375.          The description will appear in the log file when the event occurs.
  376.          The time to execute the event must be in 24 hr. format.  The
  377.          errorlevel is the value BFX will exit with.  In the event someone
  378.          is online when an event is scheduled BFX will run the event once
  379.          they log off and control is returned to BFX.
  380.  
  381.      *   Only available in the registered version.
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.      BFX                                               -5-
  395.      Copr (c) 1992 Richard D. Fothergill
  396.  
  397.  
  398.  
  399.  
  400.  
  401.      FILES CREATED BY BFX
  402.  
  403.      There are four files created by BFX.  A discussion of each follows.
  404.  
  405.      BFX.LOG
  406.  
  407.      If  this file is  not found at  start-up BFX creates  a new one.  Each
  408.      time connection is established, an entry is written to this file.  The
  409.      entry  will consist  of the  date, time,  description of  activity and
  410.      either  the errorlevel for an  event or the CONNECT string for a modem
  411.      connection.  Local logons are not recorded in the file.  This file has
  412.      no interaction with your BBS log file.  A modem connection may be made
  413.      and  control passed to  your BBS  software and the  user might hang up
  414.      with  out logging on.  In this  case, there would still be a record of
  415.      the  connection in the BFX.LOG but in all probability, not in your BBS
  416.      log.   In the registered version CID information may also be logged to
  417.      this  file.  The log  file has a  limit of 2000  lines.  You may reset
  418.      this file at anytime.
  419.  
  420.      BFX.STS
  421.  
  422.      This  used strictly  by BFX.  Each  time BFX  releases control back to
  423.      DOS,  BFX  writes control  data  to this  file.   You do  not  have to
  424.      recreate  this.  BFX  will create  a one  if an  existing file  is not
  425.      found.
  426.  
  427.      BBSEXE.BAT
  428.  
  429.      When  a BBS  call  is received,  BFX will  create  a batch  file which
  430.      contains  the name (BB),  followed by the  baud rate prefix (BS), baud
  431.      rate,  com port prefix (BP),  com port and the error correcting string
  432.      (EC) .  The parameters you specify in the configuration file allow you
  433.      to  construct an entry that  will start your BBS software.  The format
  434.      of the line in BBSEXE using the configuration parameters is:
  435.  
  436.          [BB] [BS]<baud rate> [BP]<comport> [EC]
  437.          SPITFIRE 14400 /C2 /E
  438.  
  439.      CALLERID.DAT
  440.  
  441.      If  you have  CID  available in  your area  and  you have  CID logging
  442.      enabled  with GC=YES  in BFX.CFG then  this file  will be created each
  443.      time  a data or fax connection  is made.  This file will contain up to
  444.      three  lines of  caller id  information, depending  on the service you
  445.      have  in your area, in  plain ASCII text.  Available in the registered
  446.      version.
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.      BFX                                               -6-
  461.      Copr (c) 1992 Richard D. Fothergill
  462.  
  463.  
  464.  
  465.  
  466.  
  467.      MENU AND HOT KEYS
  468.  
  469.      From  the  Waiting  for  Caller screen  you  have  three  possible key
  470.      strokes.   Alt-X will close BFX and execute a normal exit.  Alt-A will
  471.      display  the  copyright  information,  version  no.  and  registration
  472.      information.   Alt-M  will bring  up  a  pop menu  with  the following
  473.      selections available:
  474.  
  475.          Activity Log
  476.          Local Logon
  477.          Drop to DOS
  478.          View Fax
  479.          Reset Stats/Log
  480.          Terminate BFX
  481.  
  482.      Within this menu your mouse will be active to locate the highlight bar
  483.      or  you can use the arrow keys.  Either press the left mouse button or
  484.      the enter key to make a selection.  Pressing the right mouse button or
  485.      the Esc key will return you to the Waiting for Caller screen.
  486.  
  487.      Activity  Log - This  selection will  pop up a  window and display the
  488.      BFX.LOG  file.  Press the Esc  key or the right mouse button to return
  489.      to the menu.
  490.  
  491.      Local Logon - This will exit the system with an errorlevel of 10.
  492.  
  493.      Drop  to DOS - Self  explanatory.  The DOS prompt is amended to remind
  494.      you to EXIT back to the BFX menu.
  495.  
  496.      View  Fax -  Presents  a selection  of  fax files  meeting  the search
  497.      parameters you specify in BFX.CFG.  After selecting a file it executes
  498.      the viewing software you specified passing it the selected file name.
  499.  
  500.      Reset  Stats/Log - You are  given the option of resetting the [S]tats,
  501.      [L]og, [B]oth or returning without any update.
  502.  
  503.      Terminate  BFX - Same as  the Alt-X key press.  Executes a normal exit
  504.      back to dos.
  505.  
  506.      Configurable  Menu Items -  C1  > C3.  They  appear on the menu in the
  507.      sequence  they appear in BFX.CFG.   These may be selected as you would
  508.      any of the above items.  Available in the registered version.
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.      BFX                                               -7-
  527.      Copr (c) 1992 Richard D. Fothergill
  528.  
  529.