home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / 175B220U.ZIP / B2FV22.ZIP / BBS2FMS.DOC < prev    next >
Encoding:
Text File  |  1994-07-31  |  13.8 KB  |  295 lines
  1.  
  2.                      BBS2FMS v2.2 - (c) 1994 by Richie Molinelli
  3.                          FILES.BBS (*.DIR) to FMS converter
  4.  
  5.  
  6. History
  7.  
  8.    v1.0 - 02/26/94 - not released
  9.    v2.1 - 02/27/94 - beta - limited release
  10.    v2.2 - 02/31/94 - public release
  11.  
  12. PACKING LIST:
  13.  
  14. The B2FV22.ZIP archive should contain the following:
  15.  
  16. BBS2FMS.DOC - This document
  17. BBS2FMS.EXE - The 286 program .EXE
  18. BBS2FMS.088 - The 8088 program .EXE
  19. DESC.SDI    - Description file for this archive
  20. FILE_ID.DIZ - Description file for this archive
  21. SAMPLE.CFG  - Sample configuration file
  22.  
  23. BBS2FMS is distributed in .ZIP format and should contain ONLY the above
  24. six files.
  25.  
  26. If this archive has been repackaged, it should contain ONLY the above
  27. six files.  If any other files are contained, you should obtain the archive
  28. from another source.
  29.  
  30.  
  31. WHAT IS BBS2FMS?
  32.  
  33. BBS2FMS is a program to convert FILES.BBS and/or old style RBBS *.DIR file
  34. listing files to RBBS FMS format with category codes.  It has the capability
  35. of processing single files as well as running in "batch" mode to process a
  36. list of files.  It can create a master FMS file from all the individual
  37. input files when running in batch mode.  It accepts extended descriptions
  38. written in both forward and reverse order.  It will honor the "Uploaded by:"
  39. mod for RBBS.  It will wrap lines which exceed the desired description length
  40. (that which is contained in RBBS CONFIG parameter #219).  Additionally it can
  41. create an unordered, unsorted list of files which can be sorted and used for
  42. running macros.
  43.  
  44.  
  45. WHAT CAN BBS2FMS BE USED FOR?
  46.  
  47. It's best uses are for converting old style RBBS *.DIR listings to the newer
  48. and maintanence free FMS listings and taking all the FILES.BBS type files on
  49. a CD-ROM and creating a master FMS listing for use with RBBS.
  50.  
  51.  
  52. WHAT IS REQUIRED TO RUN BBS2FMS?
  53.  
  54. Welp, a computer helps.  Seriously, the only thing BBS2FMS requires is that
  55. the input file(s) for processing contain the basic four pieces of data that
  56. RBBS wants:  the file name, size, date and short description.  BBS2FMS will
  57. attempt to get around a missing size by substituting the size "1024" and will
  58. attempt to get around missing date(s) by substituting the date "01/01/80".
  59. It may/will have problems if both the size and date of a particular file are
  60. missing.  It is advised to use either CONFIG or a utility like FMSCHK (by
  61. Bob Hampton) to check the newly created FMS file(s) for errors when processing
  62. is complete.
  63.  
  64.  
  65. HOW DO YOU RUN IT?
  66.  
  67. Single file:
  68.  
  69. Ahhhh....  The meat of the document.  BBS2FMS can be run two different
  70. ways.  The first of these is from the command line.  BBS2FMS can process an
  71. individual *.BBS file (*.DIR) file direct from the command line without
  72. having to set up a configuration file.  The syntax of the command is:
  73.  
  74. BBS2FMS /<input file> /<desc size> /<cat code> /R /F
  75.  
  76. where:
  77.  
  78.    /<input file> - the name of the file to process - a *.BBS, *.DIR or
  79.                    similiar files.
  80.  
  81.    /<desc size>  - the description field size from RBBS CONFIG parameter #219
  82.  
  83.    /<cat code>   - the three character category code you want for this listing
  84.  
  85.    /R            - this is an optional switch and can be omitted.  This
  86.                    indicates the input file is an RBBS *.DIR file with
  87.                    extended descriptions in reverse format (see figure 2 below)
  88.  
  89.    /F            - this is an optional switch and can be omitted.  This tells
  90.                    BBS2FMS to write out the new FMS type file in reverse
  91.                    format (see figure 2 below).  This is great if you have a
  92.                    *.BBS (*.DIR) that has extended descriptions in forward
  93.                    order (see figure 1 below) and need them in reverse order.
  94.  
  95. Either or both of the optional switches (including their delimiters - "/")
  96. can be omitted or included.  The description field size must be what you have
  97. entered in RBBS CONFIG parameter #219.  If you attempt to exceed 46 characters
  98. or less than 1 character, BBS2FMS will complain and exit.  Your category code
  99. must be three characters in length.  If you exceed or input less than 3
  100. characters, BBS2FMS will complain and exit.  BBS2FMS will attempt to determine
  101. if your input file has the extended descriptions in reverse order.  If the
  102. first file listed in your *.DIR (or *.BBS) file does not have an extended
  103. description and the remainder have extended descriptions in reverse order
  104. (see figure 1 and 2 below) then you must use the "/R" switch.
  105.  
  106. The "/F" switch is great for taking a forward ordered listing and reversing
  107. it.  Such listings are written out by the MUTIL.EXE program on the monthly
  108. ASP disks.
  109.  
  110.  
  111. *** Figure 1.  (Extended Descriptions in forward format)
  112.  
  113. APR150.ZIP     410633  10-01-93  APROPOS FOR DOS 1.50 CONTACT MANAGER <ASP>     
  114.   APROPOS is a powerful, yet easy-to-use package designed to help business      
  115.   people manage their contacts and related activities. This convenient          
  116.   database program also offers robust reporting and archiving facilities.        
  117.   <ASP> Registration is only $49.95US.                                           
  118. APTENV.ZIP      59019  05-16-94  Print envelopes w/POSTNET codes & bulk mail   
  119.   <ASP> Print envelopes and labels with POSTNET codes on any HP compatible       
  120.   laser printer or Epson compatible dot matrix printer. Does bulk mailing and    
  121.   prints zip code statistics for easy bundling. Supports multiple address        
  122.   databases.                                                                     
  123.  
  124.  
  125. *** Figure 2.  (Extended Descriptions in reverse format)
  126.  
  127.   <ASP> Registration is only $49.95US.                                           
  128.   database program also offers robust reporting and archiving facilities.        
  129.   people manage their contacts and related activities. This convenient           
  130.   APROPOS is a powerful, yet easy-to-use package designed to help business       
  131. APR150.ZIP     410633  10-01-93  APROPOS FOR DOS 1.50 CONTACT MANAGER <ASP>    
  132.   databases.                                                                     
  133.   prints zip code statistics for easy bundling. Supports multiple address        
  134.   laser printer or Epson compatible dot matrix printer. Does bulk mailing and    
  135.   <ASP> Print envelopes and labels with POSTNET codes on any HP compatible       
  136. APTENV.ZIP      59019  05-16-94  Print envelopes w/POSTNET codes & bulk mail   
  137.  
  138.  
  139. Batch mode (multiple input files):
  140.  
  141. BBS2FMS can also be run in batch mode for processing more than one file at
  142. a time.  To do this you set up a configuration file.   There are two different
  143. ways to get BBS2FMS to run in batch mode.  The first is to create a
  144. configuration file named BBS2FMS.CFG in the same directory as the executable.
  145. You then run BBS2FMS with no command line.  BBS2FMS defaults to looking for
  146. the configuration file named BBS2FMS.CFG when no parameters are passed to it.
  147. If it does not find the configuration file, it will display a help screen.
  148. Optionally you can pass the name of the configuration file to BBS2FMS.  The
  149. configuration file can be any name with the extension ".CFG".  BBS2FMS would
  150. then be run with the following syntax:
  151.  
  152.                  BBS2FMS /<configuration file name>
  153.  
  154. BBS2FMS will check to see if the configuration file exists and will load it
  155. if found.  If it is not found, BBS2FMS will look for the default configuration
  156. file before exiting and, if found, run that.  With the ability to pass the
  157. configuration file name to BBS2FMS, you can run it multiple times with
  158. different sets of *.BBS (or *.DIR) files for multiple CD-ROM disks, etc..
  159. in batch files while you go take a snooze.  BUT...  Believe me, BBS2FMS is
  160. pretty fast.
  161.  
  162. What does the configuration file contain?  The following is a sample file:
  163.  
  164.  
  165. R                ; "R" if extended descriptions are in reverse order
  166. n                ; "Y" if you want to run in quiet mode - no bell
  167. 46               ; description field size - from CONFIG param #219
  168. F                ; "F" to Force writing extended descriptions in reverse order
  169. y                ; "Y" creates one master FMS listing from the input files
  170. ALLFILES.NEW     ; The name of the master FMS file if "Y" above
  171. y                ; "Y" to delete individual files when done
  172. Y                ; "Y" to create a filename only listing for use with macros
  173. FIDX.NEW         ; The name of the unsorted file list if "Y" above
  174. y                ; "Y" if you want to write activity to a log file
  175. ASP_ILES.BBS,001 ; All the remaining lines are the names of the individual
  176. BUSINESS.BBS,002 ;   files with their corresponding category codes.
  177. COLLTING.BBS,003 ;   Any text after the ";" delimiter is ignored
  178. COMMIONS.BBS,004 ;
  179. DATAIONS.BBS,005
  180.  
  181.  
  182. In the above example the lines contain the following:
  183.  
  184. Line 1:  You place an "R" here if the input files have extended descriptions
  185.          written in reverse order (see figure 2 above).  Blank or any other
  186.          character indicates the input files are not in reverse order.
  187.  
  188. Line 2:  "Y" if you want to run in quiet mode.  Turns bell off on errors.
  189.  
  190. Line 3:  The description field size taken from RBBS CONFIG parameter #219.
  191.          Must be from 1 to 46 inclusive or BBS2FMS will complain and exit.
  192.  
  193. Line 4:  An "F" here "Forces" BBS2FMS to write out the processed file in
  194.          reverse order (see figure 2 above) while the input file has
  195.          extended descriptions in forward order (see figure 1 above).
  196.          Leaving blank or any other character will tell BBS2FMS not to
  197.          write a reverse order listing when the input listing is in forward
  198.          order.
  199.  
  200. Line 5:  A "Y" here indicates that BBS2FMS create a master FMS file
  201.          where all the input files are combined for one main listing.
  202.          The name of this master FMS file is taken from line 5 below or will
  203.          default to ALLFILES.NEW.  Leaving blank or any other character 
  204.          will tell BBS2FMS not to write the master FMS listing.
  205.  
  206. Line 6:  If you put a "Y" on line 4, then this is the name of the master
  207.          FMS file.  If you have a "Y" on line 4 and leave this line blank
  208.          then BBS2FMS will default to using the name ALLFILES.NEW.  This
  209.          line is ignored if you are not creating a master FMS file.
  210.  
  211. Line 7:  If creating one master FMS listing a "Y" here will indicate to
  212.          BBS2FMS to delete all the individual processed files when completed.  
  213.          Your original input files will remain.  Leave blank or any other
  214.          character to retain the files.
  215.  
  216. Line 8:  A "Y" here indicates to BBS2FMS to create and unsorted file listing
  217.          file.  Each line in this file contains a file name and nothing else.
  218.          This file can be sorted and used for macros, etc..  Blank or any
  219.          other characters will prevent BBS2FMS from writing this file.
  220.  
  221. Line 9:  If you put a "Y" on line 7 to create an unsorted file listing, this
  222.          is the name of the file listing file.  If you have a "Y" on line 7  
  223.          and leave this line blank then BBS2FMS will default to using the
  224.          name FIDX.NEW.  This line is ignored if you are not creating a file
  225.          listing file.
  226.  
  227. Line 10: "Y" if you want BBS2FMS to create and write to a log file.  Great
  228.          for trouble shooting.
  229.  
  230. Line 11 and up:  From here on, each succeeding line contains the name of a
  231.          *.BBS (or *.DIR) file and the corresponding category code for that
  232.          file.  The two parameters are separated by a comma.  BBS2FMS will
  233.          read in the files listed here and process them.
  234.  
  235. The ";" delimeter allows you to comment the file.  Anything after a ";"
  236. will be ignored by BBS2FMS.  Great for referencing.  See the sample
  237. SAMPLE.CFG file contained within this archive.
  238.  
  239.  
  240. HOW DO I SET UP TO USE BBS2FMS?
  241.  
  242. Easy.  Create a work directory.  Copy BBS2FMS.EXE (286 on up version - the
  243. 8088 version is named BBS2FMS.088 and must be renamed to BBS2FMS.EXE) into
  244. this directory.  Running BBS2FMS without any parameters and without a
  245. BBS2FMS.CFG file present will display the syntax for processing one file.
  246. Copy all the files you want to process into this directory.  If more than one
  247. file is going to be processed for the listing, create a .CFG file and, using
  248. the directions above, go to town.
  249.  
  250.  
  251. OUTPUT FILES?
  252.  
  253. All output files have the same name as the input files but with the extension
  254. ".NEW".  The default master FMS listing (if created) will be named 
  255. ALLFILES.NEW if no name is specified in the configuration file.  The default
  256. unsorted list of files (if created) will be named FIDX.NEW if no name is
  257. specified in the configuration file.
  258.  
  259. BBS2FMS will also create a log file of activity named BBS2FMS.LOG if instructed
  260. to do so and will create an error file named BBS2FMS.ERR if an error occurs.
  261.  
  262.  
  263. Now the GOOD stuff:
  264.  
  265. WARRANTY?
  266.  
  267. Ya gotta be kidding.  Not fit for any purpose other than to take up room on
  268. your hard drive.  It works for me......hopefully for you.
  269.  
  270.  
  271. REGISTRATION?
  272.  
  273. Welp, BBS2FMS represents many hours of programming and debugging.  It is not
  274. crippled in any manner.  You are free to use it.  If you use it and are
  275. satisified and want to encourage me to further this program (like eventually
  276. searching the CD itself for the FILES.BBS files and processing them, creating
  277. the FIDX and LIDX files, creating DIR.CAT and/or DIR.DIR files, etc), then 
  278. donations to my BBS are accepted.  So are postcards.  And registered versions 
  279. of programs you wrote.  You can send any of the above to the following 
  280. address:
  281.  
  282.                         Richie Molinelli
  283.                         P.O. Box 961
  284.                         Levittown, NY  11756
  285.  
  286. You can net mail bug reports and/or suggestions to the following:
  287.  
  288. Fido:     1:107/272 and 1:107/273         BBS:  The Small Time BBS
  289. RBBSNet:  8:954/272                             516-579-7929
  290. Busilink: 10:110/3                              Runnin' RBBS/Busimod v17.4a
  291.                                                 1200 thru 14400bps
  292.  
  293.  
  294.  
  295.