home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / OFFLINE / QXL10.ZIP / QXL.DOC < prev    next >
Text File  |  1994-03-08  |  6KB  |  175 lines
  1. QXL - Copyright (c) 1994 - Anthony Summy, All rights reserved.
  2. Version 1.00 - Release Date: 03/08/94
  3.  
  4. QWK Upload Translation Utility
  5.  
  6.  
  7. DESCRIPTION
  8. ~~~~~~~~~~~
  9. Converts a .REP packet (QWK upload) from one hub format to another.
  10.  
  11. This is usefull when a network node (site) is obtaining downloaded
  12. mail from a third party source such as a satellite, and uploading to a
  13. normal hub.  This allows the node software to maintain one single hub,
  14. and therefore maintain proper message pointers and high message
  15. numbers, and eliminates the need to 'reset' your node software or
  16. perform any additional unneeded exports.
  17.  
  18. QXL is written in 'C', uses highly buffered file IO, and is highly
  19. optimized for speed.  You will find it to be extremely fast.  In our
  20. in-house tests, on a 386/33 it processed a 3 megabyte REP packet in
  21. about 30 seconds (not counting ZIPPING and UNZIPPING which we have no
  22. control over).
  23.  
  24.  
  25.  
  26. INSTALLATION
  27. ~~~~~~~~~~~~
  28. QXL does not require it's own directory to function.  There is no
  29. special installation needed.  Simply place the .EXE into a directory
  30. in your path.  If you have a directory where you place general purpose
  31. utilities, that would be a good place for QXL.EXE to reside.
  32.  
  33. NOTE: QXL creates and maintains translation tables (explained in the
  34.       next section) in the SAME DIRECTORY as the EXE resides.  If you
  35.       are operating on a network, you must grant READ/WRITE rights to
  36.       the directory where QXL.EXE resides.
  37.  
  38.  
  39.  
  40. SETUP AND OPERATION
  41. ~~~~~~~~~~~~~~~~~~~
  42. You must first obtain a list of the forums on hub you will be
  43. converting from and the hub you will be converting to, and be
  44. confortable with how the two relate.
  45.  
  46. QXL uses a set of TABLES for the translation process.  These tables
  47. are stored in the same directory that QXL.EXE resides.
  48.  
  49.  *  The first list of forums will be the 'SOURCE' and will actually be
  50.     the list that is native to the QWK packet that you download from
  51.     the satellite.
  52.  
  53.  *  The 'HOST' list of forums is the forum list of the hub you are
  54.     uploading to, and that QXL translates to.
  55.  
  56.  *  QXL reads the SOURCE packet and translates it to the HOST packet.
  57.  
  58.  
  59.  
  60. THE MAIN MENU
  61. ~~~~~~~~~~~~~
  62. Run QXL with no parameters and you will get the main menu.  The menu
  63. items should be self-explainatory, but here they are in detail.
  64.  
  65. Create a Translation Table
  66. --------------------------
  67. This creates an empty 'source' table for you to edit.  All forums will
  68. initially be set to NONE.  (see next section).
  69.  
  70. Delete a Translation Table
  71. --------------------------
  72. This selection pops a picklist of existing tables, and allows you to
  73. delete one.  CAUTION: DELETING A TABLE IS PERMINENT!
  74.  
  75. Edit a Translation Table
  76. ------------------------
  77. This selection pops the same picklist as the 'delete' option above,
  78. but then opens the table editor.  (see next section).  A table must
  79. exist (ie: have been created) before it can be edited.
  80.  
  81. Exit to DOS
  82. -----------
  83. Exits the program and saves your changes.
  84.  
  85.  
  86.  
  87. EDITING A SOURCE TABLE
  88. ~~~~~~~~~~~~~~~~~~~~~~
  89. The tables mentioned in the previous section are stored on disk as
  90. '<SOURCE>.TBL' in the directory which QXL.EXE resides.  DO NOT DISTURB
  91. THESE FILES or you will loose your translations.  Each table is 20,000
  92. bytes, and you can have as many tables as you have disk space for.
  93.  
  94. To set up your source tables, have the list of 'SOURCE' forums and
  95. your list of 'HOST' forums in front of you.  Choose 'Edit A
  96. Translation Table' from the main menu and you will get the table
  97. editor.
  98.  
  99. Once in the editor, the left column will be numberd in sequential
  100. order, and will be the 'SOURCE' list.  Simply enter the 'HOST' forum
  101. number to translate TO in the right column for each 'SOURCE' forum in
  102. the left.  To delete a translation, place the letter 'N' (for NONE)
  103. anywhere in the field.  Any forums with 'NONE' will be ignored.  (That
  104. is, if a message comes from your SOURCE.REP in a forum that has 'NONE'
  105. in it, the message will be DISCARDED).
  106.  
  107. Press ESC and your table will be saved.
  108.  
  109.  
  110.  
  111. OPERATION
  112. ~~~~~~~~~
  113. Once you have the table for a 'SOURCE' completed, run the program as
  114. follows:
  115.  
  116. Change to the directory where <source>.REP is located, (probably your
  117. upload directory), and type:
  118.  
  119. QXL <source> <host> <enter>
  120.  
  121. <source> and <host> should be the QWK name of each, WITHOUT the
  122. extension.  The program will read <source>.TBL, and use it to convert
  123. <source>.REP to <host>.REP.  Note: <source>.REP must be in the CURRENT
  124. directory.  In addition, the program deletes <source>.REP when the
  125. conversion is successful.
  126.  
  127. For example:
  128.  
  129. QXL INTELEC THEMAIN <enter>
  130.  
  131. This would read INTELEC.TBL, and use it to convert INTELEC.REP to
  132. THEMAIN.REP.  All forum numbers and packet names would be converted,
  133. and any messages in forums that were not configured would be filtered
  134. out and discarded.
  135.  
  136. The actual process is as follows:
  137.  
  138. 1) Opens <source>.TBL, reads int into memory and closes it.
  139. 2) Unzipps <source>.REP and extracts <source>.MSG.
  140. 3) Opens <source>.MSG and creates <host>.MSG
  141. 4) Reads <source>.MSG, writes <host>.MSG, changing the forum numbers
  142.    in the process.
  143. 5) Closes both .MSG files
  144. 6) Zipps <host>.MSG into <host>.REP
  145. 7) Deletes <source>.REP, <source>.MSG and <host>.MSG.
  146.  
  147. NOTES:
  148.  
  149. 1) QXL attempts to swap to EMS while shelling out to zip or unzip a
  150.    packet.  If EMS is not available, or there is not enough, QXL will
  151.    swap to disk.  There may be a slight delay while this occurs.
  152.  
  153. 2) QXL uses PKZIP/PKUNZIP to pack/unpack the REP.  You _MUST_ be using
  154.    ZIP in the QWK door you call to upload your REP to.  Other
  155.    compression programs are not supported at this time.
  156.  
  157.  
  158.  
  159. REGISTRATION
  160. ~~~~~~~~~~~~
  161. QXL is NOT free, and NOT commercial.  It is copyrighted SHARWEARE.
  162.  
  163. QXL is not crippled in any way, and will continue to function normally
  164. even if not registered.  However, you are legally required to register
  165. QXL within 30 days of begining to use it.  It is our opinion that you
  166. will be so satisfied with the ease of operation, that you will gladly
  167. register the product within that amount of time.
  168.  
  169. Registration is $10.00.
  170.  
  171. See REGISTER.DOC for details on registering QXL.
  172.  
  173. Tony Summy - Author
  174. QXL - v1.00 03/08/94
  175.