home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / OFFLINE / QWKNET12.ZIP / QWKNET.DOC < prev    next >
Text File  |  1993-03-23  |  10KB  |  225 lines
  1.  
  2. ==============================================================================
  3.                             QWKNET  v1.2 (03-22-93)
  4.                         Copyright (c) 1993 by Keith Yox
  5.                 The Matrix BBS, Indianapolis IN, (317) 297-8270
  6. ==============================================================================
  7.  
  8. QWKNET is a program that allows BBS systems with QWK mail capabilities to swap 
  9. public messages with one another without the hassle of complex network 
  10. configuration.  It takes QWK mail packets and converts them to reply packets.
  11. Thus the process of trading mail between two BBSs would be:
  12.  
  13.         1) Package new messages on one BBS into a QWK packet.
  14.         2) Run QWKNET to convert the packet.
  15.         3) Log onto the other BBS and upload the packet to the QWK mail door.
  16.         4) Download a QWK packet from the BBS.
  17.         5) Run QWKNET to convert the packet.
  18.         6) Locally upload the reply packet to your system's mail door.
  19.  
  20.         NOTE: Trading messages can be done completely by one sysop, the other 
  21.               need not do anything, or even have the QWKNET program.  However, 
  22.               sysops may elect to alternate days or week.
  23.  
  24.         The term "link" shall be used to describe the trading of messages 
  25.         between two BBSs.  "Linked" shall describe message bases that will
  26.         contain messages from both systems.
  27.  
  28. The previous process, of course, relies on a few preliminary tasks, but before
  29. explaining how to set up and use QWKNET, the following background information
  30. may prove to be helpful.
  31.  
  32. [ QWK and REP packet structure ]
  33.  
  34. The QWK file downloaded from a BBS is, as one may well know, an archive of
  35. several files.  There is a file for the actual messages, called MESSAGES.DAT,
  36. a file with information about the BBS conferences/message areas (CONTROL.DAT),
  37. message index files, and perhaps a couple files containing news and screens 
  38. from the BBS the mail packet was downloaded from.
  39.  
  40. QWKNET uses two of the files found in a QWK packet: the MESSAGES.DAT file and
  41. the CONTROL.DAT file.  
  42.  
  43. Inside the CONTROL.DAT file, QWKNET gets the name of the BBS the QWK file is
  44. from, and uses an eight-character (or less) identifier that distinguishes the 
  45. BBS from others in the area- in other words, it is an eight-letter (or less) 
  46. name for the BBS.  
  47.  
  48. This identifier, called the BBSID, is usually set by the BBS sysop somewhere
  49. during configuration of the BBS' QWK mail door.  
  50.  
  51. The BBSID for both BBS' in a QWKNET link must be known before setting up and
  52. running QWKNET, and must be looked up manually- QWKNET has no facility for 
  53. finding the information.  Here is how to find the BBSID:
  54.  
  55. 1.  Unarchive the QWK packet.  If it is ZIPped, unzip it.  If it is ARJed,
  56.     unarj it.  Only the CONTROL.DAT file need be extracted.
  57.  
  58. 2.  Load the CONTROL.DAT file in a plain text (ASCII) file viewer or editor.
  59.     The BBSID is the second field (the name after the comma) of the 5th line.
  60.  
  61. In order for QWKNET to run properly, the BBSID for BOTH systems in a link must
  62. be known.  
  63.  
  64. I'm going to drop to first person here for a minute just to make things 
  65. easier.  Your system's BBSID must known...and the BBSID of the system you will 
  66. be trading mail with must be known- the other system's BBSID will be known as 
  67. the "remote BBSID".  
  68.  
  69. One can look further into the structure of the QWK format, but the above is
  70. all that is necessary or helpful in the use of QWKNET.
  71.  
  72. [ The QWKNET.DAT file ]
  73.  
  74. QWKNET gets information on linking from plain text data files.  One such file
  75. is called QWKNET.DAT and must be located in the directory from which the 
  76. program is executed.
  77.  
  78. QWKNET.DAT is a standard text ASCII file.  It can be created and modified by
  79. any test file editor.  The first line in the file is the registration code.
  80. It will normally be simply three zeroes for the unregistered version, and
  81. should be replaced by the code upon registration.  The second line is the
  82. name of (dropping to first person) *your* BBS' QWK packet name.  Do not 
  83. include the extension (.QWK).  The third line of this file contains your BBS'
  84. BBSID.
  85.  
  86. [ Other QWKNET data files ]
  87.  
  88. In the same way that the QWKNET.DAT file stores information about your BBS,
  89. there are other files that store info about the systems you will be linked
  90. with.  These files are named in the following way:
  91.  
  92. <remote QWK packet name>.DAT
  93.  
  94. The name of the QWK file that you download from the other system is called
  95. the remote QWK packet name.  For instance, if you download EMPIRE.QWK from the
  96. BBS you will be trading messages with, the remote QWK packet name is EMPIRE.
  97. Thus the name of the data file will be EMPIRE.DAT.
  98.  
  99. This file will also be a straight text file.  It will have three different
  100. sections: a conversion section, a remote BBSID section, and a tagline section.
  101.  
  102. Section 1:  Conversion 
  103.  
  104. Every BBS that has the capability of bundling messages in the QWK format 
  105. assigns a number to each conference or message base.  This number we will call
  106. the QWK conference number.
  107.  
  108. To make things more convenient for both SysOps, QWKNET can convert messages
  109. from a conference on your BBS, to a differently numbered conference on the
  110. other BBS.  For example, on your BBS conference number 1 is called "Religion".
  111. The other SysOp has assigned "Religion" to conference number 8.  QWKNET can
  112. be told to take messages from conference number 1 on your system and put them
  113. in conference number 8 on the other.
  114.  
  115. The conversion section of the .DAT file tells QWKNET what conferences numbers
  116. to convert messages to. 
  117.  
  118. The first line of the conversion section (also the first line of the .DAT file)
  119. is a single number stating how many conferences will be involved in the link.
  120. If five conferences are being linked, this line will contain the number 5.
  121.  
  122. NOTE:  If you do not wish for any conversion to take place- that is, the 
  123.        conference numbers on both BBSs refer to the same subject- type a
  124.        zero (0) on this line.  Then go directly to the remote BBSID section. 
  125.  
  126. For every conference involved in the link, there will be a set of two numbers.
  127. Each set of two numbers will occupy a line in the file.  The first number will
  128. be the number of a conference on your BBS, the second will be the number of
  129. the same conference on the other system.   Using the previous example with the
  130. religion conference, the first number will be one and the second number will 
  131. be an eight, separated by a space.  Again, do this for every conference that 
  132. will be linked.
  133.  
  134. Section 2:  The Remote BBSID
  135.  
  136. The second section of the .DAT file consists of entering only piece of inform-
  137. ation: the remote BBSID.  On a separate line of the file, type the BBSID of the
  138. other system.
  139.  
  140. Section 3:  The Tagline 
  141.  
  142. The third section will be the last line of the .DAT file.  This line can be a
  143. tagline of your choice, to be added to all *outgoing* messages.  It should be 
  144. a maximum of 45 characters in the unregistered version, and 65 characters once
  145. registered.
  146.  
  147. *** SAMPLES
  148.  
  149. The following is a few sample .DAT file. 
  150.  
  151. SAMPLE #1
  152. ---------
  153.  
  154. 1                                    <-  Only one conference is being linked
  155. 2 12                                 <-  Conference 2 will be converted to 12
  156. dreamnet                             <-  The remote BBSID is "dreamnet"
  157. Testing: DreamNET <=> The Matrix     <-  This is the *outbound* tagline
  158.  
  159. SAMPLE #2
  160. ---------
  161.  
  162. 0                                    <-  No conversion will take place
  163. sample                               <-  The remote BBSID is "sample"
  164. The Sample .DAT file                 <-  This is the *outbound* tagline
  165.  
  166. SAMPLE #3
  167. ---------
  168.  
  169. 3                                    <-  Three conferences are being linked
  170. 2 12                                 <-  Conference 2 will be converted to 12
  171. 5 8                                  <-  Conference 5 will be converted to 8
  172. 10 13                                <-  Conference 10 will be converted to 13
  173. skyrocket                            <-  The remote BBSID is "skyrocket"
  174. Blasting off to the Skyrocket        <-  This is the *outbound* tagline
  175.  
  176.  
  177. [ USING QWKNET: COMMANDLINE PARAMETERS ]
  178.  
  179. The syntax for QWKNET is:
  180.  
  181.         QWKNET 1|2 3|4 <r_qwk> [<DATdirectory>\]
  182.  
  183.         Switch one:  If it is "1", QWKNET will prepare outgoing messages for 
  184.         upload to the other BBS.  If it is "2" QWKNET will convert another 
  185.         BBSs QWK to a reply packet understandable by your BBS.
  186.  
  187.         Switch two:  If it is "3", QWKNET will use PKZIP.EXE/PKUNZIP.EXE to 
  188.         compress and decompress packets.  If it is "4", QWKNET will use 
  189.         ARJ.EXE to do this. Whichever is used must be located somewhere in the 
  190.         PATH environment variable.
  191.  
  192.         The third parameter is the remote QWK packet name (discussed
  193.         previously).  Do NOT include the extension (.QWK).
  194.  
  195.         The fourth parameter is optional.  It allows the .DAT files (not
  196.         QWKNET.DAT) to be stored in a separate directory.  Simply type the
  197.         full pathname (include the final backslash) on the commandline.
  198.         ** QWKNET.DAT must be located in the directory from which the program
  199.            is executed.
  200.  
  201.  
  202. WRAPPING THINGS UP....
  203.  
  204. That's about it (I think). <grin>  Anyway, I hope this program helps those 
  205. sysops out there wishing to link with a small group of BBSs without having to 
  206. go through the work of creating nodelists and so forth.  I'd like to hear
  207. everyone's comments as to whether this documentation file is too terse or if
  208. it is adequate.
  209.  
  210. This program is copyrighted and distributed freely under the shareware concept.  
  211. If this program is used for a period of time in excess of 30 days, you are 
  212. legally obligated to purchase it.  The registration fee is only a meager $5 
  213. (use the form contained in REGISTER.TXT)...it lets me know that there is a 
  214. following for the program as well as for future development.  
  215.  
  216.      QWKNET is distributed without warranty.  In no event will Keith Yox be 
  217.      liable to you for damages, including any loss of profits, lost savings, 
  218.      or other incidental or consequential damages arising out of your use of 
  219.      or inability to use the program.
  220.  
  221. Please see REGISTER.TXT for further details.
  222.  
  223.         
  224.        
  225.