home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / CDCOM.ZIP / MAKEXRF.DOC < prev    next >
Text File  |  1991-10-14  |  30KB  |  711 lines
  1.  
  2. MAKEXRF - Ver 1.1
  3. Description Conversion and other CdCom work files conversion program.
  4.  
  5. This version of makexrf and cdcom represent my first step in creating
  6. a cdrom door program that can be configured to work with any shareware
  7. type of cdrom disk except pc-sig.  It is not by any means foolproof.  I
  8. have tested it to the best of my ability, but since I do not possess
  9. most of the cdrom disks listed in this doc file I cannot test it
  10. with all configurations.  However based on the information I already
  11. had on most of these disks it should work just fine.  There may still
  12. be some bugs in the program, so feel free to contact me so we can work
  13. them out.
  14.  
  15. Makexrf's main function is to create the cross-reference file (cdcom.xrf)
  16. that contains all the files on the cdrom disk, so that searching for
  17. a filename takes milli-seconds instead of minutes to find.  However
  18. some disks will need to have a master description file created from
  19. the available listings.  This can be created using makexrf also.
  20.  
  21. Makexrf has been written so that it can easily adapt to most shareware
  22. collection types of cdrom disks, except for the pc-sig disks.  These
  23. need to be handled differently.  You should be able to get most any
  24. disk to work with makexrf & cdcom by following the steps covered here.
  25. The hardest part is getting the description filelists into a format
  26. that makexrf/cdcom can use.  Most of the time this is not a problem
  27. as long as some common sense was used when making these listings.
  28. Pretty much any files.bbs or DIR# files can be converted quite easily
  29. by makexrf for use with cdcom.  I am not familiar with all the file
  30. category description listings in use by all the bbs packages, but most
  31. follow a certain convention so there should be little difficulty
  32. in getting this door to work with your cdrom disk.
  33.  
  34. The sorts that makexrf will have to do take up quite a bit of memory.
  35. It is advised that you free up as much memory as possible before
  36. running makexrf.  If makexrf does run out of memory, it will error
  37. out with an error 7.  If so, try to free up some more memory and
  38. attempt to resume the sort.  I added command line options to allow
  39. you to do so without having to start from the beginning.  It will
  40. usually bomb when it says "Reading FILENAME.EXT" (ex: Reading
  41. cdcom.xrf or Reading filename.cat) if it is having memory problems.
  42. In this case try to get more memory and restart it using one of the
  43. command line parameters listed below.
  44.  
  45. Included in this zip is a file called RVMX, which will use EGA or VGA
  46. memory starting at A000h as extra memory for DOS.  I was able to
  47. get 736k total of dos memory with it, which gave me enough to do the
  48. sorts without removing my cdrom drivers.  This will disable EGA graphics
  49. however, so if you will be running any programs that use EGA graphics
  50. mode then disable RVMX.  There are also files that can convert expanded
  51. memory to extra memory for dos, but you have to be able to map to
  52. A000h.  Neither the cdrom door nor wildcat use ega graphics so it should
  53. be safe to run this program while your bbs is up.  Between this program
  54. and dos 5.0 allowing to load dos high (on 286's and above) hopefully
  55. this will be enough memory to do these sorts.  I am hoping the next
  56. version of the compiler I use will allow me to use expanded memory for
  57. arrays, which most of you have plenty of, so this will not be a problem
  58. anymore.
  59.  
  60. The cdrom drivers can be removed to do the sorts on either the description
  61. file or the cdcom.xrf file.  They must only be present on the initial
  62. filename index creation, or if you are going to be copying files off the
  63. cdrom.
  64.  
  65. Running MAKEXRF
  66. ---------------
  67.  
  68. Makexrf will accept the following command line parameters:
  69.  
  70. SORT    - Sort CDCOM.XRF (or resume after memory problem sorting cdcom.xrf)
  71. CONVERT - Convert Description Listings for CdCom
  72. REPORT  - Updates CDCOM.XRF With File Description Pointers
  73.           and Reports Missing Files
  74. PTR     - Creates Pointer File for Description File
  75. HELP (?)- Command Line Parameter Help Screen
  76. DSORT   - Sort Description File (or resume after memory problem during
  77.           CONVERT)
  78. DRIVE:  - Cdrom Drive Letter [D:, E:, F:, etc] for making cdcom.xrf
  79.  
  80. If you run MAKEXRF CONVERT, the DSORT and PTR functions are
  81. done automatically (and in that order).  When you run MAKEXRF DRIVE:,
  82. the SORT and REPORT functions are done automatically (and in that order).
  83. On any error resume functions (SORT, DSORT) the other steps after that
  84. are also performed.  For the REPORT function makexrf must have access to
  85. the description file.  Makexrf will also need the makexrf.dat file once
  86. it is created in order to do some of these functions.
  87.  
  88. 1) Determine whether or not you need to have a description file created
  89. or not.  If so, you will need to create a proper makexrf.cfg so that
  90. makexrf can create this listing.  Included in this zip is CFGFILES.ZIP that
  91. has configuration files for the cdrom disks I have come into contact
  92. with.  See the section below on this topic.  If you do in fact have to
  93. run makexrf convert, then when this step is done makexrf will create a
  94. file called makexrf.dat that contains the description line length.  Insure
  95. that this value is the same as what is on line 15 of cdcom.def.  Save this
  96. file in same directory as makexrf as it does need it for other functions.
  97. If you lose it you can always make a new one, just by inserting the
  98. number that is on cdcom.def line 15.
  99.  
  100. 2) Once the description file has been converted or dealt with, then
  101. you need to create the file index (cdcom.xrf) for the door.  This is
  102. done by running
  103.  
  104. makexrf drive:
  105.  
  106. where drive: is your cdrom drive letter (ex: makexrf e:).  If you simply
  107. type makexrf it will prompt you for your cdrom drive letter and also
  108. create the xrf file.  If you are having memory problems with the sort,
  109. you can remove the cdrom drivers at that point and re-attempt the sort
  110. by running makexrf dsort.  See above for more details.
  111.  
  112. 3) Once these steps are completed I strongly recommend backing the
  113. converted description file (if you had to do so) and its pointer file
  114. (.ptr), cdcom.xrf and cdcom.pth to a floppy in case something happens.
  115. This way you do not have to go thru the entire configuration process again.
  116.  
  117. You are now done with makexrf.  Finish the setup procedure in the cdcom.doc
  118. file and the door will be ready to run.  If you have problems feel free
  119. to contact me at the number listed in the cdcom.doc file (home or bbs).
  120.  
  121.  
  122. CDCOM DISK CONFIGURATION FILES
  123. ------------------------------
  124.  
  125. Included in the CFGFILES.ZIP file are various configuration files for
  126. cdrom disks that I have come into contact with.  Check below to see if you
  127. can find the disk you have, if not you can create your own configuration
  128. files for makexrf to use.  This is covered at the end of this doc file.
  129.  
  130. I cannot guarantee that all of these configuration files will run
  131. flawlessly as I do not have the vast majority of these cdrom disks
  132. to test these with.  If you have problems with them give me a call
  133. so I can correct them, and help you figure out where the problem
  134. is also.  They should work just fine however, unless I overlooked
  135. something when I created them (those late nights you know).
  136.  
  137.  
  138. CARRS 003 (CARRS3.ZIP)
  139. ----------------------
  140. Un-zip the FILETXT.ZIP file in the \TEXT sub-directory on the cdrom disk
  141. into the current directory.  Un-zip the carrs3 configuration file.
  142. Run MAKEXRF CONVERT to create the master description listing.  Then
  143. run makexrf again to create the other work files.
  144.  
  145. ex:  (cdrom drive letter e:)
  146. pkunzip e:\text\filetxt
  147. pkunzip cfgfiles carrs3.zip
  148. pkunzip carrs3
  149. makexrf convert
  150. makexrf e:
  151.  
  152. CARRS 003-1 (CARRS3-1.ZIP)
  153. --------------------------
  154. This disk may also be called nightowl 003-1.  Locate the DIR1 - DIR34
  155. files on the cdrom disk and copy them over to the current directory.
  156. Un-zip the carrs3-1 configuration file, then run makexrf convert
  157. to create the master description listing.  Then run makexrf again to
  158. create the other work files.
  159.  
  160. ex:  (cdrom drive letter e:)
  161. copy e:dir*   (ie: copy above DIR filenames into current directory)
  162. pkunzip cfgfiles carrs3-1.zip
  163. pkunzip carrs3-1
  164. makexrf convert
  165. makexrf e:
  166.  
  167. GIGABYTE (GIGABYTE.ZIP)
  168. -----------------------
  169. This disk exactly matches the first release of nightowl 004 (nowl4#1).
  170. At any rate locate the DIR1 - DIR28 description files and copy them
  171. from the cdrom disk to the current directory.  Unzip the gigabyte
  172. configuration file, then run makexrf convert to convert them.  Once this
  173. is done run makexrf to create cdcom.xrf and the other work files.
  174.  
  175. ex:  (cdrom drive letter e:)
  176. copy e:dir*   (ie: copy above DIR filenames into current directory)
  177. pkunzip cfgfiles gigabyte.zip
  178. pkunzip gigabyte
  179. makexrf convert
  180. makexrf e:
  181.  
  182. NIGHTOWL 004 #1 AND #2 (NOWL4#1.ZIP AND NOWL4#2.ZIP)
  183. ----------------------------------------------------
  184. These disks may also go by the CARRS label.  There are two 004 disks.
  185. The #1 disks DIR files are dated 4-28-91, and the #2 disks DIR files
  186. are dated 7-15-91.  Once you figure this out, copy the DIR1 - DIR28 files
  187. into the current directory.  Unzip either the nowl4#1 or nowl4#2 depending
  188. on which disk you have.  Then run makexrf convert to create the description
  189. listing.  Once this is done run makexrf again to create cdcom.xrf and the
  190. other work files.
  191.  
  192. NIGHTOWL 004-1 (NOWL4-1.ZIP)
  193. ----------------------------
  194. This disk may also go by the CARRS label.  Copy the DIR1 - DIR31 files
  195. into the current directory.  Unzip the nowl4-1 configuration file.
  196. Then run makexrf convert to create the description listing.  Once this
  197. is done run makexrf again to create cdcom.xrf and the other work files.
  198.  
  199. ex:  (cdrom drive letter e:)
  200. copy e:dir*   (ie: copy above DIR filenames into current directory)
  201. pkunzip cfgfiles nowl4-1.zip
  202. pkunzip nowl4-1
  203. makexrf convert
  204. makexrf e:
  205.  
  206. Programmers Rom QB-1011 (PRGMROM.ZIP)
  207. -------------------------------------
  208. You will need to convert the _ROM.CAT file to a format that makexrf can
  209. use.  The program convert.bas has been included to do this task.  It will
  210. work under dos 5.00 qbasic.exe program.  If you do not have access to this
  211. program, contact me and I will give you a compiled convert.bas to do the job.
  212.  
  213. Copy the _ROM.CAT from the cdrom root directory.  Un-zip the prgmrom.zip
  214. configuration file.  Then load convert.bas into qbasic by typing qbasic convert,
  215. then press the F5 key to run it.  It will create the files that makexrf can read.
  216. Then run makexrf convert to create the master description listing.  After this
  217. is done run makexrf again to create the other work files.
  218.  
  219. ex:  (cdrom drive letter e:)
  220. copy e:\_rom.cat
  221. pkunzip cfgfiles prgmrom.zip
  222. pkunzip prgmrom
  223. qbasic convert  (press F5 once loaded to run it)
  224. makexrf convert
  225. makexrf e:
  226.  
  227. Rbbs-In-A-Box Vol 1, #1 (RBBSV1N1.ZIP)
  228. --------------------------------------
  229. Copy the cdmaster.dir from the \RBBS directory on the cdrom
  230. disk to the current directory.  Un-zip rbbsv1n1 configuration
  231. file, then run MAKEXRF PTR to create the pointer file for the descriptions,
  232. then run makexrf again to create the .xrf and other work files.
  233.  
  234. ex:  (cdrom drive letter e:)
  235. copy e:\rbbs\cdmaster.dir
  236. pkunzip cfgfiles rbbsv1n1.zip
  237. pkunzip rbbsv1n1
  238. makexrf ptr
  239. makexrf e:
  240.  
  241. Rbbs-In-A-Box Vol 1, #2 (RBBSV1N2.ZIP)
  242. --------------------------------------
  243. Copy the cdmaster.alp from the \RBBS directory on the cdrom
  244. disk to the current directory.  Un-zip rbbsv1n2 configuration
  245. file, then run MAKEXRF PTR to create the pointer file for the descriptions,
  246. then run makexrf again to create the .xrf and other work files.
  247.  
  248. ex:  (cdrom drive letter e:)
  249. copy e:\rbbs\cdmaster.alp
  250. pkunzip cfgfiles rbbsv1n2.zip
  251. pkunzip rbbsv1n2
  252. makexrf ptr
  253. makexrf e:
  254.  
  255. Rbbs-In-A-Box Vol 3, #1 & Vol 3.1, #1 (RBBSV3N1.ZIP)
  256. ----------------------------------------------------
  257. For the Vol 3, #1 disks things are a little different.  One of them has
  258. only 1 file in the \SWAL directory, this is the first disk.  The second
  259. disk has all these files.  So for these disks just copy over the
  260. cdmaster.alp file from the \RBBS directory on the cdrom disk to the
  261. current directory.  Un-zip the rbbsv3n1 configuration file, then
  262. run makexrf ptr to create the pointer file for the descriptions, then
  263. run makexrf again to create the other work files.
  264.  
  265. ex:  (cdrom drive letter e:)
  266. copy e:\rbbs\cdmaster.alp
  267. pkunzip cfgfiles rbbsv3n1.zip
  268. pkunzip rbbsv3n1
  269. makexrf ptr
  270. makexrf e:
  271.  
  272. Vol 3.1, #1 does not have a cdmaster.alp file in the \RBBS directory so
  273. makexrf will have to sort the cdmaster.dir file so that is can use it.
  274. Copy the cdmaster.dir file from the \RBBS sub-directory on the cdrom disk
  275. to the current directory, un-zip the rbbsv3n1 configuration file, then run
  276. MAKEXRF DSORT to sort the descriptions (it will also create the pointer
  277. file).  Then run makexrf again to create the other work files.
  278.  
  279. ex:  (cdrom drive letter e:)
  280. copy e:\rbbs\cdmaster.dir
  281. pkunzip cfgfiles rbbsv3n1.zip
  282. pkunzip rbbsv3n1
  283. makexrf dsort
  284. makexrf e:
  285.  
  286. ROM1 (ROM1.ZIP)
  287. ---------------
  288. Unzip the ROM-1V09.ZIP file that came on the floppy disk into
  289. the current directory.  Then unzip the rom1 configuration file.
  290. Run makexrf convert to create the description listing.  Once this
  291. is successful, run makexrf to create the cdcom.xrf and other
  292. work files.
  293.  
  294. ex:  (cdrom drive letter e:)
  295. pkunzip a:\rom-1v09
  296. pkunzip cfgfiles rom1.zip
  297. pkunzip rom1
  298. makexrf convert
  299. makexrf e:
  300.  
  301. ROM2 (ROM2.ZIP)
  302. ---------------
  303. Unzip the ROM2V10.ZIP file that came on the floppy disk into
  304. the current directory.  Then unzip the rom1 configuration file.
  305. Run makexrf convert to create the description listing.  Once this
  306. is successful, run makexrf to create the cdcom.xrf and other
  307. work files.
  308.  
  309. ex:  (cdrom drive letter e:)
  310. pkunzip a:\rom2v10
  311. pkunzip cfgfiles rom2.zip
  312. pkunzip rom2
  313. makexrf convert
  314. makexrf e:
  315.  
  316. Shareware Carousel (CAROUSEL.ZIP)
  317. ---------------------------------
  318. This disk only has IBM, MacIntosh and C-64 files on it.  It also
  319. has no version number on the disk.  You will need to copy the following
  320. files over from the cdrom disk (35 total):
  321.  
  322. MASTER.CAT    969486 04-10-90   4:32p
  323. 00APPL.CAT      6533 04-10-90   9:43a
  324. 00CDEV.CAT      3325 04-10-90  11:43a
  325. 00CODE.CAT      3222 04-10-90   9:44a
  326. 00DA.CAT       17491 04-10-90  11:41a
  327. 00DEMO.CAT      3318 04-10-90   9:48a
  328. 00DOC.CAT        814 04-10-90  11:30a
  329. 00ED.CAT        1782 04-10-90   9:50a
  330. 00FKEY.CAT      2496 04-10-90  11:29a
  331. 00FONTS.CAT     2855 04-10-90   9:51a
  332. 00HC.CAT       20851 04-10-90  11:28a
  333. 00INIT.CAT      3344 04-10-90   9:55a
  334. 00JOHN.CAT       840 04-10-90  11:01a
  335. 00LANG.CAT      4364 04-10-90   9:55a
  336. 00MACII.CAT     1123 04-10-90  11:01a
  337. 00MACTN.CAT    10359 04-10-90  10:03a
  338. 00PATCHE.CAT    1276 04-10-90  11:00a
  339. 00PICT.CAT      5101 04-10-90  10:06a
  340. 00POSTSC.CAT     396 04-10-90  10:58a
  341. 00REVIEW.CAT     461 04-10-90  10:06a
  342. 00SOUNDS.CAT   10440 04-10-90  10:32a
  343. 00TECH.CAT      1165 04-10-90  10:07a
  344. 00UNIX.CAT      1238 04-10-90  10:24a
  345. 00UTIL.CAT      5550 04-10-90  10:12a
  346. 00UTILDK.CAT    3386 04-10-90  10:24a
  347. 00UTILFL.CAT    2469 04-10-90  10:15a
  348. 00UTILPN.CAT     855 04-10-90  10:19a
  349. 00VIRUS.CAT     2263 04-10-90  10:18a
  350. 064APPS.CAT     6956 04-10-90  12:25p
  351. 064GAMES.CAT   13444 04-10-90  12:04p
  352. 064MISC.CAT     2735 04-10-90  12:22p
  353. 064MUSIC.CAT   40867 04-10-90  12:16p
  354. 064UTILS.CAT    8287 04-10-90  12:21p
  355.  
  356. I do not know exactly where they are located, I imagine it is one file
  357. per directory however (I don't have this disk, just these files).
  358.  
  359. These descriptions will need to be converted before makexrf can use them.
  360. The program convert.bas has been included to do this task.  It will work
  361. under dos 5.00 qbasic.exe program.  If you do not have access to this
  362. program, contact me and I will give you a compiled convert.bas to do the job.
  363.  
  364. Then load convert.bas into qbasic by typing qbasic convert, then
  365. press the F5 key to run it.  It will create the files that makexrf
  366. can read.  Then unzip the carousel configuration file, then run
  367. makexrf convert to create the master description listing.  After this
  368. is done run makexrf again to create the other work files.
  369.  
  370. ex:  (cdrom drive letter e:)
  371. copy e:\*.cat  (ie: copy the above cat files into current directory)
  372. pkunzip cfgfiles carousel.zip
  373. pkunzip carousel
  374. qbasic convert  (press F5 once loaded to run it)
  375. makexrf convert
  376. makexrf e:
  377.  
  378. Shareware Carousel Vol. 2, #1  (CAROV2N1.ZIP)
  379. ---------------------------------------------
  380. The descriptions on the cdrom disk will need to be converted before
  381. makexrf can use them.  The program convert.bas has been included to
  382. do this task.  It will work under dos 5.00 qbasic.exe program.  If
  383. you do not have access to this program, contact me and I will give
  384. you a compiled convert.bas to do the job.
  385.  
  386. You will need to copy the following files from the cdrom disk to the
  387. current directory.  I think they are all in the root directory.
  388.  
  389. filename         size   date     time
  390. AMIGA.CAT       40532 08-20-90   7:59p
  391. ATARI.CAT       41554 08-20-90  12:19p
  392. COMDORE.CAT     97334 08-21-90   8:14p
  393. GRAPHIC.CAT     90460 07-12-90  11:42a
  394. MACTOSH.CAT    178513 08-21-90   1:59p
  395. MASTER.CAT     973174 08-13-90   2:15p
  396. MEAN_18.CAT     19535 08-20-90   4:18p
  397.  
  398. Then load convert.bas into qbasic by typing qbasic convert, then
  399. press the F5 key to run it.  It will create the files that makexrf
  400. can read.  Then unzip the carov2n1 configuration file, then run
  401. makexrf convert to create the master description listing.  After this
  402. is done run makexrf again to create the other work files.
  403.  
  404. ex:  (cdrom drive letter e:)
  405. copy e:\*.cat  (ie: copy the above cat files into current directory)
  406. pkunzip cfgfiles carov2n1.zip
  407. pkunzip carov2n1
  408. qbasic convert  (press F5 once loaded to run it)
  409. makexrf convert
  410. makexrf e:
  411.  
  412. IF YOUR CDROM DISK IS NOT LISTED HERE CONFIGURATION INFORMATION
  413. ---------------------------------------------------------------
  414.  
  415. CdCom for ease of searching uses one master description listing with
  416. all files in it, sorted alphabetically.  If you do not have such a
  417. listing then one needs to be made.  Makexrf has the capability of taking
  418. category file listings and merging them into one main file, then sorting it.
  419. The listings can have single or multi-line descriptions.  All headers and
  420. other non-filename/description listings will be stripped out (see below).
  421.  
  422. CdCom uses the following format for description listings.
  423.  
  424. single line description:
  425.  
  426. filename       filesize filedate     description                 category code
  427. 16550.ZIP        4197  07-27-88  Set fifo buffer on 16550 UART             001
  428.  
  429.  
  430. multi-line description:
  431.  
  432. filename       filesize filedate     descriptions                category code
  433. AP102.ZIP       76146  04-15-91  Telix script auto-starts Puma and Bimodem 001
  434.                                | Downloads, exits Telix if left unattended,001
  435.                                | other features                            001
  436.  
  437. The | signifies multiline description to makexrf.  multi-line descriptions
  438. cannot be recognized without it (even with the multi-line toggle set
  439. to 1).  The | does not have to be in column 32 exactly initially, however
  440. makexrf will move it to that location when it re-writes it (this is
  441. following the pcboard format).
  442.  
  443. Makexrf will add the category code based on its location in the makexrf.cfg
  444. file (see makexrf.cfg explanation below).  Category codes DO NOT have to be
  445. in the initial listings, in fact I recommend stripping any out that may
  446. already be in them if they do in fact contain such codes (unless they are
  447. really needed) since makexrf will add its own code that cdcom uses.  I just
  448. showed them here so you would know where it puts them.
  449.  
  450. This is not a fixed format.  The only thing that matters for the initial
  451. conversion is that all filenames must be all the way at the left. If
  452. makexrf encounters a space or any other invalid filename character in the
  453. leftmost column it will strip this line out.  This is why it is important
  454. to use the | character for multi-line descriptions, without it makexrf has
  455. no way of knowing whether it is just part of a filename header or something
  456. else not needed in the master file.  Most headers will be stripped out
  457. unless they are left justified and begin with a valid filename character.
  458. Blank lines will also be stripped out.
  459.  
  460. The location of the filesize, date, description, etc is not critical, and
  461. any of these can be omitted.  The only thing needed is the filename.
  462. The filename however should not contain any spaces.  It will not affect
  463. the operation of the description conversion, however the cddisk.rpt
  464. will contain all of the filenames that have spaces in them. The filename
  465. should be FILENAME.EXT not FILENAME EXT or FILE     EXT if you want
  466. it to function correctly (FILE.EXT is acceptable for the last example, but
  467. FILE EXT is not).
  468.  
  469. The category code tells cdcom which file category the file is in, so that
  470. the user can list files by category.  The rbbs-in-a-box (riab) description
  471. files already have this category code in their listings.  If makexrf creates
  472. listings from available file descriptions, then it will add it itself.
  473. It must always be a 3 character numeric code, no letters allowed.
  474.  
  475. Here is the format for the makexrf.cfg file:
  476.  
  477. 1> nowl4-1.cat ;description filename
  478. 2> 1           ;multiline descriptions=1, single line = 0
  479. 3> 0           ;set at 1 only for riab disks (read desc file backwards)
  480. 4> 31          ;# of category description files to convert
  481. DIR1
  482. DIR2
  483. DIR3
  484. DIR4
  485. DIR5
  486. DIR6
  487. DIR7
  488. DIR8
  489. DIR9
  490. DIR10
  491. DIR11
  492. DIR12
  493. DIR13
  494. DIR14
  495. DIR15
  496. DIR16
  497. DIR17
  498. DIR18
  499. DIR19
  500. DIR20
  501. DIR21
  502. DIR22
  503. DIR23
  504. DIR24
  505. DIR25
  506. DIR26
  507. DIR27
  508. DIR28
  509. DIR29
  510. DIR30
  511. DIR31
  512.  
  513. 1> is the filename that will be used when writing the master description
  514. listing (in this case nowl4-1.cat).  You can call it whatever you want.
  515. The pointer file in this case would be nowl4-1.ptr (so it just changes
  516. the extension to .ptr for the pointer file).
  517.  
  518. 2> if the file category listings you have contain multi-line descriptions,
  519. and are using the | convention, then set this to 1.  Otherwise set it to 0.
  520.  
  521. 3> if the existing master description listing is sorted backwards, like
  522. the riab disks are, then set this to one.  If you want your single line
  523. description listing sorted backwards you can also set this to 1 also,
  524. although I don't know why you would want to do this.  This must be set
  525. to 0 for multi-line descriptions.
  526.  
  527. 4> is the number of category description filenames to convert.
  528.  
  529. lines after 4 are the category filenames to convert.  These must be valid
  530. dos filenames, and can include the paths to them.  Note however that they
  531. will be erased as they are converted, so if they are on the cdrom disk
  532. then copy them over to the current work directory.  These files are the
  533. listings by category (like files.bbs) that hopefully came with your cdrom
  534. disk (broken down into categories like communcations, games, etc).  Each
  535. listing will be treated as a different category.  The three digit category
  536. code is assigned by the filenames location in makexrf.cfg.  So in this
  537. example DIR1 is assigned 001, DIR2 is assigned 002, etc.  If DIR3 had
  538. been the first filename listed then it would have been assigned 001
  539. for a category code.  This category code should match the one given
  540. in your file category menu (for cdcom, category.bbs).  Example:
  541.  
  542.  1 Communications           13 Printer Util         25 Misc program util
  543.  2 Games of all sorts       14 Disk Util            26 Home and personal
  544.  3 Desktop applications     15 File Util            27 Utilities & programs
  545.  4 Word processors          16 Keyboard Util        28 Gif Pictures
  546.  5 C/Assembler              17 Windows              29 BBS Doors and Util.
  547.  6 Pascal And Turbo         18 Cad                  30 ASP Shareware Progr.
  548.  7 Basic And Qbasic         19 Lotus applications   31 Zipping Utilities
  549.  8 Education and helps      20 Misc                 32
  550.  9 Business programs        21 Virus protections    33
  551. 10 Entertainment            22 Database programs    34
  552. 11 Systems Util             23 Graphic programs     35
  553. 12 Screen Util              24 Dos and patches      36
  554.  
  555. so the DIR1 file contain the communications category files, DIR2 file
  556. contains the games files, etc.  So try to arrange them in the proper order
  557. so they will match the category.bbs menu file.  Note in the menu it is not
  558. important if the category code is 1 or 001, cdcom will add the padded 0's
  559. itself if the user just types 1 instead of 001, or 2 instead of 002 when
  560. it goes to list the files by category.
  561.  
  562. Do not put ; comments on the category filename lines.  Also if you copy
  563. files off the cdrom disk insure that the read-only attribute has been
  564. toggled off (use attrib -r *.* to turn it off if it is on).
  565.  
  566. Once you have created the makexrf.cfg file, then run makexrf convert.
  567. It will read the cfg file and process the file lists.  Once it is done,
  568. and it did not crash in the process, there will be the master listing
  569. (given by line 1), a .ptr file (based on line 1), and a file called
  570. makexrf.dat.  This will contain the number that you must put on cdcom.def
  571. line 15.
  572.  
  573. If you are having memory problems, refer to the top of this doc file.
  574. You can remove the cdrom drivers during the description conversion if
  575. you need to, as they are not needed.  You will need to re-install them
  576. however for when it creates the filename cross-reference listing.  For
  577. any other errors refer to ERRORS.DOC.  If you still cannot solve the
  578. problem then feel free to contact me at the numbers listed in cdcom.doc.
  579.  
  580. You will also need to create a file called cdcom.cat.  This file actually
  581. controls what categories cdcom will recognize.  This file is also covered
  582. in the cdcom.doc file.  For this example cdcom.cat would look like:
  583.  
  584. # of categories
  585. category code,category description
  586.  
  587. 31
  588. 001,Communications
  589. 002,Games of all sorts
  590. 003,Desktop applications
  591. 004,Word processors
  592. 005,C/Assembler
  593. 006,Pascal And Turbo
  594. 007,Basic And Qbasic
  595. 008,Education and helps
  596. 009,Business programs
  597. 010,Entertainment
  598. 011,Systems Util
  599. 012,Screen Util
  600. 013,Printer Util
  601. 014,Disk Util
  602. 015,File Util
  603. 016,Keyboard Util
  604. 017,Windows
  605. 018,Cad
  606. 019,Lotus applications
  607. 020,Misc
  608. 021,Virus protections
  609. 022,Database programs
  610. 023,Graphic programs
  611. 024,Dos and patches
  612. 025,Misc program util
  613. 026,Home and personal
  614. 027,Utilities & programs
  615. 028,Gif Pictures
  616. 029,BBS Doors and Util.
  617. 030,ASP Shareware Progr.
  618. 031,Zipping Utilities
  619.  
  620. Note that in this file the category number must contain the padded 0's
  621. in front of the category number.  The description can be whatever you
  622. want, but it should just match the menu.  I have seen on the disks that
  623. support GAP bbs that cdcom.cat resembles the DIRS file, so you can just
  624. modify that file to the format cdcom uses.  If not what I usually do is
  625. just take the category menu and edit it to make cdcom.cat (now you see
  626. what I used to have to do to make a disk work with cdcom).  Also on some
  627. of the disks are the DIR and DIRG files, which are the ascii and ansi
  628. category menus, respectively.  Just rename these to category.bbs for
  629. the DIR, and category.scr for the DIRG and your set as far as the
  630. category menu goes.  Note ansi screens only work with the registered
  631. version of the door however.
  632.  
  633. You can look at the configuration files that are included in this zip
  634. for examples on how to setup the makexrf.cfg, cdcom.cat and cdcom.def
  635. files for your disk if you are having problems.  I tried to make this
  636. as simple as possible, but then again everything looks simple from the
  637. programmers point of view.  Feel free to contact me if you are having
  638. problems.
  639.  
  640. A simple example showing idea behind setting up a new disk for this
  641. program:
  642.  
  643. a cdrom disk with 5 category sub-directories, each with a files.bbs in it.
  644. The descriptions are single line.
  645.  
  646. cdrom disk tree structure:
  647.  
  648. E:\
  649.   \GAMES
  650.   \COMMO
  651.   \UTILS
  652.   \PRINTER
  653.   \GRAPHICS
  654.  
  655. copy each files.bbs into current directory, re-naming it as you go along.
  656.  
  657. ex:
  658. copy e:\games\files.bbs games.txt
  659. copy e:\commo\files.bbs commo.txt
  660. copy e:\utils\files.bbs utils.txt
  661. copy e:\printer\files.bbs printer.txt
  662. copy e:\graphics\files.bbs graphics.txt
  663.  
  664. makexrf.cfg for this would look like
  665.  
  666. category.cat  ;description filename
  667. 0             ;single line descriptions
  668. 0             ;sort them forwards
  669. 5             ;# of description filenames to convert
  670. GAMES.TXT
  671. COMMO.TXT
  672. UTILS.TXT
  673. PRINTER.TXT
  674. GRAPHICS.TXT
  675.  
  676. Remember to arrange these in the order that they appear in your category
  677. menu (category.bbs) if you have one.  Games in this example will be
  678. assigned category code 001, communications category code 002, etc.
  679.  
  680. run MAKEXRF CONVERT to convert them.  Then run makexrf again to create
  681. the .xrf and other work files.  Check makexrf.dat for description line
  682. length to put on cdcom.def line 15 (and save this file also in same
  683. directory as makexrf as it is used later by some functions).
  684.  
  685. ex for above:
  686. makexrf convert
  687. makexrf e:
  688.  
  689. Create CDCOM.CAT
  690.  
  691. 5
  692. 001,Games and other Fun Stuff
  693. 002,Communications Programs
  694. 003,Utilities
  695. 004,Printer Programs
  696. 005,Graphics Programs
  697.  
  698. Create a category.bbs file category menu if needed using these category
  699. codes.
  700.  
  701. You are now done with makexrf.  Continue with cdcom installation.
  702.  
  703. Sound simple?  I hope it is.  It will just require a little work locating
  704. and copying over all the description files, and locating the category
  705. menu.  Hopefully your cdrom disk comes with all this information.
  706. Once that step is done the rest should be easy.
  707.  
  708. ELS  10-13-91
  709.  
  710. <The END>
  711.