home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / FIDOQWK1.ZIP / FIDOQWK.DOC < prev    next >
Text File  |  1992-06-26  |  10KB  |  247 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                                FidoQWK v1.00 (26-June-1992)
  11.                           FidoNet(tm) <=> QWK echomail processor
  12.                               Copyright 1992 by Geoffrey Sy
  13.  
  14.  
  15.               FidoQWK is supported by:
  16.  
  17.               Residence:                        Support BBS:
  18.  
  19.                Geoffrey Sy                       Simple Solutions Software
  20.                51 Wyatt Walk                         HST: (416) 287-9002
  21.                Toronto, Ontario  CANADA         HST/2400: (416) 286-8734
  22.                M5A 3T3
  23.  
  24.               ═════[INTRODUCTION]══════════════════════════════════════════
  25.                                                                           
  26.               FidoQWK is a echomail processor that allows FidoNet(tm) BBSes
  27.               to transfer messages with  any host system using a  .QWK mail
  28.               door.                                                       
  29.                                                                           
  30.               ═════[OVERVIEW]══════════════════════════════════════════════
  31.                                                                            
  32.               There  are 3 modules to the FidoQWK package.  There's FQSETUP
  33.               that sets  up the needed data  for the other 2  modules.  The
  34.               FID2REP module  scans messages from your  BBS's message areas
  35.               and packages them into a REP packet for uploading to the host
  36.               BBS.  The QWK2FID  module unpacks the QWK packet  and inserts
  37.               messages from the host BBS into your BBS's message areas.
  38.  
  39.               In summary:
  40.  
  41.                     FQSETUP.EXE - Sets up needed data files.
  42.                     FID2REP.EXE - Packs *.MSG into a REP packet for sending
  43.                                   out to the host BBS.
  44.                     QWK2FID.EXE - Inserts messages from the host  BBS into 
  45.                                   your BBS.
  46.  
  47.               ═════[FQSETUP]═══════════════════════════════════════════════
  48.  
  49.               When FQSETUP is executed a menu with 3 options will be shown.
  50.               Option  'A' sets up  the general information.   These general
  51.               information includes:
  52.  
  53.                  1 - Your name
  54.                  2 - Registration key (if you're registered)
  55.                  3 - Serial number    (if you're registered)
  56.  
  57.                  4 - The location where you want FidoQWK to send the 
  58.                      BBS_ID.REP package.
  59.  
  60.  
  61.               _____________________________________________________________
  62.               FidoQWK echomail processor documentation ................. 1
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.                  5 - The location where FidoQWK can find your BBS_ID.QWK 
  71.                      package.
  72.                  6 - The location where FidoQWK can store its temporary 
  73.                      work files.  A RAM or fast hard drive is recommended.
  74.  
  75.               Option 'B' sets up the data compressor characteristics.  Each
  76.               compressor definition requires the following information:
  77.  
  78.                  1 - The make and model of the compressor
  79.                  2 - The full pathname (including extension) and switches 
  80.                      needed to compress a file.
  81.                  3 - The full pathname (including extension) and switches 
  82.                      needed to de-compress a file.
  83.                  4 - The ASCII value of  the first byte found in files that
  84.                      have been compressed with  this compressor.  This will
  85.                      be used for detection of the compressed file type.
  86.                    (* NOTE: Automatic detection of compressed file type has
  87.                            not yet been programmed into v1.00 of FidoQWK *)
  88.  
  89.               Option 'C'  sets up host  BBS information and  message bases.
  90.               These options include:
  91.  
  92.                  1 - The name of the .QWK packet (Host ID).
  93.                  2 - The BBS name of the host.
  94.                  3 - The tagline of the host BBS to be placed on all 
  95.                      incoming messages.
  96.                  4 - The compressor type used on this BBS.
  97.  
  98.                  5 - The tagline to be placed on all outgoing messages.
  99.  
  100.               To insert more host BBS, press Alt-I.  To delete  a host BBS,
  101.               press Alt-D.   To locate a host  BBS, press F4.  The  Page Up
  102.               and  Page Down keys selects  the previous and  next host BBS.
  103.               Press the F2 key  at anytime while  under option 'C' to  edit
  104.               the message base names and paths.  These include:
  105.  
  106.                  1 - The conference number used on the host BBS.
  107.                  2 - The name of the message area.
  108.  
  109.                  3 - The location on your hard drive to store these   
  110.                      messages.
  111.                  4 - The last message sent to the host BBS.
  112.                  5 - The last message written to disk by FidoQWK.
  113.  
  114.               The available functions are listed  above, press the Esc  key
  115.               to return to the previous function.
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.               _____________________________________________________________
  123.               FidoQWK echomail processor documentation ................. 2
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.               ═════[FID2REP/QWK2FID]═══════════════════════════════════════
  132.  
  133.               FID2REP: Scans *.MSG from your BBS to send to the host BBS
  134.  
  135.               QWK2FID: Inserts messages from the host BBS into your BBS
  136.  
  137.               To  use the above modules,  type the module  name followed by
  138.               the host BBS ID.
  139.  
  140.               EXAMPLES:
  141.  
  142.               To insert messages from BBS_ID.QWK packet to your BBS:
  143.  
  144.                 QWK2FID BBS_ID
  145.  
  146.               To scan messages from your BBS to send to BBS_ID:
  147.  
  148.                 FID2REP BBS_ID
  149.  
  150.               ═════[MISCELLANEOUS]═════════════════════════════════════════
  151.  
  152.               FidoQWK properly  observes and  sets the  'Private' attribute
  153.               bit of messages.  It'll also observe the 'In Transit' bit and
  154.               only export messages with this bit turned on.  All other bits
  155.               in are ignored and are turned off on import. 
  156.  
  157.               I've implemented FidoQWK based on the FTS  FSC-0001 draft and
  158.               don't  have  enough  information  on  how  the  'real  world'
  159.               implementation might be.   If there are other bits  that need
  160.               to be set or anything  else, please let me know and  I'll try
  161.               to implement them into FidoQWK.  The name of this program can
  162.               also be improved upon too.  If  you have any suggestions, I'd
  163.               like to hear them.
  164.  
  165.               FidoQWK is far from complete.  I have a long list of features
  166.               I'm ready to implement,  but your support is needed  if these
  167.               features are to be implemented.  I have to know  that I'm not
  168.               wasting  my time  on this,  if you  find the  program useful,
  169.               please send your support.
  170.                
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.               _____________________________________________________________
  184.               FidoQWK echomail processor documentation ................. 3
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.               ═════[REGISTRATION/SUPPORT]══════════════════════════════════
  193.  
  194.               If you have questions,  bugs, comments or suggestions, please
  195.               contact me.  I may be  reached on the PCBoard, Doors, OffLine
  196.               conferences on City2City(tm), Intelec(tm), and  ILink(tm).  I
  197.               also monitor the PCBNet conference on FidoNet(tm). I can also
  198.               be reach on my support BBS or by snail-mail to the above
  199.               address. Registered users of any one of my shareware packages
  200.               may contact me using the voice number in the registration
  201.               document.
  202.  
  203.               Since  this is user supported software, I don't expect you to
  204.               register if you don't like it or if it doesn't meet your
  205.               needs. Just stop using it after a reasonable trial period
  206.               (1-2 weeks). The program is not crippled in any way, there is
  207.               only a short delay at the exit of the program and the tagline
  208.               length allowed will be a bit shorter.
  209.  
  210.               If you like the program and use it regularly, please register
  211.               it. The registration cost is a  one-time fee of $20.00.  With
  212.               the  registration you'll receive  unlimited voice support and
  213.               upgrades. Your registration  encourages further  development,
  214.               enhancement and my continued support of the product.   Please
  215.               send your registration in the form of a Money Order, Personal
  216.               cheque,  or Cashier's cheque to the above address.  I'm sorry
  217.               that I cannot process credit card registrations at this time.
  218.  
  219.               ═════[STANDARD DISCLAIMER]═══════════════════════════════════
  220.  
  221.               This program is  provided on an "AS IS" basis. No warranty of
  222.               any kind is expressed or implied. YOU USE THIS PROGRAM AT
  223.               YOUR OWN RISK. I take no responsibility for any damage caused
  224.               directly or indirectly from  the use or the inability  to use
  225.               this program.
  226.  
  227.               ═════[CREDITS/COPYRIGHTS]════════════════════════════════════
  228.  
  229.               QWK:
  230.                  Copyrights of Mark "Sparky" Herring of Sparkware, the
  231.                  original creator of QWK.
  232.  
  233.               FidoNet:
  234.                  International FidoNet Association.
  235.  
  236.               Other:
  237.                  Respected copyright holders.
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.               _____________________________________________________________
  245.               FidoQWK echomail processor documentation ................. 4
  246.  
  247.