home *** CD-ROM | disk | FTP | other *** search
/ Eagle Eye CD-ROM BBS Network / eagle-eye-cdrom-bbs-network.iso / bbs_util / dsort300.arj / DSORT.TXT < prev   
Text File  |  1993-01-08  |  8KB  |  206 lines
  1.                          ======== ======   =======
  2.                             ==    ==   ==     ===
  3.                             ==    ==   ===   ===
  4.                             ==    ==   ==   ===
  5.                             ==    ======   =======
  6.  
  7.                    =======================================
  8.                    The DeAdZoNe Utilities for RemoteAccess
  9.                    =======================================
  10.  
  11.                                      D-SoRt
  12.                         FILES.BBS sorter for RemoteAccess
  13.                          Version 3.00   January 8, 1993
  14.                        (C) Copyright Victor Magdic 1992-93
  15.                                All Rights Reserved
  16.  
  17.  
  18. Description
  19. -----------
  20. D-SoRt is a feature packed utility for RemoteAccess which is designed to easily
  21. and quickly sort your FILES.BBS files in alphabetical order.  D-SoRt is designed
  22. for use with RA 1.11 (compatibility with future versions is not gauranteed).
  23.  
  24.    Note: Please read the "Considerations" section below, before attempting to
  25.          use D-SoRt.
  26.  
  27. Features
  28. --------
  29.    *   D-SoRt can be configured to skip certain file areas from being sorted.
  30.    *   If you have header lines (which provide the user with information about
  31.        the file area etc.) at the top or anywhere else in your FILES.BBS D-SoRt
  32.        will preserve them intact.(Please read the section labelled "Header
  33.        lines" below.)
  34.    *   D-SoRt will preserve `blocks' of text and only sort within those blocks
  35.        (for example, if you have FILES.BBS broken down into sections, D-SoRt
  36.        will preserve those sections).
  37.    *   D-SoRt is FREE!
  38.  
  39.  
  40. How much does it cost?
  41. ----------------------
  42. This utility is FREE!  If you like it you can continue to use it for as long as
  43. you like free of charge!
  44.  
  45. If you do decide to use it, I would be excited to hear from you !!  I encourage
  46. you to send me a postcard at the address listed below (see the end of this text
  47. file), or send me a message via netmail. It will cost you practically nothing,
  48. and will let me know you're enjoying the program. It will also give me incentive
  49. to keep improving the program and make it even better!
  50.  
  51. Of course donations are graciously accepted <grin> -and if you want to make a
  52. donation please see the address at the end of this text file.
  53.  
  54.  
  55. How To Use D-SoRt
  56. -----------------
  57. To sort your file areas simply run DSORT.EXE. One command line switch is
  58. supported:
  59.  
  60.    DSORT /N     Suppresses the creation of a backup file of your FILES.BBS
  61.                 (called FILES.BAK) before sorting begins.
  62.                 
  63.                 Normally D-SoRt will make a backup of FILES.BBS, this switch will
  64.                 turn that feature off.
  65.                 
  66.  
  67.  
  68. If you want to configure D-SoRt to exclude certain file areas from being sorted,
  69. run it with the /C switch. This will bring up the built in configuration
  70. "editor", which you can use to choose the file areas you want sorted. The editor
  71. is self-explanatory.
  72.  
  73.      example:       DSORT /C
  74.  
  75.  
  76. Location of Files
  77. -----------------
  78. D-SoRt requires that your RA environment variable is set so that it can locate
  79. certain RemoteAccess files (D-SoRt reads FILES.RA for the file area
  80. information).
  81.  
  82. D-SoRt can be run from any directory. but be sure to run it from the directory
  83. where the D-SoRt config file is located (DSORT.CTL).
  84.  
  85.  
  86. Header Lines
  87. ------------
  88. Many sysops like to put header lines at the top or in the middle of their
  89. FILES.BBS, which provide some kind of information to the user about the files in
  90. that particular file area (e.g. download restrictions or warnings etc). Other
  91. sysops like to split each FILES.BBS into `blocks' of files, separating the
  92. blocks with dashes, or text.  Most sort utilities will not recognize these
  93. situations and will sort your descriptive text (header lines) into your file
  94. descriptions -in short you will end up with one ugly jumbled mess!
  95.  
  96. D-SoRt does away with these problems by *recognizing* such header lines, and not
  97. disturbing them. In fact, D-SoRt's intelligent sort routine will recognize
  98. header lines anywhere in FILES.BBS. For example, consider the following
  99. FILES.BBS layout:
  100.  
  101.            HEADER 1
  102.            --------
  103.            File1
  104.            File2          ---> Block 1
  105.            File3
  106.            
  107.            HEADER 2
  108.            --------
  109.            File4
  110.            File5          ---> Block 2
  111.            File6
  112.  
  113.  
  114. D-SoRt will sort Block 1 and Block 2 separately. In other words, File1,2,3 will
  115. be sorted, and kept under Header 1, then File4,5,6 will be sorted and kept under
  116. Header 2. D-SoRt will also maintain the proper placement of dashes, blank lines,
  117. and other separator lines.
  118.  
  119. D-SoRt determines whether a line is "header" information, or whether it is a
  120. valid filename/description by using the following criteria:
  121.  
  122.          The line is assumed to be a header line if it starts with:
  123.  
  124.                a space; or
  125.                a dash `-'; or
  126.                an equals sign `=`; or
  127.                is a blank line
  128.  
  129.  
  130. Considerations
  131. --------------
  132. The following considerations apply when using D-SoRt,
  133.  
  134.    *   D-SoRt will handle a maximum line length of 255 characters. If your
  135.        file descriptions exceed this length they will be truncated to 255
  136.        characters.
  137.    *   D-SoRt is unable to sort file descriptions which span multiple lines at
  138.        this time. I am working on a version which will accomodate this.
  139.    *   D-SoRt will handle a maximum of 1000 file entries within each `block'
  140.        (see above under `Header Lines' for explanation of blocks).  There is no
  141.        limit to the number of blocks you can have, so as long as you do not
  142.        exceed 1000 file descriptions per block, D-SoRt will have no problems
  143.        sorting that particular FILES.BBS.
  144.    
  145.    Note: If you have more than 1000, that particular FILES.BBS will not be
  146.          sorted and D-SoRt will abort with an error message. Even though an
  147.          error message is generated, no modifications will be made to the
  148.          FILES.BBS, so nothing will be "damaged".
  149.  
  150.  
  151. Legal Stuff and Disclaimer
  152. --------------------------
  153. "D-SoRt" refers to the executables and documentation in the original
  154. distribution archive. D-SoRt is copyrighted material by the author, Victor
  155. Magdic. All rights are reserved.  The author grants you a licence to use this
  156. software free of charge.
  157.  
  158. The program is provided "as is", without warranty or guarantee of any kind,
  159. either expressed or implied, as to its quality or performance. The author will
  160. not be held liable to you or anyone for any direct, indirect, incidental or
  161. consequential damages, including but not limited to any lost profits, or lost
  162. savings which may result from the use or inability to use this program.
  163.  
  164. The author is in no way obligated to provide future versions of this software.
  165.  
  166. Your use of the program constitutes your agreement to these terms and to this
  167. disclaimer.
  168.  
  169. All mentioned products are copyrighted by and trademarks of their respective
  170. holders.
  171.  
  172.  
  173. Credits
  174. -------
  175. Thanks to George Cedeno and James FitzGibbon for helping me beta test D-SoRt.
  176. And a very special thanks to James for his numerous suggestions and helpful
  177. criticism.
  178.  
  179.  
  180. Updates
  181. -------
  182. Please see the enclosed file DEADZONE.TXT for information on how to obtain the
  183. latest version of D-SoRt.
  184.  
  185.        
  186. Suggestions always welcome!
  187. ---------------------------
  188. If you have any suggestions for improvement or wish to  report any bugs, you can
  189. reach me via netmail:
  190.        
  191.        The DeAdZoNe
  192.        Victor Magdic
  193.        FidoNet: 1:259/427
  194.        TeleNet Canada: 20:22/104
  195.        
  196.        or by writing to:
  197.        
  198.        Victor Magdic
  199.        424 Camden Circle
  200.        Mississauga, Ontario
  201.        L4Z 2P4
  202.        CANADA
  203.        
  204. ------------------------------------------------------------------ end
  205.  
  206.