home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / CDOR0811.ZIP / DOCS.ZIP / FMSFFS.DOC < prev    next >
Encoding:
Text File  |  1993-08-08  |  15.7 KB  |  356 lines
  1. FMSFFS RBBS FMS/FFS utility for RBBS
  2. Version 2.0 BETA
  3. Copyright (c) 1993 Daniel T. Drinnon
  4. Contact The Cellar Door (505) 763-1795
  5.  
  6. Note: this is a BETA production!  Use it at your own risk!  It's used
  7. nightly on the Cellar Door, but that's no guarantee - it's one way of
  8. finding unsuspected bugs!  Remember that this program is not finished
  9. and may not handle your specific FMS structure.  This program is released
  10. as is for your use as there are no other RBBS FMS utilities to handle the
  11. Cellar Door (CDor) mods to RBBS's FMS structure.
  12.  
  13. I still have a few more things to do to this program, mainly speed it up a
  14. little as it actually runs a little slower than the BASIC version when it
  15. is building the MASTER.DIR files.  However, it does fix the OVERFLOW problems
  16. that the BASIC version had before.
  17.  
  18.  
  19. Purpose:  The FMSFFS is used to handle your CDor modified MASTER.DIR file.
  20. You only need to use it for FMS maintenance when using the Times Downloaded mod.
  21. Otherwise, I highly recommend that you use RFM until this program is further
  22. developed.  FMSFFS can also be used on Stock non-cdor, non-rfm type fms/ffs
  23. systems as well.
  24.  
  25.  
  26. Useage:  FMSFFS [configname]
  27. If no config name is used, then the default is FMSFFS.CFG
  28.  
  29. Using the first time:  Try putting FMSFFS.EXE, FMSFFS.CFG and your FMS 
  30. MASTER.DIR file in a separate subdirectory.  Edit the FMSFFS.CFG file to reflect 
  31. your DOWNLOAD directories and FMS description length and run it, making sure 
  32. QSORT is in your path.  When done, compare the MASTER.DIR file with it's 
  33. original file which would be MASTER.BAK.  If they are the same or nearly the 
  34. same, then it worked.  If you are using the Times Downloaded mod, then after you 
  35. have added the 5 character field to the MASTER.DIR file (using ADDTIMES), edit 
  36. the FMSFFS.CFG file's FMSExtra parameter and run again.  Hopefully it all went 
  37. well.  There is no processing error checking installed yet for programming 
  38. purposes.  If you get an OVERFLOW error then chances are the description lengths 
  39. in the FMS don't match what you put in the config file.
  40.  
  41.  
  42. The FMSFFS.CFG file:  Rather than get too extensive twice, I will go by each
  43. parameter available in the FMSFFS.CFG file and what to do with them.  The order
  44. of things in the FMSFFS.CFG file do not matter, and many options have built in
  45. defaults.  All options are listed in the config file to help me with the
  46. creation of the program.
  47.  
  48.  
  49. FILE_ID.DIZ Support:  Currently, the 2.0 version of FMSFFS will only look in
  50. .ZIP files for FILE_ID.DIZ files.  The search routine is all internal and is
  51. alot faster than the version 1.0.
  52.  
  53. Starting from scratch - You can build an all new MASTER.DIR file!  FMSFFS will
  54. create a MASTER.DIR file if none exists before and will put <Description not
  55. available> in for the description.  To use the FILE_ID.DIZ for the description,
  56. you must run FMSFFS 2 times!  The first time will build the one line per file
  57. MASTER.DIR, then after you uncomment the FILEID in FMSFFS.CFG, FMSFFS will then
  58. insert descriptions for every file listed in MASTER.DIR that has a FILE_ID file.
  59.  
  60. Please go through your config file and make the appropriate changes!  Remember
  61. to test this program on a backup the first time.  If it messes up, try it again.
  62.  
  63.  
  64. The FMSFFS.CFG config file:
  65.  
  66. ; Configuration file for FMSFFS, version 2.0b
  67. ; Copyright (c) 1993 Daniel T.Drinnon
  68. ; Lines beginning with ';', '-' or "*" are interpreted as comments and are
  69. ; ignored
  70. ; Lines which are BLANK are ignored
  71. ;
  72. *==============================================================================
  73. ; RegName and RegNum should only be used with Registered Copies!
  74. ; DEFAULT: UnRegistered
  75. ;
  76. RegName        Dan Drinnon
  77. RegNum         32382
  78. *==============================================================================
  79. ; WorkDir is the path and directory for all work files
  80. ; DEFAULT: Current DOS directory  ** NOT ENABLED YET **
  81. ;
  82. WorkDir        C:\TEMP
  83. *==============================================================================
  84. ; UseEMS will allow EMS to be used when shelling
  85. ; DEFAULT: Use EMS and/or XMS
  86. ;
  87. UseEMS
  88. *==============================================================================
  89. ; UseXMS will allow XMS to be used when shelling (UseXMS will override UseEMS)
  90. ; DEFAULT: Use EMS and/or XMS
  91. ;
  92. ;UseXMS
  93. *==============================================================================
  94. ; NoSwap will keep FMSFFS from swapping itself to disk or memory when shelling
  95. ; DEFAULT: Swap to EMS and/or XMS
  96. ;
  97. ;NoSwap
  98. *==============================================================================
  99. ; Sorter is the name of the SORT program to use
  100. ; DEFAULT: QSORT
  101. ;
  102. Sorter          QSORT
  103. *==============================================================================
  104. ; DateSort is the command line to send to Sorter to do a FMS date sort
  105. ;
  106. DateSort       /30:2 /24:5 /-1
  107. *==============================================================================
  108. ; Interactive will prompt for information when needed.  Note!  If interactive
  109. ; is on FMSFFS will stop until you enter the information it needs!
  110. ;  ** NOT ENABLED YET **
  111. ;
  112. Interactive
  113. *==============================================================================
  114. ; NoNoise turns off activity noise
  115. ;
  116. ;NoNoise
  117. *==============================================================================
  118. ; RestoreScreen will replace the screen that was in place before FMSFFS began
  119. ;
  120. ;RestoreScreen
  121. *==============================================================================
  122. ; NameFile is the name of the list of files
  123. ;
  124. NameFile       FIDX.DEF
  125. *==============================================================================
  126. ; LocationFile is the name of the list of locations for files
  127. ;
  128. LocationFile   LIDX.DEF
  129. *==============================================================================
  130. ; TabFile should be the prefix of your NameFile + "T.DEF"
  131. ;
  132. TabFile        FIDXT.DEF
  133. *==============================================================================
  134. ; BulletinFile is the name of the Bulletin file to create to display files
  135. ; which will be deleted after given number of days.  Note: ONLY ONE Bulletin
  136. ; file is created!  It will use CDor 16 color SmartText color commands.
  137. ;
  138. BulletinFile   BFILES    10
  139. *==============================================================================
  140. ; MakeRFM will create an RFM style NameFile (use only if your RBBS has been
  141. ; modifed for RFM type FIDX files).
  142. ;
  143. MakeRFM
  144. *==============================================================================
  145. ; list as many as you have (DOS) directories where you want
  146. ; all the files in them listed.  /S searches 1 (one) subdirectory
  147. ; below the current subdirectory.
  148. ; If you are using RFM style FIDX files, then you may also enter the
  149. ; subdirectory to move files which have not been downloaded or viewed
  150. ; after the number of days specified
  151. ;
  152. ;
  153. FileSpec       C:\RBBS\UPLOAD\*.* 30 C:\RBBS\DOWNLOAD
  154. FileSpec       C:\RBBS\DOWNLOAD\*.* /S
  155. FileSpec       D:\RBBS\DOWNLOAD\*.* /S
  156. ;
  157. ; In the above, files that have been in the C:\RBBS\UPLOAD subdirectory will
  158. ; be automatically moved to C:\RBBS\DOWNLOAD after 30 days.  The BFILES
  159. ; bulletin will list the files which will be moved starting 10 days before
  160. ; the actual date the files will be moved.
  161. ;
  162. *==============================================================================
  163. ; If you are using macros in your FMS, such as "Directory of M! FILES.DEF" you
  164. ; must tell FMSFFS what to look for:
  165. ;
  166. ;
  167. DirString     Directory of
  168. *==============================================================================
  169. ; List as many as you have of text files with file names in
  170. ; them.  The file name must be at the beginning of each line.
  171. ; The first line of any FileDir path must consist of the DirString string.
  172. ;
  173. ;FileDir        C:\RBBS\DIR\HACKS.DEF
  174. ;FileDir        C:\RBBS\DIR\UNWANT.DEF
  175. ;FileDir        C:\RBBS\DIR\PIRATES.DEF
  176. *==============================================================================
  177. ; FMS.DIR Maintenance  -  NOTE: If FMSFile is not ENABLED, none of
  178. ;                               the FMS maintenance features will
  179. ;                               be active either!
  180. *==============================================================================
  181. ; FMSFile is the name of your main FMS file list -Turns ON ALL FMS Maintenance!
  182. ;
  183. FMSFile        MASTER.DIR
  184. *==============================================================================
  185. ; FMSFormat     blank = Date Sorted, TOP, NOSORT = not Date Sorted
  186. ; ** NOTE - use blank, any other FMSFormat can be placed in the first line
  187. ;           of your MASTER.DIR file instead of here - there are problems
  188. ;           when using FMSFormat NOSORT as shown below! **
  189. ;
  190. ;
  191. FMSFormat
  192. ;FMSFormat     NOSORT
  193. *==============================================================================
  194. ; FMSAlpha is the name of an alphabetically sorted list from FMSFile
  195. ; ** NOTE - Specifying an ALPHA file listing will decrease the operational
  196. ;           speed of FMSFFS due to the fact that it is creating an extra
  197. ;           output file **
  198. ;
  199. ;
  200. ;FMSAlpha       ALPHA.DIR
  201. *==============================================================================
  202. ; FMSAlphaHeader is the RBBS \FMS style header you want at the top of ALPHA.DIR
  203. ; DEFAULT: none
  204. ;
  205. ;FMSAlphaHeader \FMS TOP NOSORT
  206. *==============================================================================
  207. ; FMSDate no parmaters will use the current FMS file date.  Use "." to use
  208. ; actual file date.  Any files which have an illegal DOS date, such as
  209. ; 01-30-60 or any files which have a DOS date greater than the current date
  210. ; will use the MASTER.DIR date or the current date, depending on what is
  211. ; set in FMSDate.  If you use the ".", then these dates will be set to the
  212. ; current date.
  213. ;
  214. FMSDate
  215. ;FMSDate       .
  216. *==============================================================================
  217. ; DateSeparator is the character to use between the number is the date field
  218. ;
  219. ;DateSeparator  -
  220. *==============================================================================
  221. ; FMSMissing will substitute a string you specify for missing files
  222. ;
  223. ; ** NOT COMPLETLY TESTED **
  224. ;
  225. ;FMSMissing     Offline
  226. *==============================================================================
  227. ; UnknownDesc is the description given for unknown files
  228. ;
  229. UnKnownDesc    <description unavailable>
  230. *==============================================================================
  231. ; FILEID  will look for FILE_ID.DIZ in all files and import to the
  232. ; extended description
  233. ;
  234. ;FILEID         FILE_ID.DIZ
  235. *==============================================================================
  236. ; FileIdMainDesc is the main description given to files with a FILE_ID.DIZ
  237. ; If you enable FILEID or FileIdMainDesc, then FMSFFS will look for FILE_ID
  238. ; files.  If you enable FileIdMainDesc, then whatever the string is for this
  239. ; option will be used for the main description.  If it is disabled, then the
  240. ; FIRST line of the FILE_ID.DIZ file will be the main description and the
  241. ; remaining lines will be placed in the extended description.
  242. ;
  243. ;
  244. ;FileIdMainDesc     Description within Archived File:
  245. *==============================================================================
  246. ; FMSCat is the default category assigned to any files added to FMSFile
  247. ;
  248. FMSCat         999
  249. *==============================================================================
  250. ; FMSDescLen is the length of the description as set in RBBS's CONFIG
  251. ;
  252. FMSDescLen     46
  253. *==============================================================================
  254. ; FMSExtra is any extra characters in FMSFile between the description
  255. ; and the category code.  The Cellar Door mods can keep the number of
  256. ; times a file has been downloaded in this area with 5 characters - leave
  257. ; this a 5 if you are using the Times Downloaded Cdor mod!
  258. ;
  259. FMSExtra       5
  260. *==============================================================================
  261. ; FMSCatLen is the length of the category code in the FMSFile.  Leave at
  262. ; 3!
  263. ;
  264. FMSCatLen      3
  265. *==============================================================================
  266. ; ZIPCommand is the command to unzip files from a ZIP file
  267. ;
  268. ZIPCommand     PKUNZIP
  269. *==============================================================================
  270. ; ARCCommand is the command to unarc files from an ARC file
  271. ; ** Not Installed! **
  272. ;
  273. ;ARCCommand     PKXARC
  274. *==============================================================================
  275. ; LZHCommand is the command to unlzh files from an LZH file
  276. ; ** Not Installed! **
  277. ;
  278. ;LZHCommand     LHARC e
  279. *==============================================================================
  280. ; ARJCommand is the command to unarj files from an ARJ file
  281. ; ** Not Installed! **
  282. ;
  283. ;ARJCommand     ARJ e
  284. ;
  285. ;[end of config file]
  286.  
  287. ===============================================================================
  288. NOTES:  The FILE_ID, and FileIdMainDesc will decrease the speed tremendously 
  289.   because FMSFFS has to check each file in your MASTER.DIR file for these files.  
  290.   Normally, you should only use this option once.  Note that if a file aready 
  291.   has an extended description, then NO ATTEMPT will be made to search for a 
  292.   FILE_ID file for that particular file!
  293.  
  294.   Chained FMS files are supported!
  295.  
  296.   ALWAYS use a disk cache!  This will greatly help the speed.  The WorkDir
  297.   option is not enabled yet, but will soon be...
  298.  
  299.   When FMSFFS runs, it creates .BAK files of the FIDX.DEF, FIDXT.DEF, LIDX.DEF,
  300.   MASTER.DIR and ALPHA.DIR files.  If you need to STOP FMSFFS, simply press
  301.   CTRL-C or CTRL-BREAK!  You will asked to verify to quit, and if you hit enter
  302.   or Y then FMSFFS will restore the original *.DEF files and MASTER.DIR file
  303.   and clean up any work files it may have created.
  304.  
  305. * REMEMBER to always test things out first.  Run this program over your MASTER
  306. * DIR file many times.  On my 386-40 with smartdrv it takes just over 2 minutes
  307. * to process 2500 files with 120 extended descriptions.
  308.  
  309.   More on DATES:  It is not an option that a file that gets updated physically
  310.   will get a new date in the MASTER.DIR file.
  311.  
  312.   Scanning Directories:  When using the /S option with  the FileSpec line,
  313.   subdirectories are only searched one subdirectory below the subdirectory
  314.   specified.  For example:
  315.  
  316.   FileSpec C:\RBBS\DOWNLOAD\*.* /S
  317.  
  318.   IF the following subdirectories are below C:\RBBS\DOWNLOAD:
  319.  
  320.            C:\RBBS\DOWNLOAD
  321.            C:\RBBS\DOWNLOAD\H
  322.            C:\RBBS\DOWNLOAD\R
  323.            C:\RBBS\DOWNLOAD\R\W
  324.  
  325.   the subdirectory C:\RBBS\DOWNLOAD\R\W will NOT be scanned.
  326.  
  327.   Future revisions will scan all the way to the end...
  328.  
  329.   THE FMSFile parameter TURNS ON ALL FMS Maintenance.  If it is commented out,
  330.   then only the FIDX.DEF, LIDX.DEF and FIDXT.DEF files are made.
  331.  
  332.   SPEED TIP:  Anytime the FIDX.DEF is changed from non-RFM to RFM style, speed
  333.   will greatly decrease.
  334.  
  335.  
  336.   The FMSFFS program relies a LOT on specially sorted lists as it runs.  It
  337.   Makes 3 other temporary files which get deleted when completed.  These are:
  338.    MASTER.SRT - special sorted file
  339.    MASTER.WRK - copy of original MASTER.DIR work file with extended line info
  340.    MASTER.EXT - stored extended descriptions file
  341.  
  342. History:
  343. 0619 - * Initial BETA release
  344. 0626 - * Fix for extended descriptions with same dates in a date ordered
  345.          FMS but NOT in alpha order as secondary sort causing problems.
  346.        * Fix for FMSDate "." option
  347. 0710 - * some fixes for creating final master.dir file with no ext. desc.
  348. 0731 - * Beta release of version 2 Beta
  349. 0801 - * fix for alpha.dir header and format output
  350.        * fix for \FMS lines
  351.        * fix for entries in FMS.DIR not online trashing FMS.DIR
  352.        * enabled FMSMissing Option
  353. 0802 - * fix for rfm type fidx file going skewed with unlisted files
  354. 0808 - * fix for invalid DOS filedates when using FMSDate .
  355.  
  356.