home *** CD-ROM | disk | FTP | other *** search
/ Jason Aller Floppy Collection / 176.img / SLBBS76M.ZIP / SLPACK.ZIP / SLPACK.DOC next >
Text File  |  1989-12-07  |  7KB  |  143 lines
  1.                                                                            
  2. SLPACK                                                            Oct 1988
  3. Searchlight BBS Message File Optimizer                        by F. LaRosa
  4.  
  5.     -----------------------------------------------------------------
  6.                  (c) Copyright 1988 Searchlight Software.
  7.           This program may be used free of charge by registered
  8.                        SEARCHLIGHT BBS owners only.
  9.     -----------------------------------------------------------------
  10.  
  11.  
  12. Discussion: What is SLPACK?
  13. ---------------------------
  14.   SLPACK is a "disk optimizer" utility for your Searchlight BBS message 
  15. base. It will minimize the amount of disk access and maximize the speed 
  16. with which your BBS system can access messages on your disk.  
  17.  
  18.   When the MS-DOS operating system allocates disk space for files, it 
  19. maximizes available storage by allocating small "clusters" of disk space, 
  20. at various locations on the disk, to files as requested. As a result, files 
  21. become "fragmented"- they consist of many chunks of data all over your 
  22. disk. Fragmented files take more time to access, since the system must 
  23. process and access many segments. Many programs are available to optimize 
  24. disk space by uniting fragmented files back into continuous areas on the 
  25. disk.  
  26.  
  27.   Similarly, Searchlight BBS allocates space for messages in small chunks 
  28. in the MESSAGE.BBS file on your disk to make maximum use of disk space, and 
  29. messages are often "fragmented" all over the file. To help speed up access 
  30. to your messages, the SLPACK program will repack your entire message base, 
  31. organizing your messages into continuous areas on the disk. SLPACK will 
  32. also deallocate and free up unused space in your message file (even the 
  33. space that the CHECK command cannot release).
  34.  
  35.   Running SLPACK is not required; even without periodic repacking,
  36. Searchlight BBS provides fast access to messages, and efficient use and 
  37. reuse of disk space. SLPACK is an "optimizer" that you can use to get the 
  38. best possible performance out of your system.
  39.  
  40.  
  41. Using SLPACK
  42. ------------
  43.   The syntax is simple: just type SLPACK at the command line. You must be 
  44. situated in the directory containing your CONFIG.BBS data file. SLPACK will 
  45. print a message and ask you to press "Y" to begin the packing procedure. It 
  46. will then ask you for the number of "free records" to allocate. If you'd 
  47. like to allocate some free space, type in a number, or else press RETURN 
  48. for 0 free records.  
  49.  
  50.   There are two command line options: if you type SLPACK /NOPROMPT, the 
  51. program will proceed without printing the initial message and waiting for 
  52. the keyboard responses. /NOPROMPT must appear in all capitals, exactly as 
  53. shown. If you specify /NOPROMPT, you can also specify the number of free 
  54. records you want (for example, SLPACK /NOPROMPT 200). If a free record 
  55. count is not given, it defaults to 0.  
  56.  
  57.   A couple of important warnings are in order before you begin. First, MAKE 
  58. A BACKUP OF ALL *.BBS DATA FILES BEFORE YOU BEGIN PACKING. The pack 
  59. procedure rearranges every message record and pointer on the system, and if 
  60. it aborts before it can finish (due to power failure, disk errors, or other 
  61. unforseen events) you will have DESTROYED most of your message base beyond 
  62. any hope of recovery. If anything goes wrong during the packing, restore 
  63. your backup and try it again.  
  64.  
  65.   Secondly, if you're running a multinode system, you must make sure that 
  66. all nodes are shut down, and nobody is accessing the database while SLPACK 
  67. runs. Otherwise, you risk corrupting the data files.  
  68.  
  69.   Finally, if you suspect there might be some error or corruption in your 
  70. message base, make sure you check it with the CHECK command before running 
  71. SLPACK. Running CHKDSK on your disk drive is also a good idea.  SLPACK does 
  72. not check for corrupted data, any may hang if there are errors in the data 
  73. file.  
  74.  
  75.  
  76. Error Messages
  77. --------------
  78.   SLPACK may display one of the following messages when it runs:
  79.  
  80. Cannot open system files!
  81.   - You are not located in the directory containing the CONFIG.BBS file.
  82.  
  83. Invalid version. SLBBS version 1.64 or later is required.
  84.   - SLPACK does not operate on systems using earlier versions of SLBBS.
  85.  
  86. Insufficient memory available for packing.
  87.   - SLPACK could not allocate enough memory for the packing operation.
  88.  
  89. Program halted. No action taken.
  90.   - Displayed if you type "N" in response to the initial prompt.
  91.  
  92.   A return code (errorlevel) of 1 is returned if any of these messages is 
  93. displayed. No action will have been taken, and the message base will not 
  94. have been packed or otherwise changed.
  95.   Error levels of 2 and above are returned if the program encounters a 
  96. serious error, such as a disk error, during the pack operation. If an error 
  97. code greater than 1 is detected, the message base will probably have been 
  98. left in a corrupted state, and should be restored from a backup copy.
  99.   A return code of 0 indicates a successful packing.
  100.  
  101.  
  102. A few Notes and Tips
  103. --------------------
  104.   SLPACK will rearrange your message file's internal structure. However, it 
  105. does not guarantee that the message file itself is un-fragmented on the 
  106. disk. To fully optimize disk access, run a disk optimizer on your hard disk 
  107. after running SLPACK. Note that since SLPACK packs the messages "in place", 
  108. without using any temporary files, it won't "fragment" the message file if 
  109. the message file is already contiguously allocated.
  110.  
  111.   You can run SLPACK regularly as an offline event by specifying the 
  112. /NOPROMPT parameter. If you do so, have your batch file make a back-up copy 
  113. of the BBS files before SLPACK runs, and check the return code (errorlevel) 
  114. to be sure of a successful run.  
  115.  
  116.   The "free records" parameter allows you to allocate blank records at the 
  117. end of the message file that will be used as new messages are posted. Of 
  118. course, Searchlight BBS will "expand" the message file if free records are 
  119. not available; however, by allocating them all at once, the free records 
  120. are more likely to be in a contiguous disk block. I would recommend 
  121. allocating some free space, depending on your system's level of activity 
  122. (message blocks are 96 bytes in length).  In particular, if you are running 
  123. a system with multiple nodes, allocating extra records in the message file 
  124. is an extremely good idea, as this increases the efficiency of multinode 
  125. processing (dynamic file expansion can cause difficulty with some multiuser 
  126. operating systems and networks).
  127.  
  128.   SLPACK will generally take more time to execute if the message base is 
  129. highly fragmented, less time if it's already nearly optimized. Therefore it 
  130. will probably take SLPACK longer to run the first time you use it.
  131.   
  132.  
  133. Copyright 
  134. ---------
  135.   This program is (c) Copyright 1988 Searchlight Software. You may use 
  136. this program for free if you are a registered owner of any extended version
  137. of Searchlight BBS. You may distribute this program in unmodified form.
  138.  
  139.  
  140.                                                         F. LaRosa 10/04/1988
  141. ----------------------------------------------------------------------------
  142.  
  143.