home *** CD-ROM | disk | FTP | other *** search
/ Best Objectech Shareware Selections / UNTITLED.iso / boss / comm / misc / 021 / flsort.doc < prev    next >
Encoding:
Text File  |  1992-05-06  |  8.7 KB  |  201 lines
  1.                ------------------------------
  2.                F I L E   L I S T  S O R T E R
  3.                ------------------------------
  4.  
  5. Welcome to Crazy Quilts File List Sort Utility.  This is an exciting
  6. program that will make your BBS run more efficiently and a lot faster
  7. when scanning for new files at log on.
  8.  
  9. Being new to developing shareware, I have a trusting nature and do not
  10. cripple my software in any way.  This copy represents the full working
  11. copy.  Please do not abuse my trust.  All that will accomplish is to
  12. force us shareware authors to spend a lot of extra time crippling our
  13. software, limiting features, and in general making life unpleasant to
  14. all involved.  Please register this software if you use it.  Enough said!
  15.  
  16. PURPOSE
  17. -------
  18. FLSort is designed to provide sorted BBS files lists (i.e. Files.BBS)
  19. while not affecting the performance of your BBS.  Let me explain...
  20.  
  21. When a user logs on to your BBS and does a new file scan, the following
  22. steps are what may occur (depending on your BBS package):
  23.  
  24. 1.  Examine the user log file and determine the date this user last logged on.
  25. 2.  Go to the first file list and determine the file date.
  26. 3.  If the file list date is older then the last log on date, that
  27.     directory is skipped (no new files in that directory).
  28. 4.  If the file date is NEWER then the last log on date, then the file
  29.     list is opened.
  30.     a.  Each file name is extracted from the file list, one at a time.
  31.     b.  The corresponding disk file is located.
  32.     c.  The file date on the disk file is checked.
  33.     d.  If the file date is older then the last log on date, it is skipped.
  34.     e.  If the file date is newer, then it is displayed to the user.
  35.     f.  This continues for every file in the file list (very sloooow).
  36. 5.  Each file list is examined in this way.
  37.  
  38. Problem:  All of the sort utilities I have seen update the date of the
  39.           file list whenever it sorts it!
  40.  
  41. Result:   This causes your BBS to search through every darn directory,
  42.           even though there may not be any new files in it.
  43.  
  44. Solution: FLSort!  File List Sorter Utility sorts your File Lists and
  45.           leaves the file date intact (it does not update it).
  46.  
  47. Result:   Much faster new file scans.  It only scans those directories
  48.           that really contain new files!  Great!!!
  49.  
  50. Okay, now that you are sold, send in your registration money ($9.00 US) to
  51.  
  52.                          Crazy Quilts Software
  53.                            Armando Caceres
  54.                             117 Crocus St.
  55.                        Lake Jackson, Texas 77566
  56. INSTALLATION
  57. ------------
  58. Before making changes to your valuable files list, FLSort makes a backup
  59. of the file. To make it compatible with all the different file list
  60. utilities out there, you can tell FLSort what you want it to name this
  61. backup file.  FLSort will also sort any type of Text Based file list.
  62. You can sort Files.BBS, Files.TD, RA_Files.ASC and any other type of
  63. file list you can think of.  The only requirement is that each line
  64. begins with the file name.  If your file list or file lists meet
  65. this criteria, FLSort will sort it.  FLSort watches out for dashed lines
  66. or any lines that begins with a space.  It treats any lines following
  67. a dash or a space as a seperate list.  This makes it possible to add
  68. comments to your file list and not have them sorted when using FLSort.
  69. One problem with this that you should be aware off, when files are added
  70. to the end of the list, they will be sorted under the last dashed or
  71. spaced line. Oh well, if your last dashed line is titles "New Files" at
  72. least your new files in that directory will be sorted until you can get
  73. in there and manually move them into the right catagory.  If you do not
  74. do this with your files list then no big deal!
  75.  
  76.  
  77. CONTROL FILE
  78. ------------
  79. To operate, FLSort needs a control file.  This file is extremely easy to
  80. set up and you can set up multiple control files to sort multiple types
  81. of file lists.  The control file is a simple text file.  The first line
  82. of the text file must have the name you want FLSort to use when creating
  83. the back up of your file list.  Regular DOS conventions apply here.  It
  84. can be 8 characters long followed by no more than a 3 character
  85. extension.  i.e.  MYFILES.CTL
  86.  
  87. The remaining lines in the control file are used to tell FLSort what
  88. files to sort.  Each line should have two pieces of information.  (1)
  89. The name of the file to sort and (2) The full path to this file.
  90.  
  91. i.e.  Files.BBS C:\RA\FILES\GIF
  92.  
  93. Please note that a single space must separate the name of the file and
  94. the path statement.  Both of these parameters are required for FLSort to
  95. find the correct file to sort.  Following is a short example of what
  96. your control file should look like:
  97.  
  98. ------------------------------------------------------------------------------
  99. - FLSort.CTL -
  100.  
  101. FLSORT.BAK
  102. FILES.BBS C:\BBS\FILES\GIF
  103. FILES.BBS C:\BBS\FILES\UTILS
  104. FILES.BBS C:\BBS\FILES\GAMES
  105. CONTACTS.LST C:\PERSONAL\WORK  <-- FLSort doesn't care what it sorts so long
  106.                                    as it is a text file and you want it sorted!
  107.                                    However, it will name the back up the same as
  108.                                    the others...
  109.  
  110. ------------------------------------------------------------------------------
  111.  
  112. If you want to have FLSort name back ups differently for different files
  113. lists, then simply make a separate control file for those files and pass
  114. the name to that control file to FLSort.  For example, suppose I have a
  115. file listing utility that makes its own file list named FILES.TD, but I
  116. also want to maintain my FILES.BBS list and I want backups for both of
  117. these lists.  To accomplish this I just make two separate control files
  118. as follows:
  119.  
  120. ------------------------------------------------------------------------------
  121.  
  122. - FILESBBS.CTL -
  123.  
  124. FILES.BBK  <-- The name of the back up files to make.
  125. FILES.BBS C:\BBS\FILES\GIF
  126.     .
  127.     .
  128.     .
  129. FILES.BBS C:\BBS\FILES\UTILS
  130.  
  131.  
  132.  
  133. - FILESTD.CTL
  134.  
  135. FILES.BTD   <-- The name of the back up files to make.
  136. FILES.TD C:\BBS\FILES\GIF
  137.     .
  138.     .
  139.     .
  140. FILES.TD C:\BBS\FILES\UTILS
  141.  
  142. ------------------------------------------------------------------------------
  143.  
  144. FLSort can be run from a .BAT file as part of your nightly maintenance.
  145. This will keep your file lists sorted and you never have to worry about
  146. it again.
  147.  
  148. I have included a sample control file as part of this archive (this will
  149. only work on my system, unless you happen to have the same directories
  150. set up as I do).  You can examine it if you like, or just delete it and
  151. save some disk space.
  152.  
  153. One more note, notice that I didn't put a trailing back slash on the path
  154. statements.  You can do it either way, but it works faster if you leave
  155. it off.  Also, you can list as many file lists as you want (200, 600,
  156. 1000, it makes no difference).  But do not leave any empty lines
  157. anywhere in the file.  If an empty line is encountered that will signal
  158. FLSort that it has reached the end of the file and FLSort will exit.
  159.  
  160.  
  161. PERFORMANCE and LIMITATIONS
  162. ---------------------------
  163. FLSort is extremely fast.  It is fast and flexible so there is a slight
  164. tradeoff in speed (I won't get into it).  Still, compared to other file
  165. list sorters I have looked at, it is more than fast enough!  To
  166. accomplish this FLSort loads the entire file list into memory.  I have
  167. sorted 90K file lists (that was the biggest one I had), and it churned
  168. that baby out in a couple of seconds without any problems.  If you are
  169. worried that you may not have enough memory, FLSort uses 1K of memory
  170. for every 4 lines of text.  If you have 250K (which is minimum for most
  171. BBS's), that will let you sort lists a little less than 1000 lines long.
  172. A little less because FLSort takes a little memory itself (about 12K or
  173. so).
  174.  
  175.  
  176.  
  177. WARRANTY
  178. --------
  179. FLSort is guaranteed to do nothing except take up a tiny bit of disk
  180. space.  Crazy Quilts Software and Armando Caceres are not responsible
  181. for any damages, loss of money or income, or any other thing that
  182. happens as a result of using this software.  Use this software at your
  183. own risk.
  184.  
  185.  
  186. COPYRIGHT NOTICE
  187. ----------------
  188. FLSort (File List Sorter Utility) is copyrighted by Crazy Quilts
  189. Software and Armando Caceres.  You have the right to use this software
  190. free of charge for a period not to exceed 30 days.  After that time
  191. period has expired, you must either register this software or remove it
  192. from your system and discard it.  You may not use it after the 30 day
  193. period (give me a break, huh?).
  194.  
  195. That's it!  If you have any questions, comments, or suggestions for
  196. improving FLSort or any other Crazy Quilt product, drop me a note at
  197. FIDO 1:3812/30.  Thank you.
  198.  
  199.  
  200. Armando Caceres
  201.