home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / CDCOM.ZIP / CDCOM.DOC < prev    next >
Text File  |  1991-10-20  |  44KB  |  964 lines
  1.  
  2. CdCom - CD-ROM Support Door  Ver 1.1c
  3. This Version Supporting most Shareware CDROM Disks (except pc-sig)
  4.  
  5. 10/11/91  Ver 1.1b Note - Slow Screens
  6. Although I cannot explain it, the compiler I use for the door just seems
  7. to love math coprocessors.  If you do not own one, the screens will seem
  8. slow and jerky.  If you own one, they will just zoom right along.  I have
  9. always had a math coprocessor, and never noticed the problem until I logged
  10. onto some of your bbs's and noticed the slow screens.  So if you would
  11. like to see a dramatic speed increase in the door, and do not have a
  12. math coprocessor installed in your system, you may want to add one.
  13. The prices have recently plummeted on them making them quite affordable.
  14. The ads in the back of PC Week magazine list some very competitive companies
  15. selling math coprocessors and the such in the component ads section.
  16. Its up to you however, as you may not have other programs that
  17. use math coprocessors.  Its just one idea.  - End Note
  18.  
  19. CdCom is a full featured door program for allowing your users access to
  20. the shareware types of cdrom disks.  The door allows listing of files by
  21. category, searching for text, viewing of files and downloading.  Batch
  22. downloading is available for protocols that support it.   See PROTOCOL.DOC
  23. in this file for more information on this.
  24.  
  25. This version represents my first attempt to have one door program to
  26. work with all types of cdrom disks.  My previous method was to release
  27. a different version for each disk.  However due to time considerations,
  28. and just the total hassle of doing it that way, I have attempted with
  29. this release to just have one program for all these disks.  Configuration
  30. files for the various disks I have come into contact with over the years
  31. are in the cfgfiles.zip file in this zip.  The makexrf.doc file covers
  32. all these setups.  If you are running a disk that this door previously
  33. supported, all cdcom work files (.crf, .pth, descriptions and pointer)
  34. should work just fine with the new version.  Some things have changed
  35. however, so you will need to read this doc file before attempting to
  36. run it with your disk.  New setups just follow the configuration steps
  37. and there should be no problems.
  38.  
  39. This door was written to use Wildcats CALLINFO.BBS door user information
  40. file, however it can be run with other bbs software by simply creating a
  41. callinfo.bbs file using a conversion program.  Callinfo.bbs is the only
  42. Wildcat specific file that CdCom uses.  See notes at the end of this
  43. documentation file for more info on callinfo.bbs and what info CdCom
  44. uses out of it.
  45.  
  46. Wildcat ver 3.0 does not write a callinfo.bbs file.  At this time you will
  47. need a conversion program to make callinfo.bbs from door.sys.  There are
  48. ones available out there that do work just fine, but if needed I will
  49. write one.  I will undoubtably support the door.sys file in the near
  50. future, but that will require some time to convert over to it so it won't
  51. be anytime soon.
  52.  
  53. The following files should be in this CDCOM.ZIP file:
  54.  
  55. CDCOM.EXE       - Main Program
  56. CDCOM.DOC       - Documentation
  57. CDCOM.BBS       - Main Menu Screen
  58. CDCOM1.BBS      - Sample Logon Dump Screen
  59. CDROP.BAT       - Sample Shell to DOS Batch File
  60. CDCOM.HLP       - Help File Explains Commands
  61. PROTOCOL.BAT    - Main Protocol Batch File
  62. PROTOCOL.DEF    - Protocol Configuration File
  63. PROTOCOL.DOC    - CdCom Protocol Usage Doc's
  64. PROTOCOL.BBS    - Protocol's Avaialable Menu
  65. RVMX.COM/DOC    - Allows you to use EGA/VGA memory as extra dos memory
  66. SAMPLE.BAT      - Sample Batch File for Running Cdcom
  67. REPORT.TMP      - Template used to generate top 45 downloads report
  68. MAKEXRF.DOC     - Doc File for MAKEXRF.EXE Program
  69. MAKEXRF.EXE     - Setup Program For Converting Descriptions and Creating
  70.                   CdCom Work Files
  71. CFGFILES.ZIP    - Various configuration files for different disks.
  72. ERRORS.DOC      - Lists errors generated by program
  73. REGISTER.DOC    - Program registration information
  74. README.1ST      - Most recent information on program
  75.  
  76. In the CFGFILES.ZIP file will be individual zip files for the various
  77. disks that the door previously supported.  The zip files are named by
  78. the disk they support.  In those zip files should be at least the
  79. following:
  80.  
  81. CDCOM.DEF       - door configuration file
  82. CDCOM.CAT       - file category control file
  83. CATEGORY.BBS    - file category menu file
  84. MAKEXRF.CFG     - configuration file for makexrf
  85.  
  86. there may be other files in these config zip files for certain disks.
  87. Makexrf.doc should cover these.
  88.  
  89. As well as this CdCom will create or use:
  90.  
  91. CDCOM.XRF       - Sorted Cross Reference file for Quick File Searches
  92. CDCOM.USR       - Logs users downloads and download kb in door
  93. CDDISK.RPT      - Report of Whats on Cdrom Disk.
  94. CDCOM.PTH       - Contains Paths on Cdrom Disk, Used by Door.
  95. CDCOM.RPT       - Top 45 downloads report
  96. CALLINFO.BBS    - Wildcat's Caller Info Created When a Door is Run.
  97. CDCOM.LOG       - A log file that lists what the user did
  98. CDCOM.TDY       - Keeps track of users time for the day
  99. CDCOM.SEC       - Online Time in door/ratio check by security config file
  100. CRITICAL.LOG    - Updated when a program error occurs.  I'll need the info
  101.                   in here if you call for help.
  102.  
  103. Note:
  104.   For multi-node setups some of these files will have different names.
  105. Please refer to multi-node setup instructions below even if you are not
  106. going to run multi-node.
  107.  
  108. There are no internal protocols in this door.  A minimum setup requires
  109. DSZ for Xmodem, Ymodem, Zmodem.  This program and others are covered
  110. in PROTOCOL.DOC.  Read this before running CDCOM.  You can get the
  111. latest version of DSZ from the dsz bbs at (503) 621-3746.  Download
  112. as DSZ.ZIP.
  113.  
  114. There is also no internal view code for zips and other compressed
  115. files either.  The door has been written to support AviewCom to do
  116. these functions.  AVIEW54A.ZIP is the latest version the door has
  117. been tested with.  See below for more information.
  118.  
  119. The distribution package (unregistered version) has the following
  120. features disabled:
  121.  
  122. 1) Color menus are not allowed.
  123. 2) Cdcom.sec support is not functional.
  124. 3) Top 45 download report is not functional.
  125. 4) Only 3 files can be batch downloaded at a time.
  126. 5) Future versions will have record updating and advanced ratio checking.
  127.    This will not be enabled in unregistered version.
  128.  
  129. These features are enabled after registration.  All other features of
  130. the door are functional besides these.
  131.  
  132. There is also a message given to the user when they go to download
  133. that the program is unregistered.  This will cease after registration.
  134.  
  135. ===========================================================================
  136.  
  137. SET-UP:
  138.  
  139. The door uses various work files that must be created.  Makexrf.exe will
  140. create most of them itself, however there are some you will have to
  141. create with a text editor.
  142.  
  143. Description listing/reading/searching is handled by cdcom thru one
  144. main description list that is sorted alphabetically.  It can be
  145. sorted forward or backwards, and cdcom can handle it depending on
  146. the version of the door.  If such a list is not available makexrf can
  147. make one from the listings you should have.  See section 2 below.
  148.  
  149. Note that MAKEXRF ? or MAKEXRF HELP will tell you all the command
  150. line parameters that MAKEXRF acknowledges.  Also remember that
  151. ERRORS.DOC has most of the common error #'s covered that may
  152. be generated by cdcom or makexrf during operation.  Check this file if
  153. you get an error.
  154.  
  155. 1) Make a separate directory for this cdrom door.  Un-zip all files
  156. into it.
  157.  
  158. 2) Run the MAKEXRF program to create work files and convert descriptions
  159. if necessary.  See MAKEXRF.DOC for details on this.  This is a major
  160. step so read makexrf.doc carefully, and don't miss any steps in it.
  161.  
  162. 3) Modify CDCOM.DEF file for your system.  See explanation below.
  163.  
  164. 4) Configure PROTOCOL.DEF and PROTOCOL.BAT for the protocols you
  165.    want to support.  See PROTOCOL.DOC for an explanation on how
  166.    CdCom handles protocols.
  167.  
  168. The door at this point is ready to run.  You can edit the menu files
  169. later on to your tastes.
  170.  
  171. ===========================================================================
  172.  
  173. CDCOM.DEF:
  174.  
  175. This is the main configuration file for CdCom.  This file will have a
  176. different filename for multi-node systems.  See multi-node section below
  177. even if you are not running multi-node.  You will need a text editor
  178. (edlin being the most basic one) to modify/create this file.
  179.  
  180. CDCOM.DEF set-up file:
  181.  
  182. 1> h:                ; drive letter of cdrom drive
  183. 2> c:\cdcom          ; where cdcom will be located
  184. 3> on                ; bell on/off when paged
  185. 4> 1000              ; lowest security allowed to drop to dos via cdrop.bat
  186. 5> 50                ; minumum security allowed to download
  187. 6> c:\cdcom          ; alternate path for cdcom.log file
  188. 7> d:\master.cat     ; path to sorted description file ( + filename)
  189. 8> n                 ; toggle y/n to allow auto log-off from within prgm
  190. 9> c:\cdcom\node1    ; path to temp work directory
  191. 10> y                ; send files from cdrom (y) or from temp work dir (n)
  192. 11> n                ; reboot if cdrom drive timeout y/n
  193. 12> y                ; add ---- to log file between users
  194. 13> 1,36,40          ; normal text color
  195. 14> 1,37,40          ; hi-lighted text color
  196. 15> 81               ; description line length, makexrf.dat reports this
  197. 16> 0                ; leave 0 unless using rbbs-in-a-box disk
  198. 17> 1                ; 1 = multi-line descriptions, 0 = single line desc's
  199.  
  200. On all drive:\path designations do not put a trailing backslash "\".
  201.  
  202. You can have comments on the same line, just begin them with a ";".
  203. Cdcom will ignore any text past that.  Do not wrap comments around to
  204. the next line however.  They can go as far right as you want though.
  205.  
  206. 1>  Drive letter of the cd-rom.  Make sure to put the ":" after the drive
  207. letter.
  208.  
  209. 2>  Drive and path where Cdcom will be run from.
  210.  
  211. 3>  Turn page alert tone on or off.  Its a "red alert" type tone, will
  212. definately get your attention.
  213.  
  214. 4>  Lowest security user that will be allowed to shell into dos from
  215. the program.  It shells to CDROP.BAT, that will let you turn on watchdog,
  216. CTTY AUX1, etc.  See example batch file.  The shell command is not displayed
  217. in the menu, it is the "^".  If you don't want to use this feature then make
  218. it a number larger than any security level you might have, like 10000.  This
  219. is also a multi-node filename changing type of file.
  220.  
  221. 5> Minimum security allowed for downloading.  This allows you to open
  222. the program up so all users can access it, read/search descriptions
  223. but not be able to download until they register.  Any number is valid,
  224. so if you enter a 0 then all securities can download from the program.
  225.  
  226. 6> Path for the log file.  This way you can have it written to
  227. your BBS system files area or wherever so you can use the [R]ead a text
  228. file command from Wildcat and read the log file, else in Wildcats case
  229. you would have to add the path to CdCom in the configuration.  Do not
  230. make this the same directory as line 9.  The line 9 sub-dir is a
  231. scratch directory for cdcom, and all files are killed periodically
  232. from that directory during program operation.
  233.  
  234. 7> Full path plus filename for the sorted description file.  This will
  235. be the same filename from step 2 of the setup (see above).
  236.  
  237. 8> Toggle to allow or disallow auto-logoff after downloading from within
  238. door.  The door has an automatic 3 minute timeout logoff even if you
  239. disable this function, it will simply exit gracefully back to the bbs
  240. and the bbs can log them off.  The user is also given a 20 second
  241. countdown in order to abort auto log-off.
  242.  
  243. 9> Temporary work directory for viewing or downloading files.  This
  244. directory should be SEPARATE for each node if you are running a
  245. multi-node system.  DO NOT make this the same directory as the
  246. work directory as all files get erased in this directory throughout
  247. various times when the door is running.  Do not store callinfo.bbs
  248. here or any other files, as they will get erased.  This is a scratch
  249. directory for the program, not for longterm storage of files.  A ramdisk
  250. would be ideal for this purpose.
  251.  
  252. 10> Send files from cdrom disk or from hard disk.  A Y will send the
  253. files from the cdrom disk, a N will cause cdcom to copy them to
  254. the temp dir specified by line 9 (see above) and send them from
  255. there.  Cdcom has its own internal copy routines, so if you are
  256. having problems with dsz giving you the classic CDR 101 error with
  257. this set to Y, then try changing it to N and let cdcom attempt to
  258. copy them over.  If it bombs it will exit gracefully with an error
  259. 71 or 72 and go back to the bbs instead of hanging your system up.
  260.  
  261. 11> Auto reboot toggle.  If cdcom encounters a cdrom drive time out
  262. (CDR 101 also) you have the option to have it reboot your computer.
  263. I've found this can "wake up" the cdrom drive sometimes, especially
  264. for older drives or older versions of the drivers.  Reboot will occur
  265. on error 71 or 72.  This is of course unwanted in multinode setups.
  266.  
  267. 12> if you want a dashed line ---- between users in the log, put a y
  268. here.  Some callers log programs don't like this though, so if your
  269. using one that doesn't just put a n here.  The dashed line makes it
  270. a little more readable though for general use.
  271.  
  272. 13> Normal text color.  For users who selected ansi, this will be
  273. the text color they recieve.  See pg. 595 of ms-dos 5.0 manual
  274. for a breakdown of the colors.  Make sure you separate them with
  275. a comma, DO NOT USE a ; to separate them, it will not work!  Color
  276. also will not work on un-registered versions, however this line
  277. cannot be omitted (it can be blank).
  278.  
  279. 14> Hi-lighted color.  Items surrounded in <>, () and [] will
  280. be hi-lighted using this color, as well as any other pertinent text.
  281. All rules from line 13 apply here also.
  282.  
  283. 15> Description line length.  See makexrf.doc for explanation of this.
  284. After makexrf has converted descriptions (if necessary) it will create
  285. a file called makexrf.dat that will have the correct value to enter here.
  286.  
  287. 16> toggle to read description file forwards (=0) or backwards (=1).
  288. Rbbs-in-a-box disks are the only ones I know of that have the description
  289. file sorted backwards, so this needs to be 1 for their disks.  However not
  290. all versions of riab disks have the description file backwards, so verify
  291. this before setting this to 1.  Most disks will have this set at 0.
  292.  
  293. 17> Single/multi line description toggle.  Multi-line descriptions are
  294. designated by having an | in column 32.  If so set this value to 1,
  295. otherwise leave it at 0.  See makexrf.doc for further explantion of this.
  296. The | does not have to be in column 32, however makexrf will place it there
  297. if its not when it converts the descriptions, but if you have an existing
  298. description file then don't worry about the exact location.  However it does
  299. have to contain a | to be a multi-line description or cdcom won't be able
  300. to handle it correctly.
  301.  
  302. ==========================================================================
  303.  
  304. MULTI-NODE SETUP:
  305.  
  306. The following files are altered for multi-node setup.
  307.  
  308. CDCOM.DEF
  309. CDCOM.LOG
  310. CDCOM.SEC
  311. CDROP.BAT
  312.  
  313. The change will be in that cdcom will add the node number to the
  314. filename, so for node 1 you would have:
  315.  
  316. CDCOM1.DEF
  317. CDCOM1.LOG
  318. CDCOM1.SEC
  319. CDROP1.BAT
  320.  
  321. Cdcom will read line 35 of callinfo.bbs for the node number.  Even if
  322. you are not running multi-node, if wildcat or your conversion program
  323. is writing a number here you must take this into account and modify these
  324. filenames as so.  If you are running an earlier version of Wildcat, or
  325. your conversion program writes nothing here then cdcom will use the
  326. non-altered filenames (cdcom.def, cdcom.sec, etc).
  327.  
  328. In cdcom#.def, insure that line 9 the temp directory is a SEPARATE
  329. directory from all the other nodes.  This is VERY important!  So
  330. a good setup would be as so:
  331.  
  332. C:\CDCOM
  333.         \NODE1
  334.         \NODE2
  335.         \NODE3
  336.  
  337. Line 9 for CDCOM1.DEF would be   C:\CDCOM\NODE1
  338. Line 9 for CDCOM2.DEF would be   C:\CDCOM\NODE2
  339.  
  340. All files are opened in share mode, so you can share the description file,
  341. category file, menus, etc.  Just don't share the temp directory.
  342.  
  343. Note that most LAN's require that all .EXE, .COM and .BAT files are
  344. read-only.  You can also read-only the cdcom work files if you wish,
  345. except for:
  346.  
  347. CDCOM#.LOG
  348. CRITICAL.LOG
  349. CDCOM.TDY
  350. CDCOM.XRF
  351. CDCOM.USR
  352.  
  353. If you register the program then insure that CDCOM.EXE is not read-only.
  354. You can change it back after the registration process.
  355.  
  356. ============================================================================
  357.  
  358. PROTOCOLS:
  359.  
  360. Protocols are dynamic in CdCom.  They are controlled by
  361. PROTOCOL.DEF.  PROTOCOL.BBS/SCR is simply a display file
  362. to let the user know what protocols you support.  It in no
  363. way reflects what you have active.  CdCom shells to PROTOCOL.BAT
  364. for sending files.  Read PROTOCOL.DOC for more info on this.
  365.  
  366. ==========================================================================
  367.  
  368. MENU and TEXT Files:
  369.  
  370. The following files are either dumped as ansi or text depending
  371. on the users selection (callinfo line 6).  Text versions are
  372. supplied in the program.  The menu selection codes are hardcoded into the
  373. program however and cannot be changed at this time.
  374.  
  375. cdcom.bbs      - main menu
  376. cdcom1.bbs     - intro dump file
  377. protocol.bbs   - protocol selection menu
  378. category.bbs   - category listing menu file
  379.  
  380. Color screens should have a .SCR extension, ascii files a .BBS extension.
  381.  
  382. The unregistered version of this program does not allow color screens.
  383. Registration will enable this feature.
  384.  
  385. Information from callinfo.bbs can be displayed by putting a ctrl-c
  386. then the line number of the information you want immediately afterwords.
  387. So a 05 will display the users time left, and 20 would display the
  388. protocol they are using.  See bottom of this doc file for a breakdown
  389. of callinfo.bbs.  Note the number must be 2 digit, so 1 - 9 must have
  390. a leading 0.
  391.  
  392. By inserting a ascii 1 (ctrl-a) you can make the screen pause with
  393. a <C>ontinue, <S>top, <N>onstop prompt, and a ascii 2 will make it
  394. pause with a Press [Enter] To Continue prompt.  It will occur immediately
  395. upon reading one of these characters, so watch where you place it in the
  396. file.
  397.  
  398. Note that cdcom1.bbs/.scr is not a multi-node file, so you don't need
  399. cdcom2.bbs/.scr etc.  I just called it that for lack of imagination.
  400.  
  401. =========================================================================
  402.  
  403. RUNNING CDCOM:
  404.  
  405. You must pass the full path and filename to cdcom for callinfo.bbs
  406. on the command line.  For multi-node setup it is a very-bad-idea
  407. to copy callinfo.bbs to the cdcom work directory, then run it
  408. as:
  409.  
  410. cdcom callinfo.bbs
  411.  
  412. Although this will work, the next user who goes in overwrites the
  413. previous callinfo.bbs there.  A worst case scenario would of course
  414. be a simultaneous entrance into the door of you and your worst user,
  415. and he gets logged on as you.  Plus the fact that aviewcom will delete
  416. callinfo.bbs when it is all done makes this not-the-best-idea.  A
  417. better idea is to use:
  418.  
  419. cdcom c:\wildcat\node1\callinfo.bbs
  420.  
  421. passing cdcom the entire path to callinfo.bbs from the node they came from.
  422. This way there are no collisions, no overwrites and hopefully no problems.
  423.  
  424. Simply running cdcom with no command line will put it into a "local"
  425. local mode, it will not require a callinfo.bbs at all.  It will
  426. prompt you for the info it needs (with default values in brackets [ ] )
  427. then run the program as it would in local mode via callinfo.bbs, except
  428. for downloads.  When you go to download it will copy the files to a
  429. destination you can specify or use the default (default is temp dir
  430. line 9 of cdcom.def).  It will also check for free space on disk,
  431. handy for copying off to floppy.  It will ask you for the node number
  432. also, if you hit enter here it will assume no node number and operate
  433. as so.  If you are on one of your nodes then enter that number.
  434. Note that it still requires cdcom.def (or cdcom#.def) and all other work
  435. files, so insure the door is configured properly for your system and the
  436. node you are on.
  437.  
  438. See the file SAMPLE.BAT for a sample batch file for running CdCom
  439. on your bbs.
  440.  
  441. If you are running the program on a non-Wildcat system insure
  442. that there is sufficient memory for CdCom to run.  It is advised
  443. to use a shell that removes the BBS software from memory giving
  444. CdCom maximum room.  CdCom uses approximately 220k, and you must
  445. still leave room for DSZ and Aviewcom to run.  Aviewcom uses
  446. pkunzip to extract text from a zip, and pkunzip uses 70k of
  447. memory so you need about 400k free when you exit your bbs software.
  448. An error 7 will be generated by cdcom if there is insufficient memory
  449. for it to shell to any of these two programs (although the program that
  450. is being shelled to may still bomb with insufficient memory).  On LAN
  451. systems it will probably be necessary to use a program that will allow
  452. you to load the LAN drivers into high memory to free up enough memory
  453. to run these programs.  I do not run these programs so please don't call
  454. me and ask me about it, cause I really don't know.
  455.  
  456. Cdcom will also set dos errorlevel upon exit from the program.  Here
  457. are the values that can be set:
  458.  
  459. ErrorLevel 0 = Normal Logoff.
  460. ErrorLevel 1 = Critical/Fatal Error Occured.
  461. ErrorLevel 2 = User Auto-Logged Off After Download.
  462. ErrorLevel 3 = User Dropped Carrier in Door.
  463. ErrorLevel 4 = Users Time Expired in Door.
  464. ErrorLevel 5 = User denied Access to CdRom Disk or Security Not in Cdcom.sec
  465.  
  466. That should pretty much cover most situations you may want to test for.
  467.  
  468. ===========================================================================
  469.  
  470. VIEWING FILES:
  471.  
  472. CdCom supports AViewCom thru the protocol.bat file.  All parameters
  473. passed are listed in protocol.bat.  These should be sufficent for
  474. most setups.  Note that AViewCom can be told to use callinfo.bbs
  475. for information it needs, however since CdCom does not re-write
  476. callinfo.bbs when shelling to AViewCom the user will get the same
  477. time in AViewCom as when they exited the bbs.  On the command line
  478. however I pass the true time they have left online to AViewCom.  This
  479. would only be undesirable (using callinfo.bbs for Aviewcom) if you
  480. are allowing users to download files from Aviewcom.
  481.  
  482. If AviewCom is having memory problems, it will be noticable when you
  483. try to read or extract files from the zip.  It will say something like
  484. Error Accessing filename.ext.  All you can do is try to free up some
  485. more memory and try it again.
  486.  
  487. Aviewcom is available from His Board as AVIEW54A.ZIP.  This was also
  488. the version cdcom was tested with.  AviewCom's support BBS is
  489. (619) 457-2665, HST.  Any problems with AviewCom should be reported
  490. here.
  491.  
  492. It is recommended that you create a separate directory for Aviewcom
  493. on your hard disk and path it.  Aviewcom knows where it is located
  494. (dos passes it the full path) so it can find all its work files no
  495. matter where you run it from.  This way you can quickly update it
  496. as new versions come out, and the files won't get mixed up with
  497. CdCom files.  I am working with the author of AViewCom to make
  498. sure the two programs run well together.
  499.  
  500. Here is how cdcom handles aviewcom.  Explanation of the commands is
  501. giveb below.
  502.  
  503. aviewcom %2 %3 -t%4 -a%5 -p%6 -e%7 %8
  504. this line locks downloads
  505. rem aviewcom %2 %3 -t%4 -a%5 -p%6 -e%7 -d
  506.  
  507. %2 is the full filename with path
  508. %3 is comport (COM1, COM2, etc or LOCAL)
  509. %4 is time left online, as calculated from program
  510. %5 is ansi on=1, off=0 or choose=2 (program passes 0 or 1 however)
  511. %6 is the path to temp dir, given by line 2 cdcom.def for pcsig version
  512.    of door, or line 9 for the other versions
  513. %7 is the extractor to use
  514. %8 is the connect baudrate (for calculating file xfer times) or -d
  515. %9 is the node number (from callinfo.bbs line 35)
  516.  
  517. The following information was extracted from the aviewcom 5.4a docs.
  518. I also added any other important information about how cdcom may handle
  519. some of these parameters.
  520.  
  521. %3 is either 'com#' or 'local' where # is from 1 to 8
  522.    This is an optional parameter and defaults to local.
  523.    In local mode no transmission is sent to the com port.
  524.  
  525. -t# (%4) # is the number of minutes to be allowed.
  526.  
  527. -a# (%5) 0 = no ANSI.  In this mode, all display is MONO.
  528.          1 = ANSI color.  All display is in ANSI color.
  529.          2 = prompt caller for ANSI color or not (default).
  530.  
  531.  
  532. -ptpath (%6) is an optional parameter and if omitted, defaults
  533.              to the current working directory.  tpath is any
  534.              valid DOS path and specifies a temporary directory
  535.              for the external extractor to use when extracting files.
  536.              A useful tpath is a ramdrive.  The '-p' indicates
  537.              that a DOS pathname follows.
  538.  
  539. -e# (%7)  Used to specify an archiver where # is as follows:
  540.           0        pkarc (.COM or .EXE)
  541.           1        pkpak
  542.           2        pak
  543.           3        arc
  544.           4        pkzip [default]
  545.           5        zoo
  546.           6        lha
  547.           7        arj
  548.  
  549.           If you use code 2, make sure that PAK.CNF is such that
  550.           the archive will not be deleted after extracting it.  The
  551.           specified extractor is also used to create the temporary
  552.           archive which is assigned the name AVIEWnnn.???.
  553.  
  554.  
  555. -r#  (%8)  Define the connection baud rate for file xfer calculations.
  556.            Cdcom will pass either a -rbaudrate or a -d depending on if the
  557.            users security is sufficient for them to download (cdcom.def
  558.            line 5).  If they are allowed to download in cdcom, it will pass
  559.            a -rbaudrate to %8, if not it passes a -d to %8.  If you are
  560.            by default not allowing downloads from aviewcom, then remove
  561.            the %8 parameter and replace it with -d (see above example).
  562.  
  563. -d  disables the download option.  This is included for those
  564.     systems which prefer not to allow downloading.  If not
  565.     included, downloading is enabled and external protocol
  566.     programs must be somewhere in the DOS path.
  567.  
  568. ==============================================================================
  569.  
  570. SECURITY FILE: (optional)  CDCOM.SEC
  571.  
  572. CDCOM.SEC allows you to assign users a certain amount of time total
  573. allowed in the door by security level for the day.  This also
  574. allows you to lock any security levels out of the program.  A users
  575. download to upload ratio can also be controlled here.
  576.  
  577. This feature is not enabled in unregistered versions of the program.
  578.  
  579. The format goes as follows:
  580.  
  581. number of security levels
  582. security,time (in minutes), dl/ul ratio
  583.  
  584. 8
  585. 5,0,1
  586. 10,15,2
  587. 15,25,5
  588. 20,45,10
  589. 50,60,25
  590. 100,90,50
  591. 1000,500,100
  592. 5000,10000,0
  593.  
  594. So here you have 8 security levels, 5 thru 5000.
  595. To lock a security level out simply put a 0 for time allowed.
  596. So in this example security level 5 is locked out, 10 gets 15
  597. minutes, 15 gets 25 minutes, etc.  This value is the maximum
  598. amount of time they will get for the day.  It will compare this time to
  599. the time left that is in callinfo.bbs.  If the time left reported
  600. by callinfo.bbs is greater than the allowed time, they will get
  601. the allowed time.  If the time left reported by callinfo.bbs is less
  602. than the allowed time they will get the time left that is reported
  603. by callinfo.bbs.
  604.  
  605. ex: callinfo.bbs reports 90 minutes left, users security is 10 so
  606.     they get 15 min.
  607. ex: callinfo.bbs reports 25 minutes left, users security is 1000,
  608.     they get 25 min.
  609.  
  610. If you do not have the CDCOM.SEC file installed, then CdCom
  611. will let all securities in, and give them the time left in
  612. callinfo.  However if you use this file then INSURE that
  613. EVERY security level your system uses is accounted
  614. for.  The program will abort if it encounters a security
  615. level not listed in cdcom.sec.
  616.  
  617. Note this is a multi-node file, so you can make it different
  618. for each node if you wish.  Node 1 is cdcom1.sec, node 2 is
  619. cdcom2.sec, etc.  The format and rules are the same however.
  620.  
  621. The time listed in cdcom.sec is the maximum amount of time for the user
  622. in the door for the day.  Even if they raid the timebank (if you run one),
  623. this is all the time they will get total for the day in the door.  Once
  624. the user exits the door their time remaining is written to a file called
  625. CDCOM.TDY.  The value that is written here is the value in cdcom.sec minus
  626. how long they were in the door.  So if they are security level 50 (60 minutes
  627. total in door for day), and are in the door for 10 minutes, a value of 50
  628. minutes will be written to cdcom.tdy.  This once again is the maximum value
  629. they will have for the rest of the day.  If they raid the timebank and take
  630. out 90 minutes, the door will only give them 50 minutes in the door.  Once the
  631. user has entered the door once during the same day, the value in cdcom.sec is
  632. ignored till the next day, and only the value in cdcom.tdy is used.
  633.  
  634. If there is an error in operation in the door or if you had something configured
  635. incorrectly then there is a chance that the time for that user will get
  636. set to 1 minute in this file.  CdCom reads this file on start-up and will
  637. use the time out of here if the date matches up.  To get around this
  638. (the 1 minute problem) just delete this file and start over.  Its not
  639. that big of a deal its only really used for the current day, not for
  640. longtime use.  CDCOM.SEC controls the total time for the day, and cdcom.tdy
  641. keeps track of how much of this time they have used for the current day.
  642.  
  643. The dl/ul ratio level will be checked against this number here everytime
  644. they enter a filename to download.  It is a straight division, the number
  645. of downloads divided by number of uploads.  So if you put 2 here, a user
  646. can still download at 10 downloads/5 uploads, but at 11 downloads/5 uploads
  647. they will be locked.  A zero value (0) here (security 5000 in example) means
  648. no ratio check will take place, this user can download freely until they
  649. run out of time.  I will add DL kilobyte checks later.  If the user has
  650. 0 uploads, then a subtraction is performed (# downloads - # uploads) and
  651. if this result is greater than this number they will be locked.  So a
  652. 2 here will let 2-0 pass, but 3-0 will get locked.
  653.  
  654. =============================================================================
  655.  
  656. MISCELLANEOUS STUFF:
  657.  
  658. CdCom can generate a top 45 downloads report file by running:
  659.  
  660. CDCOM REPORT
  661.  
  662. The file REPORT.TMP is the template that cdcom uses to create this file.
  663. You can change the top 2 lines for your bbs information or whatever.  Cdcom
  664. will write one more line at the bottom of this for totals.  Note that you
  665. can only edit the top 2 lines.  The 3rd line has to be the start of the
  666. report.  I tried to write it so it would fit on one screen.  It will add a
  667. clear screen to the CDCOM.RPT file so don't add one to report.tmp.  Sorry
  668. no ansi output, I just don't have the time to mess with it right now.
  669.  
  670. This feature is not enabled in the unregistered version.
  671.  
  672. =============================================================================
  673.  
  674. CDCOM WORK FILES:
  675. -----------------
  676.  
  677. Here is some supplemental information on the cdcom work files, in case you
  678. are interested.  Some of these can be changed, others not at all.
  679.  
  680. CDCOM.CAT
  681. ---------
  682. This file has all the categories and their select codes in it.  It is used
  683. for the <L>ist files by category function.  Its format goes as follows
  684.  
  685. number of categories
  686. select code,category name
  687.  
  688. ex:
  689.  
  690. 3
  691. 001,Communications
  692. 002,Games
  693. 003,Programming Utilities
  694.  
  695. You can modify this file if you like.  To remove a category, simply remove
  696. the line from this file, and decrement the number of categories by 1.  Ex:
  697.  
  698. 2
  699. 001,Communications
  700. 002,Games
  701.  
  702. gets rid of 003, Programming Utilities.  If the user selects category 3
  703. they will be told it does not exist.  Note that the 003 select code is for
  704. matching up in the description file.  A user at the category prompt can
  705. enter a 3 instead of an 003, cdcom can handle it either way.  The entry
  706. in cdcom.cat must have all leading 0's though.
  707.  
  708. CDCOM.PTH
  709. ---------
  710. You cannot modify this file.  This file is used by cdcom to locate the
  711. files on the cdrom disk.  But FYI, its format goes as follows:
  712.  
  713. number of paths
  714. path on cdrom disk
  715.  
  716. Cdcom automatically adds the drive letter from cdcom.def and the trailing
  717. backslash (\).  The top blank line is for the root directory entry.
  718. Location of the path is important also, so don't move them around.
  719.  
  720. CDCOM.XRF
  721. ---------
  722. This file has in it every file that is on the cdrom disk.  It contains the
  723. following information: filename, filesize, location on cdrom disk, location
  724. of description in master description file, and the number of times
  725. downloaded.  I may add the file date later on so there will be a new files
  726. by date on the main menu, as some people have requested this.  Cdcom.xrf
  727. is in a basic language random file format, which goes as follows:
  728.  
  729. 12 as filename$, 4 as filesize$, 1 as disk.location$, 2 as number.dl$,
  730. 2 as desc.location$       - Record size: 21 bytes
  731.  
  732. The disk location points into the cdcom.pth file.  If you program in basic
  733. then you can access this file quite easily using the format shown above.
  734. Dividing the size of cdcom.xrf by the record size yields how many files
  735. are on the cdrom disk.
  736.  
  737. CdCom was written with Spectra Publishings PowerBasic compiler (previously
  738. Borlands Turbo Basic).
  739.  
  740. CDCOM.USR
  741. ---------
  742. This file keeps track of the number of downloads the user has done in
  743. the door, as well as the number of download kilobytes.  This is mostly
  744. for your record keeping, so you can use this file to update your user
  745. records later on since record updating is not done by the door.  The
  746. format goes as follows:
  747.  
  748. # of lines in cdcom.usr
  749. user name, # of downloads, # of download KB
  750.  
  751. ex:
  752.  2
  753. Eric Schonning,2,260
  754. Bob Harris,3,400
  755.  
  756. shows 2 users, one with 2 downloads totaling 260 kb and the other with
  757. 3 downloads totaling 400 kb.
  758.  
  759. Note that these numbers do not take into account the number of downloads/
  760. download kilobytes passed via callinfo.bbs.  These numbers are only
  761. the stats that the user has accumulated in the door.
  762.  
  763. If you use this file to update a users records, then either zero out their
  764. numbers or delete the file when done.  A new one will be created if
  765. one is not found.  If you remove a line here, make sure you decrement the
  766. first line, the number of lines, or the door will crash.
  767.  
  768. On registered versions, this file is read in on startup and the number
  769. of downloads the user has in it are added to the number of downloads found
  770. in callinfo.bbs for ratio checking.
  771.  
  772. This file will be used later on when Wildcat 3.0 record updating is added
  773. (if that is necessary, since wildcat now supports cdroms internally.
  774. However if there is enough interest I will add it).
  775.  
  776. =============================================================================
  777.  
  778. OTHER IMPORTANT INFO:
  779. ---------------------
  780.  
  781. Although this program has been extensively tested bugs may
  782. still exist.  The author assumes no responsibility for any
  783. damages to hardware or data that may be incurred from running
  784. this program.  By running this program you the user assume full
  785. responsibility for any damages that may occur.
  786.  
  787. This program now requires a registration fee.  Registration will fully enable
  788. all features of the door.  See REGISTER.DOC for registration info.  This is
  789. a one time registration fee, the same code will work for any other version
  790. of the door.  However if you are running multiple copies of the door with
  791. other disks, a $10 or so donation should be sent in, especially if you would
  792. like to see updates to the program.  While I fully plan on supporting the
  793. program as long as I am able, I also need to be able to justify such support.
  794. Registrations and donations help immensely with such justification.
  795.  
  796. Bug fixes and future upgrades are always available on the support BBS's at
  797. no charge. The bug fix, if not major, will be called CDCOMFIX.ZIP.
  798. This will usually just be a CDCOM.EXE update.
  799.  
  800. Any major fixes will be posted as CDCOM.ZIP.  Best bet is to just
  801. view the CDCOM.ZIP file anytime you logon and see if the CDCOM.EXE
  802. file has a later date than the one you have.
  803.  
  804. If you cannot seem to get a new disk working with the door, then feel
  805. free to give me a call at home and we can work it out.
  806.  
  807. CdCom is only a door for the shareware software type of disks.
  808. It is not intended for encyclopedias, viewing graphics, etc.  Its main
  809. purpose is to:
  810.  
  811. 1) Allow downloading & viewing files from the cdrom disk.
  812.  
  813. 2) Allow reading, searching, listing by category any description listings
  814. for the disk.
  815.  
  816. 3) Keep track of users time in the door, and other basic functions.
  817.  
  818. If this is the type of disk you have, then here is where to contact me.
  819.  
  820. My address is:   Eric Schonning
  821.                  5281 Creekside Road
  822.                  Camarillo, CA. 93012-5419   USA
  823.                  Voice # (805) 987-2110
  824.  
  825. If you call my voice number please be courteous about the time you call.
  826. I am on pacific time, and do sometimes keep long hours, but not always
  827. during the week.  Please keep this in mind if you decide to call.
  828.  
  829. A side note:  working on this door is about 4th on my list of priorities.
  830. I do not do this for a living (a foolish idea no doubt).  I do not run a
  831. business, so I cannot write my expenses off.  So if you need technical
  832. help or just want to talk about the door, here are some things you
  833. must realize.
  834.  
  835. 1)  If you call me and leave a message on my machine, and want me to
  836. call you back, I will only call you collect.  The hours I am at the
  837. house vary from day to day, however evening Pacific time is always
  838. a good time to get ahold of me.  If you leave a number for me to call,
  839. please try to let someone know I may be calling, or leave a number where
  840. it is more likely I will get ahold of you.
  841.  
  842. 2)  I will call your bbs and help you set up the door if you require
  843. it.  However before you ask me to do this be fully ready to recompensate
  844. me for my phone bill.  I do not at this time require pre-payment of my
  845. phone bill (a deposit), however if I get stiffed any more phone bills
  846. I will undoubtably do so.
  847.  
  848. 3) I cannot at this time accept credit card orders for registrations.
  849. I am looking into doing so however, and if you want to do it this way
  850. then contact me.  I would still like to recieve the completed
  851. REGISTER.DOC form from you so that I have this information on hand, as I
  852. am compiling a database, and this will allow me to contact you in case
  853. of problems or notify you of updates.  I do accept personal check's
  854. accompanied by the completed register.doc form for registration.  You
  855. do not have to obtain a money order.
  856.  
  857. The support BBS's are:
  858.  
  859. HIS Board              (805) 652-1478  1200/2400/9600 HST 14.4k
  860.        or              (805) 659-4323  12/24
  861. 805 - SysOps BBS       (805) 659-3313  12/24/9600 14.4k DS
  862. Advanced Electronic
  863. Technologies BBS       (704) 545-7076  12/24/9600 DS
  864.  
  865. I try to logon to His Board everyday.  I am also on the Fidonet CDROM
  866. conference if you want to contact me there.  I do not frequent the
  867. other support bbs's that much.
  868.  
  869. The AET BBS is running 2 nodes under DesqView and runs Wildcat.  It is
  870. running 4 cdrom drives.
  871.  
  872. ===========================================================================
  873.  
  874. ACKNOWLEDGEMENTS:
  875. -----------------
  876.  
  877. First, I would like to thank the Lord Jesus Christ for saving my rotten,
  878. undeserving soul and for giving me the ability to be able to write computer
  879. programs such as CdCom.
  880.  
  881. I also want to thank all those who have supported me over the years and
  882. gave me encouragement, ideas for the program and gifts of hardware or
  883. cdrom disks.  There are so many names and I can't remember them all,
  884. so I won't go into details here.
  885.  
  886. ===========================================================================
  887.  
  888. Sample Wildcat CALLINFO.BBS
  889. ---------------------------
  890.  
  891. * = Used By CdCom, ? = Used but not required
  892.  
  893. Callinfo.bbs file      Line Number) Description
  894. -----------------      ------------------------
  895. Eric Schonning      *   1) User Full Name
  896. 3                   *   2) Connect Baud Rate  (0=2400,1=300,2=1200,3=9600
  897.                           4=19200, 5=LOCAL).  This is the modem connect rate.
  898. Camarillo, CA           3) Calling From
  899. 1000                *   4) Security
  900. 177                 *   5) Logon Time Left
  901. MONO                ?   6) COLOR or MONO  (for Ansi)
  902. Password                7) Password
  903. 4                   ?   8) User Record Number
  904. 4                       9) Minutes On System Before Shell
  905. 15:00                  10) Time Entered Shell
  906. 14:56                  11) BBS Logon Time
  907. ABCDEFHGYZ             12) Conferences Joined
  908. 0                      13) Daily Downloaded Files Total
  909. 9999                   14) Max Daily Download Limit
  910. 0                      15) Daily Download K Total
  911. 9766                   16) Max Download K Limit
  912. 805-652-1478           17) Phone Number
  913. 12/03/88 14:56         18) Time/Date Last Call
  914. NOVICE                 19) NOVICE or EXPERT Menu mode
  915. All                    20) Default File Xfer Protocol
  916. 12/03/88               21) Last New File Search
  917. 58                     22) Total Times On
  918. 23                     23) Lines Per Page
  919. 71                     24) Last Message Read
  920. 9                   ?  25) Total Uploads
  921. 1                   ?  26) Total Downloads
  922. 8  { Databits }     ?  27) 7 or 8 Databits
  923. REMOTE              *  28) Either LOCAL or REMOTE
  924. COM1                *  29) Com Port Being Used
  925. 11/16/62               30) Date of Birth
  926. 38400               ?  31) Port rate (text).  If port is locked this will
  927.                            be the locked speed.
  928. AlreadyConnected       32) Not sure exactly what this is
  929. Normal Connection      33) Either MNP/ARQ Connection or Normal Connection
  930. 12/04/88 19:45         34) Current Date Time
  931. 1                   ?  35) Node Number
  932. 4                      36) Door Number
  933.  
  934. Earlier versions of wildcat don't have lines 34 - 36.  Cdcom will use the
  935. node number for true multi-node support but it is not needed to run the
  936. program.
  937.  
  938. You do not need to have information on the unused lines.  I have just
  939. included them for indentification purposes.  Some of the other info may
  940. be used in future versions.  If you don't include them insure that there
  941. is at least a blank line there.  This example undoubtably does not exactly
  942. match what callinfo.bbs looks like for all versions of wildcat for the
  943. items on the unused lines, as it does change slightly from version to
  944. version of Wildcat.
  945.  
  946. Note that the security must be a numeric value.  Some bbs software
  947. allow you to use letters, CdCom will not work with such a setup.
  948.  
  949. Line 27 for number of databits will tell cdcom whether or not to strip
  950. the high bit from com input.  If your users are calling in with 7 databits
  951. then make sure your conversion program writes something here, otherwise
  952. cdcom will not recognize their input.  They can change to 8 databits
  953. while online however and it will then accept input from them.  CdCom
  954. only looks at the numeric value here not the rest of the line.
  955.  
  956. There is a Phoenix R.C.S. to Wildcat conversion available.
  957. You must be running at least version 1.3 or greater of
  958. Phoenix to use this program.  Most door information conversion
  959. programs do not produce a sufficient callinfo.bbs for Phoenix bbs
  960. as they must read users.bbs to obtain most of the information about
  961. the user that cdcom needs.
  962.  
  963. <The End>
  964.