home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / FIDOQ111.ZIP / FIDOQWK.DOC < prev    next >
Text File  |  1992-08-01  |  12KB  |  307 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                               FidoQWK v1.05 (01-August-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 for anyone running a FidoNet compatible BBS system
  27.               and wants  to carry  any .QWK type  nets.  The  basic concept
  28.               follows:
  29.  
  30.                  OUT: FidoNet *.MSG => BBS_ID.REP => QWK Mail door
  31.                  IN: QWK Mail door => BBS_ID.QWK => FidoNet *.MSG
  32.  
  33.               Additional step(s) may be required to convert from your BBS's
  34.               native message format into  the standard FidoNet *.MSG format
  35.               and  vise versa.  In this documentation I'm assuming that you
  36.               know  how to do this as well  as the basic concept of QWK/REP
  37.               mail transfers.  If you are  not sure, leave a message on the
  38.               appropriate forum/message  area/conference  on the  net,  the
  39.               SysOps  conference  on  most  echo mail  network  is  usually
  40.               appropriate.
  41.                                                            
  42.               ═════[OVERVIEW]══════════════════════════════════════════════
  43.                                                                            
  44.               There  are 3 modules to the FidoQWK package.  There's FQSETUP
  45.               that sets  up the needed data  for the other 2  modules.  The
  46.               MSG2REP module  scans messages from your  BBS's message areas
  47.               and packages them into a REP packet for uploading to the host
  48.               BBS.  The QWK2MSG  module unpacks the QWK packet  and inserts
  49.               messages from the host BBS into your BBS's message areas.
  50.  
  51.               In summary:
  52.  
  53.                     FQSETUP.EXE - Sets up needed data files.
  54.                     MSG2REP.EXE - Packs *.MSG into a REP packet for sending
  55.                                   out to the host BBS.
  56.                     QWK2MSG.EXE - Inserts messages from  the host BBS into 
  57.                                   your BBS.
  58.  
  59.  
  60.  
  61.               _____________________________________________________________
  62.               FidoQWK echomail processor documentation ................. 1
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.               ═════[FQSETUP]═══════════════════════════════════════════════
  71.  
  72.               When FQSETUP is executed a menu with 3 options will be shown.
  73.               If the  help system was  completed, the  F1 key calls  up the
  74.               context-sensitive help items.  Option 'A' sets up the general
  75.               information.  These general information includes:
  76.  
  77.                  1 - Your name
  78.                  2 - Registration key (if you're registered)
  79.                  3 - Serial number    (if you're registered)
  80.  
  81.                  4 - The location where you want FidoQWK to send the 
  82.                      BBS_ID.REP package.
  83.                  5 - The location where you've downloaded the host BBS's   
  84.                      BBS_ID.QWK mail package.
  85.                  6 - The location where FidoQWK can store its temporary 
  86.                      work files.  A RAM or fast hard drive is recommended.
  87.  
  88.               Option 'B' sets up the data compressor characteristics.  Each
  89.               compressor definition requires the following information:
  90.  
  91.                  1 - The make and model of the compressor
  92.                  2 - The full pathname (including extension) and switches 
  93.                      needed to compress a file.
  94.                  3 - The full pathname (including extension) and switches 
  95.                      needed to de-compress a file.
  96.                  4 -  The ASCII value of the first byte found in files that
  97.                      have been compressed with  this compressor.  This will
  98.                      be used for detection of the compressed file type.
  99.                    (* NOTE: Automatic detection of compressed file type has
  100.                            not yet been programmed into v1.00 of FidoQWK *)
  101.  
  102.               Option  'C' sets up  host BBS information  and message bases.
  103.               These options include:
  104.  
  105.                  1 - The name of the .QWK packet (Host ID).
  106.                  2 - The BBS name of the host.
  107.                  3 - The tagline of the host BBS to be placed on all 
  108.                      incoming messages.
  109.                  4 - The compressor type used on this BBS.
  110.  
  111.                  5 - The tagline to be placed on all outgoing messages.
  112.  
  113.               To insert more host BBS, press  Alt-I.  To delete a host BBS,
  114.               press Alt-D.   To locate a host  BBS, press F4.  The  Page Up
  115.               and  Page Down keys selects  the previous and  next host BBS.
  116.               Press the F2 key  at anytime while under  option 'C' to  edit
  117.               the message base names and paths.  These include:
  118.  
  119.                  1 - The conference number used on the host BBS.
  120.                  2 - The name of the message area.
  121.  
  122.               _____________________________________________________________
  123.               FidoQWK echomail processor documentation ................. 2
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.                  3 - The location on your hard drive to store these   
  132.                      messages.
  133.                  4 - The last message sent to the host BBS.
  134.                  5 - The last message written to disk by FidoQWK.
  135.  
  136.               The available functions  are listed above, press the  Esc key
  137.               to return to the previous function.
  138.  
  139.               ═════[MSG2REP/QWK2MSG]═══════════════════════════════════════
  140.  
  141.               MSG2REP: Scans *.MSG from your BBS to send to the host BBS
  142.  
  143.               QWK2MSG: Inserts messages from the host BBS into your BBS
  144.  
  145.               To  use the above modules,  type the module  name followed by
  146.               the host BBS ID.
  147.  
  148.               EXAMPLES:
  149.  
  150.               To insert messages from BBS_ID.QWK packet to your BBS:
  151.  
  152.                 QWK2MSG BBS_ID [switches]
  153.  
  154.               To scan messages from your BBS to send to BBS_ID:
  155.  
  156.                 MSG2REP BBS_ID [switches]
  157.  
  158.               SWITCHES:   
  159.  
  160.                 /IS - Ignore Sent attribute:
  161.                    Normally MSG2REP will NOT  send messages with the "Sent"
  162.                    attribute turned on.  Use this message if  your messages
  163.                    aren't being sent out.
  164.  
  165.                 /IP - Ignore last scanned pointers:
  166.                    Normally MSG2REP will scan  *.MSG files from the highest
  167.                    number  it scanned last.   This may not  be desirable in
  168.                    some cases.  Use this switch to scan all available *.MSG
  169.                    packets. 
  170.  
  171.                 /NS - No Shell:
  172.                    Use   this  option  to  tell  FidoQWK  not  to  run  the
  173.                    compression/decompression programs.  Be sure to manually
  174.                    decompress the QWK packet into FidoQWK's work  directory
  175.                    when using  this option.  The  resultant BBS_ID.MSG will
  176.                    need to be manually compressed into BBS_ID.REP also.
  177.  
  178.                 /SWAP /EMS - Swap out when shelling:
  179.                    Use  these options to swap to disk or EMS when executing
  180.                    the compression utilities.
  181.  
  182.  
  183.               _____________________________________________________________
  184.               FidoQWK echomail processor documentation ................. 3
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.                 /FS - Full Screen shell:
  193.                    Use this option to  execute the compression utilities in
  194.                    full-screen   mode.    FidoQWK   normally  executes  the
  195.                    compression utilities in a small window.
  196.  
  197.  
  198.               ═════[MISCELLANEOUS]═════════════════════════════════════════
  199.  
  200.               FidoQWK properly  observes and sets  the 'Private'  attribute
  201.               bit of messages.  It'll also observe  the 'Sent' bit and only
  202.               export messages with this bit turned off.  All  other bits in
  203.               are ignored and are turned off on import. 
  204.  
  205.               I've  implemented FidoQWK  based on  the FTSC-0001  draft and
  206.               don't  have  enough  information  on  how  the  'real  world'
  207.               implementation might be.   If there are other bits  that need
  208.               to be set  or anything else, please let me  know and I'll try
  209.               to implement them into FidoQWK.  The name of this program can
  210.               also be improved  upon too.  If you have any suggestions, I'd
  211.               like to hear them.
  212.  
  213.               FidoQWK is far from complete.  I have a long list of features
  214.               I'm ready to implement,  but your support is needed  if these
  215.               features are  to be implemented.  I have to know that I'm not
  216.               wasting  my time  on this,  if you  find the  program useful,
  217.               please send your support.
  218.                
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.               _____________________________________________________________
  245.               FidoQWK echomail processor documentation ................. 4
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.               ═════[REGISTRATION/SUPPORT]══════════════════════════════════
  254.  
  255.               If you have questions,  bugs, comments or suggestions, please
  256.               contact me.  I may be  reached on the PCBoard, Doors, OffLine
  257.               conferences on City2City(tm), Intelec(tm), and ILink(tm), the
  258.               PCBNet  and Offline conference on FidoNet(tm).  I can also be
  259.               reach  on  my  support BBS  or  by  snail-mail  to the  above
  260.               address. Registered users of any one of my shareware packages
  261.               may  contact me using  the voice  number in  the registration
  262.               document.
  263.  
  264.               Since  this is user supported software, I don't expect you to
  265.               register if you don't like it or if it doesn't meet your
  266.               needs. Just stop using it after a reasonable trial period
  267.               (1-2 weeks). The program is not crippled in any way, there is
  268.               a few  seconds  delay at  the  exit of  the program  and  the
  269.               tagline length allowed is be a bit shorter.
  270.  
  271.               If you like the program and use it regularly, please register
  272.               it. The registration cost is a  one-time fee of $20.00.  With
  273.               the  registration you'll receive  unlimited voice support and
  274.               upgrades. Your registration  encourages further  development,
  275.               enhancement and my continued support of the product.   Please
  276.               send your registration in the form of a Money Order, Personal
  277.               cheque,  or Cashier's cheque to the above address.  I'm sorry
  278.               that I cannot process credit card registrations at this time.
  279.  
  280.               ═════[STANDARD DISCLAIMER]═══════════════════════════════════
  281.  
  282.               This program is  provided on an "AS IS" basis. No warranty of
  283.               any kind is expressed or implied. YOU USE THIS PROGRAM AT
  284.               YOUR OWN RISK. I take no responsibility for any damage caused
  285.               directly or indirectly from  the use or the inability  to use
  286.               this program.
  287.  
  288.               ═════[CREDITS/COPYRIGHTS]════════════════════════════════════
  289.  
  290.               QWK/Qmail:
  291.                    Copyrights  of Mark  "Sparky" Herring of  Sparkware, the
  292.                    original creator of QWK.
  293.  
  294.               "Fido", "FidoNet":
  295.                    U.S.  registered  trademarks  of Tom  Jennings  of  Fido
  296.                    Software.
  297.  
  298.               Other:
  299.                    Respected copyright/trademark holders.
  300.  
  301.  
  302.  
  303.  
  304.  
  305.               _____________________________________________________________
  306.               FidoQWK echomail processor documentation ................. 5
  307.