home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / DEMO510.ZIP / QWK.INS / QWK.DOC next >
Text File  |  1999-01-25  |  8KB  |  165 lines
  1.  
  2. Searchlight QWK Offline Mail Module
  3. -----------------------------------
  4. This software creates and accepts offline mail packets from your callers in 
  5. the universal QWK mail packet format. To use it, callers must have an 
  6. offline mail reader capable of reading a QWK packet; there are wide variety 
  7. of such products available.
  8.  
  9. Searchlight's QWK module has some significant advantages over the existing 
  10. QWK options. It has both a remote and local RIP interface. It also supports 
  11. ANSI and nonANSI users. It supports an unlimited number of conferences as 
  12. well as the extended message structures introduced in Searchlight BBS 4.5.
  13.  
  14.  
  15. Installation
  16. ------------
  17. The QWK.EXE program may be executed with one of three parameters, 
  18. corresponding to its three main functions: Download, "Fast" Download, and 
  19. Upload. In each case, QWK.EXE is installed on a menu as a door, using 
  20. parameters as shown below:
  21.  
  22.  6. Door Command ................. C:\SLBBS\QWK.EXE L
  23.  7. Directory Path ............... .
  24.  8. Communications Support ....... None
  25.  
  26. The command "QWK.EXE L" specifies the "Download" option. The options for 
  27. Fast Download and Upload are specified with the letters "D" and "U", 
  28. respectively.
  29.  
  30. The QWK.EXE file can be placed in your Searchlight home directory or in any 
  31. convenient location. QWK.EXE must have access to the PKZIP and PKUNZIP 
  32. commands. You need to ensure that these commands are available in your DOS 
  33. command search path. Make sure you place the QWK.OVR file in the same
  34. directory as QWK.EXE.
  35.  
  36. Notice that line 7 contains a single period character. In line 6, you must 
  37. of course specify the correct path to the QWK.EXE file as it exists on your 
  38. own system. For Communications Support, always specify "None".
  39.  
  40. In addition to the three main functions, a QWK User Options function is 
  41. available by executing internal command 144 from within Searchlight. This 
  42. option lets callers adjust a number of QWK parameters, as described below.
  43.  
  44. We have included several sample files, including a menu file and RIP screen 
  45. that you can use on your BBS. If you would like to use our examples, copy 
  46. the *.TXT and *.RIP files in this archive into your Searchlight text 
  47. directory and copy the *.MNU files to your menu directory. You may edit 
  48. these files to your liking if you wish. If you use our *.MNU files PLEASE 
  49. EDIT THE MENU AND CHANGE THE DOOR COMMAND (LINE 6) TO FIT YOUR SYSTEM. We 
  50. included a separate menu for RIP and ANSI/Text users. You can of course use 
  51. your own menus if you choose.  
  52.  
  53.  
  54. Configuration
  55. -------------
  56. The main Sysop configuration for the QWK program is contained within your 
  57. Searchlight 4.5 Config program. (You must be running Searchlight 4.5 to use 
  58. this module). To access the QWK configuration, run your Config program and 
  59. select "QWK Mail Configuration" from the main screen. These options appear:
  60.  
  61.  
  62. Searchlight BBS QWK Mail Setup
  63.  
  64.  1. BBS Packet ID ................. SLBBS
  65.  2. BBS Name ...................... Searchlight BBS
  66.  3. BBS Location .................. Cleveland, OH
  67.  4. BBS Phone Number .............. 216-631-9285
  68.  5. Sysop's Name .................. Darrell Davis
  69.  6. Max Messages per Conference ...    100
  70.  7. Max Messages per Packet .......    500
  71.  8. Local Upload/Download Dir ..... C:\TP\QWK\WORK\
  72.  9. Use Current Conference List ... No
  73. 10. Use Current Directory List .... No
  74.  
  75. (1) BBS Packet ID
  76. This string is used to name of each packet downloaded from your BBS. For 
  77. example, on our BBS we use the string SLBBS, which results in packet names 
  78. such as SLBBS12.QWK. Try to use a string that is unique to your BBS in order 
  79. to aviod confusion with others.  
  80.  
  81. (2) BBS Name
  82. (3) BBS Location
  83. (4) BBS Phone Number
  84. (5) Sysop's Name
  85. These strings are placed in the QWK packet for the user's reference. They
  86. are not otherwised used by the QWK program.
  87.  
  88. (6) Max Messages per Conference
  89. (7) Max Messages per Packet
  90. These numbers determine the maximum number of messages a user can download 
  91. at any one time. Setting maximum per conference and per packet values helps 
  92. your callers avoid accidentally downloading a much larger packet than is 
  93. desired, and is especially useful if you carry a large number of echo or 
  94. usenet conferences. When building the QWK packet, if the next conference 
  95. contains a number of messages that will exceed the packet limit, that 
  96. conference is skipped.  
  97.  
  98. (8) Local Upload/Download Dir
  99. This is the directory where the QWK module will save QWK packets and look 
  100. for QWK replies during a local login. If you want use the QWK program during 
  101. a local login, set this path to point to the directory where your QWK mail 
  102. reader expects to find its data files.
  103.  
  104.  (9) Use Current Conference List
  105. (10) Use Current Directory List
  106. These options allow you to specify whether the QWK program looks at all 
  107. available conferences and directories, or whether it allows only those 
  108. conferences and directories which were active in Searchlight at the time the 
  109. QWK program was launched to be used. If you have a large BBS and split your 
  110. conferences into sections, you can place a QWK command on the local menu for 
  111. each section and thus allow callers to download packets that only contain 
  112. specific conferences. If you prefer that the QWK program use all conferences 
  113. and file areas regardless of how it is launched, leave these options set to 
  114. "No". Note that the directory option controls the creation of the "New Files 
  115. List", if one is requested by the caller.
  116.  
  117. If a WELCOME, NEWS, or GOODBYE file (no extension) exists in the text 
  118. directory, these files will be included in the QWK packet. Most readers can 
  119. display these files automatically. These files can be ascii, ANSI, or RIP, 
  120. but remember that some readers can only deal with ascii files.
  121.  
  122.  
  123. Operational Notes
  124. -----------------
  125. The QWK module can be executed with one of three parameters to determine the 
  126. mode of operation. Those parameters are L for Download, D for Fast Download, 
  127. and U for Upload. In regular Download mode, the user is presented with a 
  128. list of available conferences. The user can select which conferences to 
  129. download messages from and how many messages to download in each. In Fast 
  130. Download mode, the conferences the user last selected are included in the 
  131. packet. In Upload mode, the user is prompted to upload a reply packet. If 
  132. any messages in the reply packet can't be imported, the user will be sent a 
  133. mail message with the reason and the text of the bad message.  
  134.  
  135. While in list mode, the user can select the Help button to view an online 
  136. help file. This file is called QWKHELP.TXT and be located in the TEXT 
  137. directory. We supply an example QWKHELP.TXT file with this archive; you may 
  138. edit or replace it if you like.
  139.  
  140. For more information about the operation of the QWK module, please read the 
  141. enclosed QWKHELP.TXT and QWKINTRO.TXT files. We suggest making QWKINTRO.TXT 
  142. available for your users to read.
  143.  
  144. The QWK module is multinode capable. It creates a working directory named 
  145. QWKWORK.$$$ under each of your node's home directories. Do not use these 
  146. directories for any other programs. QWK cleans out its working directory 
  147. before beginning each new packet build. It is normal to find the results of 
  148. the last packet build in each directory between calls.  
  149.  
  150. Please note that the QWK.EXE program uses Searchlight's default language 
  151. file and makes extensive use of new strings added to the language file 
  152. with Searchlight 4.5. You must install the Searchlight 4.5 language file to 
  153. use this program.
  154.  
  155.  
  156. Logging
  157. -------
  158. The QWK program uses Searchlight 4.5's SYSLOG.DBF file to log errors. You 
  159. can find QWK's log entries under the action code "Q". QWK's logging can be
  160. enabled and disabled by toggling line 12 under "Activity Logging" in the 
  161. Searchlight 4.5 Config program.
  162.  
  163. See SYSLOG.DOC in your Searchlight 4.5 documentation for more information.  
  164.  
  165.