home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / comm / chkar102.lha / CheckAreas.DOC < prev   
Text File  |  1993-04-03  |  5KB  |  147 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.           #### #   # #####  #### #   #  ###  ####  #####  ###   ####
  7.          #     #   # #     #     # ##  #   # #   # #     #   # #
  8.          #     ##### ##### #     ##    ##### ####  ##### #####  ###
  9.          #     #   # #     #     # ##  #   # #  #  #     #   #     #
  10.           #### #   # #####  #### #   # #   # #   # ##### #   # ####
  11.  
  12.                        Documents for CheckAreas v1.02
  13.  
  14.  
  15.  
  16. 1.  What is CheckAreas and how do I use it?
  17. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. CheckAreas is a program that checks your file areas for several errors: 
  19.  
  20.   · Files that aren't the size that File.DAT says they are.  This is checked
  21.     for all files.  
  22.  
  23.   · Files that don't have the correct comment (filenote).  This is checked
  24.     for all files.  
  25.  
  26.   · Files that shouldn't be in a file directory.  (Skip the following unless
  27.     you're really interested...) 
  28.  
  29.     If there is no special search path defined for an area, the
  30.     FILE:<areanumber> directory is scanned and any file that isn't uploaded
  31.     in the area (shown in online file listings) are reported, unless the
  32.     file is either a .FD file description corresponding to a file in the
  33.     area or one of the special files (File.DAT, Pointers.File, User.File or
  34.     EnterArea.TXT).  
  35.  
  36.     When a special search path is defined, the FILE:<areanumber> directory
  37.     is scanned and any file that isn't either a .FD file description
  38.     corresponding to a file in the area or one of the special files
  39.     (File.DAT, Pointers.File, User.File or EnterArea.TXT).  Then, the
  40.     special search path is scanned, and any file that isn't uploaded in the
  41.     area (shown in online file listings) is reported.  
  42.  
  43.     If you set a global file search path (a path that can be used by ANY
  44.     area) to a FILE:<areanumber> directory or a special search path, you may
  45.     get lots of "false" reports.  This is because CheckAreas assumes that
  46.     only ONE area's files are present in those directories.  You can use
  47.     global file search paths that aren't equivalent to normal search paths
  48.     without problems.  
  49.  
  50.   · Files that are missing from a file directory.  CheckAreas knows what
  51.     directories to search, including global file search paths.  
  52.  
  53.   · Missing .FD files.  
  54.  
  55.   · Errors in Pointers.FILE (low pointer higher than lowest file number, high
  56.     pointer lower than highest file number, error reading it).  
  57.  
  58.   · .VAL files with no corresponding uploaded file (in validation areas).  
  59.  
  60.  
  61. CheckAreas takes two parameters: 
  62.  
  63. AREAS <area list>:  The areas that you want to list.  
  64.  
  65. VALAREAS <area list>:  Your validation areas.  In these areas, .VAL files
  66. won't be reported as extra files (unless there is no corresponding uploaded
  67. file).  
  68.  
  69. You can specify ranges of areas (xxx-yyy), and several areas/ranges (with
  70. spaces between them - then you need to quote the area list).  The areas you
  71. specify don't have to exist - but they will be included IF they exist, and
  72. all other areas will be skipped.  Examples: 
  73.  
  74.     CheckAreas AREAS 1 
  75.     CheckAreas AREAS "1 2 3 4 5" 
  76.     CheckAreas AREAS "1-5 120 318 20-48" VALAREAS 999 
  77.  
  78.  
  79. Everything is written to the standard output (the Shell window).  If you
  80. want to create a log file, you can redirect the output: 
  81.  
  82.     CheckAreas >Logs:CheckAreas.LOG [...] 
  83.  
  84.  
  85. CheckAreas will NOT report differences between file information in File.DAT
  86. and in the .FD files.  Those errors can easily be corrected by running
  87. "Freshen" regularly.  
  88.  
  89.  
  90. I hope this little tool will be helpful.  I certainly needed it - I found
  91. quite a few files that shouldn't have been in my file directories, and could
  92. delete a couple of megabytes of old versions of programs.  
  93.  
  94.  
  95.  
  96. 2.  Program history
  97. ~~~~~~~~~~~~~~~~~~~
  98.  
  99. 2.1.  CheckAreas 1.00, released 10-Mar-1993
  100. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  101. This is the first version of CheckAreas to be released.  
  102.  
  103.  
  104.  
  105. 2.2.  CheckAreas 1.01, released 20-Mar-1993
  106. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  107. CheckAreas would choke on areas that had a zero byte File.DAT.  Thanks to
  108. Per Salmi and Markus Hansson for reporting this.  
  109.  
  110.  
  111.  
  112. 2.3.  CheckAreas 1.02, released 3-Apr-1993
  113. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  114. CheckAreas no longer reports EnterArea.TXT files as "extra files".  Thanks
  115. to whoever reported this (sorry, I forgot your name).  
  116.  
  117. New keyword, VALAREAS <area list>:  Your validation areas.  In these areas,
  118. .VAL files won't be reported as extra files (unless there is no
  119. corresponding uploaded file).  
  120.  
  121. I forgot to add the documents to the previous release.  Sorry :) 
  122.  
  123.  
  124.  
  125. 3.  Contacting the author
  126. ~~~~~~~~~~~~~~~~~~~~~~~~~
  127. You can reach me in several ways: 
  128.  
  129.   · By leaving a message on my BBS, Remote Control, +46-13-138113.  
  130.  
  131.   · By writing netmail to Jonas Kvarnstrom, 2:204/418.0@FidoNet.  
  132.  
  133.   · By writing e-mail to jk@augs.se.  
  134.  
  135.   · By writing a message in DLG_CHAT.  
  136.  
  137.   · By snailmail to Jonas Kvarnström, Gustav Adolfsgatan 2, 
  138.     582 20 Linköping, Sweden.  
  139.  
  140. ALL suggestions (and donations :-)) are welcome! 
  141.  
  142.  
  143.     __
  144.  __///
  145.  \XX/  Freeware - © 1993 Jonas Kvarnström.
  146.  
  147.