home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / ROMPR134.ZIP / ROMPROC.DOC < prev    next >
Text File  |  1993-09-18  |  32KB  |  663 lines

  1.  
  2.     ┌────┐
  3.     │──═─│
  4.     │ ── │ ─────┐      ┌────┐             ROMProc Documentation Fil
  5.     │    │   ROMProc   │──═─│                    Version 1.34
  6.     │    │      └────> │ ── │          (c) Copyright 1993 - Stacy Smith
  7.     │    │             │    │
  8.     │    │             │    │
  9.    ─┴────┴─           ─┴────┴─
  10.  
  11.  
  12.                                 Courtesy of:
  13.  
  14.                         The Bloom Beacon-Picayune BBS
  15.           Node 1: (919) 557-3845 (USRobotics Courier Dual Standard)
  16.              Node 2: (919) 557-0645 (USRobotics Courier V.32bis)
  17.              Node 3: (919) 557-0745 (USRobotics Courier V.32bis)
  18.                              FidoNet 1:151/106
  19.                                   Intelec
  20.                              RoseNet (ID: BB-P)
  21.                                  CompuLink
  22.  
  23.                                 Stacy Smith
  24.                             305 Cottonwood Lane
  25.                           Holly Springs, NC 27540
  26.  
  27.  
  28. ┌────────────────────┐
  29. │  1. Introduction:  │
  30. └────────────────────┘
  31.  
  32. ROMProc is a BBS download file preprocessor designed to make optimal use of
  33. CD-ROM and/or LAN BBS setups by copying the desired file(s) from the source
  34. drive into a work directory, commenting them, transferring them to the remote
  35. user with the desired protocol and cleaning up. ROMProc is different from other
  36. programs in which it performs all these functions automatically from a single
  37. program command line.
  38.  
  39. By commenting files just prior to download, rather than commenting them when
  40. posted, you can save disk space and your files will always have up-to-date
  41. comments inserted. By stripping the comments from 200 megs of ZIP files on my
  42. system, I regained about 2 megs of disk space!
  43.  
  44. ROMProc was developed primarily because I didn't like the current crop of
  45. CD-ROM and server file handlers. They were either complicated to install,
  46. didn't perform as desired, were designed as doors, memory hogs, ridiculously
  47. expensive or crippled.
  48.  
  49.  
  50. ┌───────────────────────────┐
  51. │  2. Features of ROMProc:  │
  52. └───────────────────────────┘
  53.  
  54.       ∙ Handles the complete download process from a single command-line.
  55.       ∙ Functions with any protocol, including single, batch and bi-directional
  56.         protocols.
  57.       ∙ May be installed in your BBS software as a batch file or a direct
  58.         command-line.
  59.       ∙ Automatically identifies ARC, ARJ, HYP, LZH, PAK, SQZ, ZIP and ZOO
  60.         files, regardless of their file extensions (ideal for software
  61.         distribution networks, like .SDN files), allowing commenting of these
  62.         archivers that support archive comments (not all do).
  63.       ∙ Automatically identifies ARJ, LZH, PAK, SQZ and ZIP self-extracting
  64.         (SFX) archives.
  65.       ∙ Comments all files prior to downloading, if desired.
  66.       ∙ May be configured to insert a BBS ad file to the archives (ugh).
  67.       ∙ Fully multinode compatible.
  68.       ∙ Organizes the processing order to ensure sequential drive access.
  69.       ∙ Locks slow drives to prevent drive thrashing due to multiple node
  70.         accesses to the same physical drive.
  71.       ∙ Outputs sysop-configurable prompts to the user for indication of
  72.         process status. ROMProc supports IRQs 2-7 with any base address as well
  73.         as FOSSIL drivers.
  74.       ∙ Windowed full-screen interface.
  75.       ∙ User-selectable disk error logging.
  76.       ∙ Not crippled.
  77.       ∙ Returns the errorlevel of the transfer protocol, making ROMProc
  78.         completely transparent to the BBS software.
  79.       ∙ Written completely in C for optimal speed, using Borland C++ 3.1.
  80.       ∙ Lifetime registration; pay ONCE and your registration number will work
  81.         on all future versions!
  82.  
  83.  
  84. ┌─────────────────────────────────────────────────────────┐
  85. │  3. Files Included in the ROMProc Distribution Archive  │
  86. └─────────────────────────────────────────────────────────┘
  87.  
  88.         ROMPROC.EXE     CD-ROM Download File Processor program
  89.         ROMPROC.CFG     Sample configuration file
  90.         ROMPROC.DOC     This file
  91.         HISTORY.TXT     ROMProc revision history in reverse order
  92.         REGISTER.FRM    Registration form for ROMProc
  93.         COMMENT.TXT     Sample comment file for inclusion in archives
  94.         FILE_ID.DIZ     Internal description file
  95.  
  96. When you unzip the distribution archive, you should see my PKZIP authenticity
  97. verification stamp, and a '-AV' after every file in the archive:
  98.  
  99.         # SSU301    The Bloom Beacon-Picayune BBS
  100.  
  101. If there are any files missing or added, or the -AV stamp is missing, the
  102. archive has been tampered with. It would be advisable to call my BBS (listed at
  103. the top of this document) for the latest version of ROMProc.
  104.  
  105.  
  106. ┌───────────────────────────┐
  107. │  4. Program Requirements  │
  108. └───────────────────────────┘
  109.  
  110. To the best of my knowledge, ROMProc will run on most any machine capable of
  111. running a BBS package. My BBS setup is PCBoard 15.0/10 beta running under
  112. DESQview on a LANtastic 5.00 network with 1 hard drive and 2 CD-ROMs, but other
  113. sysops that I have been in contact with have successfully implemented ROMProc
  114. on a wide variety of hardware.
  115.  
  116. ROMProc requires DOS 3.x or later, as it uses DOS SHARE-compatible file reads
  117. and writes.  ROMProc's memory requirements are very small (about 80K, plus
  118. whatever memory is required to invoke the transfer protocols), therefore it can
  119. be run in very low memory situations.
  120.  
  121. ROMProc has been developed and tested using the following archiving and
  122. transfer protocols:
  123.  
  124.         ARJ 2.10 through 2.41 (by Robert Jung)
  125.         LHA 2.13 (by Haruyasu Yoshizaki)
  126.         PKZIP 1.10 through 2.04g (by PKWare)
  127.         SQZ 1.08.2 (by Jonas Hammarberg)
  128.         DSZ [various dates] (by Omen Technology)
  129.         HS/Link 1.12 through 1.21B6 (by Sam Smith)
  130.  
  131.  
  132. ┌───────────────────┐
  133. │  5. Registration  │
  134. └───────────────────┘
  135.  
  136. ROMProc is not free; nor is ROMProc is crippled to force registration. ROMProc
  137. is fully functional, and will always remain so. The only variation with the
  138. registered copies is no time delay and beg message, and unregistered copies
  139. display the following to the user online at the beginning of execution:
  140.  
  141.         [ ROMProc 1.32 - Unregistered ]
  142.  
  143. Why register? Besides a clean conscience, you will get a registration code that
  144. will work for all future versions of ROMProc, and will remove the delay and
  145. message displayed upon closing the door.
  146.  
  147. The registration fee for your unique code is $10 for non-commercial BBSs (not
  148. too bad, eh?). The registration fee for commercial BBSs, defined if you run
  149. your BBS in the course of a commercial business or for profit, is $20. Other
  150. variations are available; refer to the file REGISTER.FRM for all registration
  151. options. Please print the file REGISTER.FRM and fill it out. You can print out
  152. the form by issuing the following command from the DOS prompt:
  153.  
  154.         TYPE REGISTER.FRM > PRN
  155.  
  156.  
  157. ┌───────────────────────────────────────┐
  158. │  6. License, Warranty and Disclaimer  │
  159. └───────────────────────────────────────┘
  160.  
  161. I'll keep this part short and sweet, and dispense with the legal-ese:
  162.  
  163.         License: You are allowed to use ROMProc for 30 days, after which you
  164.            must either register ROMProc or stop using it completely. ROMProc
  165.            registration is a license for your use of ROMProc; I retain
  166.            ownership of the software. A single registration applies to a single
  167.            BBS system, regardless of the number of computers used in the
  168.            system. If you run two or more distinct BBS systems on the same
  169.            computer(s) (with different names), you require two or more ROMProc
  170.            registrations. Refer to the registration form for the currect
  171.            pricing structure.
  172.  
  173.         Warranty: There isn't one. The only thing I'll guarantee is that
  174.            ROMProc will take up disk space, and will disappear when deleted.
  175.  
  176.         Disclaimer: I'm not responsible for anything bad that happens. ROMProc
  177.            works here, but I cannot be held responsible for it not working on
  178.            your computer or doing any damage to hardware or software.
  179.  
  180. If these aren't agreeable with you, then the best thing to do is delete ROMProc
  181. right now. I'll do my best to help any user (registered or not) that wants to
  182. use ROMProc, and I'll act on bug reports quickly, but I simply cannot and will
  183. not be responsible for anything bad, like lost data, disk crashes, or whatever
  184. else you can think of.
  185.  
  186.  
  187. ┌───────────────────┐
  188. │  7. Installation  │
  189. └───────────────────┘
  190.  
  191. GENERAL INSTALLATION:
  192. ─────────────────────
  193. Make a subdirectory on your hard drive. For the purposes of this document,
  194. we'll call it "C:\ROMPROC". Unarchive the ROMProc distribution archive into
  195. this subdirectory. You've more than likely already made it this far, if you're
  196. reading this file. <grin>
  197.  
  198. The ROMProc system opens a few files simultaneously for various reasons. I
  199. would recommend that you have a minimum of FILES=30 per node in your system
  200. CONFIG.SYS file for a single-node system, since ROMProc is run in conjunction
  201. with your BBS software.
  202.  
  203. If you are running under a network or a multitasking operating system, you
  204. should already have DOS's SHARE.EXE loaded. You must have SHARE loaded in order
  205. to take advantage of the file sharing and locking methods used by the ROMProc
  206. program to prevent data loss. (If you are running a single-node system without
  207. a multitasker, SHARE is not needed).
  208.  
  209. Edit the configuration file to suit your needs. Proper configuration will
  210. require you to refer to this section, the previous section and the section
  211. titled "Configuration", which has an in-depth explanation of each configuration
  212. parameter and its function.
  213.  
  214. Note that for the ROMProc program, you can obtain a limited program syntax
  215. screen simply by executing the program name "ROMPROC".
  216.  
  217. GENERIC INSTALLATION INTO YOUR BBS SOFTWARE:
  218. ────────────────────────────────────────────
  219. The premise behind ROMProc is that instead of invoking your transfer protocol
  220. as usual when sending files to remote, you invoke ROMProc instead. ROMProc will
  221. copy all files the remote user requested, process them as configured and invoke
  222. the desired protocol. Note that only the sending (remote download) protocol is
  223. changed; the receiving (remote upload) procotol is not changed. Upon completion
  224. of the transfer, ROMProc will return the errorlevel returned by the protocol,
  225. ensuring ROMProc's transparency to the BBS software.
  226.  
  227. ROMProc must be run from the BBS node subdirectory; this is required to prevent
  228. conflicts when multiple copies of ROMProc are run simultaneously. At the bare
  229. minimum, three command-line parameters are required for ROMProc:
  230.  
  231.     c:\romproc\romproc -Cc:\romproc\romproc.cfg -Ffile.ext -Tz
  232.  
  233. where -C defines the full path and filename of the configuration file for
  234. ROMProc and -F is the complete path and filename of the file (or batch list
  235. file) to be sent to remote; this parameter is almost always passed by the BBS
  236. software. Also, the required -T parameter defines to ROMProc which protocol to
  237. invoke by letter.
  238.  
  239. When run in a multinode environment, you must also pass the BBS node number
  240. (via the -N command-line switch) to prevent collisions during simultaneous
  241. downloads (if no node number is defined, 0 is used by default):
  242.  
  243.     c:\romproc\romproc -Cc:\romproc\romproc.cfg -Ffile.ext -Tz -N2
  244.  
  245. In many installations, the node number is or can be defined as an environment
  246. variable. For example, PCBoard sysops use the environment variable PCBNODE to
  247. use in batch files for external utilities.
  248.  
  249.     c:\romproc\romproc -Cc:\romproc\romproc.cfg -Ffile.ext -Tz -N%PCBNODE%
  250.  
  251. All BBS software passes the port number and computer-to-modem speed (DTE), and
  252. many also pass modem-to-modem carrier speed (DCE). These are passed on to
  253. ROMProc via the -P, -S and -E command-line switches, respectively. BBS software
  254. that supports bi-directional protocols will also pass the upload directory for
  255. the protocol to place any unexpected uploads from remote. This is passed to
  256. ROMProc using the -U command-line switch.
  257.  
  258. * NOTE: In order for ROMProc to send status information to the online user, you
  259.         MUST define the -P and -S parameters for direct I/O, or the -X
  260.         parameter for FOSSIL I/O. (For direct I/O, the -P may be omitted from
  261.         the command line in favor of the DSZPORT environment variable).
  262.  
  263. * NOTE: If you are using a non-standard COM port for direct I/O, define the COM
  264.         port IRQ and base address on the command line. For example, if COM3 (a
  265.         non-standard port for IBM PCs) is used with 3e8 is the base address and
  266.         5 is the assigned IRQ, the -P parameter would be "-P3e8,5" (no quotes).
  267.  
  268. * NOTE: For FOSSIL I/O implementations, the FOSSIL port parameter (-X) must be
  269.         specified instead of the COM port parameter (-P).
  270.  
  271. Most of the switches are self-explanatory. To be safe, if your BBS system
  272. is capable of passing a parameter, pass it on to ROMProc using the appropriate
  273. command-line switch. It can't hurt...
  274.  
  275. PCBOARD INSTALLATION:
  276. ─────────────────────
  277. Installation in PCBoard is very easy. PCBoard uses two batch files for each
  278. protocol, named PCBR?.BAT and PCBS?.BAT, where ? is the protocol letter. The
  279. PCBR?.BAT (receive) batch files do not need to be changed for ROMProc, however,
  280. the PCBS?.BAT batch file does. Below are sample Zmodem and HS/Link send (and
  281. receive, for reference) batch files from my multinode system:
  282.  
  283. PCBSZ.BAT:
  284. @Echo off
  285. if exist pcberr.fil del pcberr.fil
  286. if exist pcbdsz.log del pcbdsz.log
  287. c:\romproc\romproc -Cc:\romproc\romproc.cfg -Tz -N%PCBNODE% -F%3 -P%1 -S%2 -E%5
  288.  
  289. PCBRZ.BAT:
  290. @Echo off
  291. if exist pcberr.fil del pcberr.fil
  292. if exist pcbdsz.log del pcbdsz.log
  293. dsz port %1 speed %2 ha cts est 0 %5 pB4096 pr1 rz %3
  294.  
  295. PCBSH.BAT:
  296. @Echo off
  297. if exist pcberr.fil del pcberr.fil
  298. if exist pcbdsz.log del pcbdsz.log
  299. c:\romproc\romproc -Cc:\romproc\romproc.cfg -Th -N%PCBNODE% -F%3 -P%1 -S%2 -E%5
  300.     -U%6
  301.  
  302. PCBRH.BAT:
  303. @Echo off
  304. if exist pcberr.fil del pcberr.fil
  305. if exist pcbdsz.log del pcbdsz.log
  306. hslink -b%2 -p%1 -e%5 -u%6 -noc:\pcb\gen\dlpath.lst
  307.  
  308.  
  309. With the exception of the -T parameter, all of your PCBS?.BAT files should be
  310. identical; change the -T parameter to reflect the appropriate protocol letter.
  311. For bi-directional protocols, such as HS/Link and BiModem, add the -U%6 command
  312. switch.
  313.  
  314. If you wish full implementation of ROMProc, all protocols have to be shelled
  315. instead of using the internal Xmodem and Ymodem protocols. Fortunately, DSZ is
  316. capable of all variations of Xmodem and Ymodem as well as Zmodem. The following
  317. is a screen snapshot of my PCBPROT.DAT file from PCBSETUP, with all protocols
  318. running through ROMProc:
  319.  
  320.                        Port Lock
  321.      Use Type Size MNP Open Lines             Protocol Description
  322.      ═══ ════ ════ ═══ ════ ═════ ═══════════════════════════════════════
  323.       A   I    128  N   N     N   ASCII (text files only)
  324.       X   S    128  N   N     Y   Xmodem
  325.       C   S    128  N   N     Y   Xmodem-CRC
  326.       O   S   1024  N   N     Y   1K-Xmodem
  327.       F   S   1024  Y   N     Y   1K-Xmodem/G
  328.       Y   D   1024  N   N     Y   Ymodem    [Batch]
  329.       G   D   1024  Y   N     Y   Ymodem/G  [Batch]
  330.       Z   D   1024  N   N     Y   Zmodem    [Batch]
  331.       M   D   1024  N   N     Y   Zmodem MobyTurbo  [Batch]
  332.       H   B   2048  N   N     Y   HS/Link (bi-directional)  [Batch]
  333.       N   I      0  N   N     N   None (ask each transfer)
  334.  
  335. Note the type for the Xmodem and Ymodem transfer protocols is now (S)helled or
  336. (D)SZLOG batch, instead of (I)nternal.
  337.  
  338. OTHER BBS INSTALLATION:
  339. ───────────────────────
  340.  
  341. * NOTE: As my BBS is PCBoard, I have written the PCBoard-specific instructions.
  342.         I would greatly appreciate some feedback from other BBS software users
  343.         regarding ROMProc installation specifics.
  344.  
  345. APPLICATION NOTES:
  346. ──────────────────
  347. PKZIP:
  348.     PKZIP 2.04 uses direct-video output by default that will make the
  349.     processing window look rather ugly when executed. To remedy this, set the
  350.     PKNOFASTCHAR environment variable which will revert PKZIP 2.04 to the older
  351.     1.10-style video output. (It doesn't matter what your set the variable to,
  352.     PKZIP just looks for its existence).
  353.  
  354. SQZ:
  355.     SQZ also uses direct-video output, but unlike PKZIP 2.04, it cannot be
  356.     defeated. The processing window may look odd, but rest assured it is
  357.     operating correctly.
  358.  
  359. DSZ:
  360.     In many cases, the use of DSZPORT environment variable is more desirable
  361.     than passing the COM port information. This allows easier definition of
  362.     non-standard COM ports addresses. For example, if you are using COM2 for a
  363.     BBS node, add:
  364.  
  365.             SET DSZPORT=2
  366.  
  367.     to your node batch file. If you are running a non-standard COM port, define
  368.     the base address and IRQ on the command line. For example, if COM3 (a
  369.     non-standard port for IBM PCs) is used with 3e8 is the base address and 5
  370.     is the assigned IRQ, the setting would be:
  371.  
  372.             SET DSZPORT=3e8,5
  373.  
  374.     If you elect to use the DSZPORT environment variable, it is no longer
  375.     necessary to pass the -P command-line switch or to add the "port @PORT@"
  376.     parameter to the DSZ command lines for Xmodem, Ymodem, and Zmodem transfers
  377.     in the ROMProc configuration file.
  378.  
  379.     In addition, ROMProc will search the environment for the DSZPORT variable
  380.     and use it for the com port definitions for it's user status output.
  381.  
  382. HS/Link:
  383.     The HS/Link command-line can include the -NF switch to turn off HS/Link's
  384.     full-screen display, allowing it to run in ROMProc's transfer protocol
  385.     window. Otherwise, ROMProc's local display will be overwritten by HS/Link's
  386.     display.
  387.  
  388.  
  389. ┌────────────────────┐
  390. │  8. Configuration  │
  391. └────────────────────┘
  392.  
  393. The sample configuration file included in the distribution archive is heavily
  394. commented, but some additional information is provided below:
  395.  
  396. GENERAL PARAMETERS:
  397. ───────────────────
  398. REG_CODE
  399.     The registration code EXACTLY as provided to you on your registration
  400.     letter. If this is an unregistered version, comment out this line. Note
  401.     that this is case-sensitive, as the serial number, BBS name and sysop name
  402.     are all encrypted into this code.
  403.  
  404. BBS_NAME
  405.     The BBS name EXACTLY as provided to you on your registration letter. If
  406.     this is an unregistered version, comment out this lines. Note that this is
  407.     case-sensitive!
  408.  
  409. SYSOP_NAME
  410.     The sysop name EXACTLY as provided to you on your registration letter. If
  411.     this is an unregistered version, comment out this line. You get the picture
  412.     by now...
  413.  
  414. WORK_DIR
  415.     The full path for the specific subdirectory for ROMProc to store file(s) to
  416.     be downloaded. This must include the trailing backslash (ROMProc will add
  417.     it if necessary)! If this directory does not exist at runtime, ROMProc will
  418.     attempt to create it. This can be set to a RAM disk for greater speed,
  419.     since ROMProc will detect an out of disk space condition and allow the
  420.     download to continue from the original file. An environment variable may
  421.     also be entered using the standard %VARIABLE% notation DOS uses; note that
  422.     the environment variable definition must adhere to the same requirements as
  423.     specifying a work directory. For example, the following are both valid:
  424.         WORK_DIR c:\work\
  425.         WORK_DIR %TEMP%
  426.     where %TEMP% is defined as "c:\work\" in your AUTOEXEC.BAT file.
  427.  
  428. DISK_BUFFER
  429.     The size of the disk I/O buffer you wish to allocate in bytes (valid values
  430.     are between 2048 bytes and 16384 bytes). Optimal performance is obtained
  431.     with a value that is a multiple of 2048 bytes, since this is the size of a
  432.     typical hard disk cluster. 4096 seems to be a good number for me, although
  433.     a larger size will improve performance somewhat. If you find yourself
  434.     running out of memory when executing archivers or protocols, reduce this
  435.     number to increase your available memory. If no value is specified, the
  436.     disk buffer will default to 4096 bytes.
  437.  
  438. LOG_FILE
  439.     The complete path and filename of the log file for ROMProc to record
  440.     errors. Comment the line out if you don't want any disk error logging.
  441.  
  442. LOCK_LINES
  443.     If you want ROMProc to preserve two lines at the top or bottom of the local
  444.     display, enter TOP or BOTTOM as desired, otherwise, enter NONE or comment
  445.     the line out.
  446.  
  447. BBS_AD_FILE
  448.     The directory path and filename for your BBS ad to be inserted into each
  449.     and every archive processed by ROMProc. Note that you must provide a path,
  450.     or it will not be copied. I STRONGLY recommend against them; BBS ads are
  451.     aggravating to other sysops, so please be considerate and use the archive
  452.     comment instead. BBS ad files are the scourge of the BBS world. This
  453.     parameter is commented out by default.
  454.  
  455. COMMENT_ARC
  456.     If you want ROMProc to comment archives (if supported by the archive
  457.     format) enter YES. If not, enter NO or comment the line out. This is much
  458.     more desirable than inserting BBS ads.
  459.  
  460. DRIVE PROCESSING DEFINITIONS:
  461. ─────────────────────────────
  462. PROC_DRIVE
  463.     Specify the drive letters for file preprocessing (BBS ad insertion and/or
  464.     commenting). Any file requested from a non-specified drive will still be
  465.     tranmitted (unmodified) from the original location. This allows
  466.     preprocessing of certain drives (e.g. CD-ROMs), but not all. Drives may be
  467.     specified in ranges, seperated by a hyphen, and/or individual drives may be
  468.     seperated by spaces, commas or semi-colons. The following examples are all
  469.     valid, and will select drives letters C through J:
  470.         PROC_DRIVE C-J
  471.         PROC_DRIVE C D E F G H I J
  472.         PROC_DRIVE C-F G H-J
  473.         PROC_DRIVE C-F,G-I,J
  474.  
  475. LOCK_DRIVE
  476.     Specify the drive letters for locking, by entering the individual drives to
  477.     be locked, one physical drive per line. Ranges may be seperated by a
  478.     hyphen, and/or individual drives may be seperated by spaces, commas or
  479.     semi-colons. Note that you normally lock by physical drive; if you have
  480.     multiple logical drives per physical drive (e.g. a partitioned hard disk or
  481.     CD-ROM changer), list all the logical drive letters on the same LOCK_DRIVE
  482.     command line. Each LOCK_DRIVE line constitutes a single drive unit as far
  483.     as ROMProc is concerned. It is not required that all drives defined to be
  484.     processed be locked. In this example, drive D will be locked if accessed by
  485.     ROMProc and drives E-J will be locked if ROMProc accesses any drive from E
  486.     to J.
  487.         LOCK_DRIVE D
  488.         LOCK_DRIVE E-J
  489.  
  490. DELAY_TIME
  491.     This is the amount of time (in seconds) that ROMProc will wait for a drive
  492.     to unlock before displaying the text indicated by DELAY_PROMPT. I would
  493.     recommend a value of 5 to 10 seconds. If commented out, ROMProc will
  494.     default to 5 seconds.
  495.  
  496. ABORT_TIME
  497.     This is the amount of time (in seconds) that ROMProc will wait for a drive
  498.     to unlock. If this time is exceeded, ROMProc will abort the transfer. I
  499.     suggest that at least 10 seconds be given, more if you are using CD-ROM
  500.     changers and/or slow networks. If commented out, it will default to 30
  501.     seconds.
  502.  
  503. COMMUNICATION DEFINITIONS:
  504. ──────────────────────────
  505. COMM_IO
  506.     If you want ROMProc to output status information to the user on-line, enter
  507.     YES; if you do not want ROMProc to output information, enter NO or comment
  508.     the line out. Note that the -P and -S command line switches must be passed
  509.     for user status information to be generated by ROMProc. The output looks
  510.     similar to the following, depending upon the prompts selected:
  511.  
  512.         Please wait while preparing your files for download...
  513.             FILE1.ZIP...
  514.             FILE2.ZIP...
  515.             [ etc. ]
  516.         Preparation complete.  Begin your download now...
  517.  
  518. PROC_PROMPT
  519.     This line of text will be displayed to the user upon the start of download
  520.     file processing. It should be used to inform the user that it may take a
  521.     few moments to get the files ready. If more than a 80 character message is
  522.     desired, an external ASCII text file may be defined by setting this
  523.     parameter to a filespec preceeded by a '%' character. For example:
  524.         PROC_PROMPT %c:\romproc\prompt.txt
  525.  
  526. DL_PROMPT
  527.     This line of text will be displayed to the user upon the start of the
  528.     transfer protocol. It should be used to inform the user to start the
  529.     download on their end. If more than a 80 character message is desired, an
  530.     external ASCII text file may be defined by setting this parameter to a
  531.     filespec preceeded by a '%' character.
  532.  
  533. DELAY_PROMPT
  534.     This line of text will be displayed to the user if ROMProc waits for a
  535.     locked drive to unlock for the specified amount of time defined by
  536.     DELAY_TIME. An ASCII text file may also be defined for this parameter.
  537.  
  538. ABORT_PROMPT
  539.     This text will be displayed to the user if ROMProc waits for a locked drive
  540.     to unlock for the amount of time specified by ABORT_TIME, and the transfer
  541.     will be aborted at that time. An ASCII text file may be defined for this
  542.     parameter.
  543.  
  544. ARCHIVER DEFINITIONS:
  545. ─────────────────────
  546. Each archiver, is denoted by ARCHIVER x, where x is a sequential number. Up to
  547. 10 archivers can be executed by ROMproc. ROMProc is capable of automatically
  548. detecting ARC, ARJ, HYP, LZH, PAK, SQZ, ZIP and ZOO archives. The next 4
  549. keywords are required after the ARCHIVER statement; do not comment any of them
  550. out or insert other parameters or comments between them. I would also advise
  551. against changing the command options I have set, unless you have need to do so.
  552. Any other archiver can be added, if desired; the only requirement is that the
  553. archiver must return a DOS errorlevel so that ULP can determine if it ran
  554. properly. If you do not explicitly define the path to your archiver(s), it must
  555. in a directory included in the DOS PATH environment variable.
  556.     ARCHIVER    = denotes a new archiver definition.
  557.     ARC_EXT     = the extension for this particular archiving format.
  558.     ARC_ADD     = the command line to add files to an archive, including all
  559.                   command-line switches desired. Place the variable @ARCHIVE@
  560.                   where the filename is to be inserted in the command line and
  561.                   @FILE@ where the filespec is to be inserted.
  562.     ARC_COMMENT = the command line to comment archives, including all command-
  563.                   line switches desired. Place the variable @ARCHIVE@ where the
  564.                   filename is to be inserted in the command line. If the
  565.                   archive utility does not support commenting, leave this line
  566.                   blank.
  567.     ARC_ERR     = the errorlevel that the archiver returns upon success. This
  568.                   information should be available in the program's
  569.                   documentation.
  570.  
  571. PROTOCOL DEFINITIONS:
  572. ─────────────────────
  573. Each protocol, is denoted by PROTOCOL x, where x is the letter designating the
  574. protocol. Up to 15 protocols can be executed by ROMproc. The next keyword is
  575. required after the PROTOCOL statement; do not comment it out or insert other
  576. parameters or comments between them. I have configured most of the popular
  577. protocols, using the PCBoard default lettering scheme. If you do not explicitly
  578. define the path to your archiver(s), it must in a directory included in the DOS
  579. PATH environment variable.
  580.     PROTOCOL    = denotes a new protocol definition
  581.     PROT_SEND   = the command line to transmit the file(s) to remote, including
  582.                   all command-line switches desired. Place the following
  583.                   variables as needed for ROMProc to properly invoke the
  584.                   protocol.
  585.                   @PORT@     COM or FOSSIL port to be used by the protocol
  586.                   @SPEED@    COM port computer-to-modem speed (DTE)
  587.                   @CARRIER@  modem-to-modem carrier speed (DCE)
  588.                   @FILE@     File (or batch list file) to be downloaded
  589.                   @ULDIR@    path to upload directory for bi-directional
  590.                              protocols.
  591. * NOTE: For reference, the ROMProc command line parameters are mapped to the
  592.         protocol command line variables *exactly* as follows:
  593.         ROMProc Command Line Parameter      Protocol Command Line Varable
  594.                     -P                                @PORT@
  595.                     -X                                @PORT@
  596.                     -S                                @SPEED@
  597.                     -E                                @CARRIER@
  598.                     -F                                @FILE@
  599.                     -U                                @ULDIR@
  600.  
  601.  
  602. ┌──────────────┐
  603. │  9. Support  │
  604. └──────────────┘
  605.  
  606. If you require support for ROMProc, I can be contacted by any of the following
  607. means:
  608.  
  609.     ∙ Fidonet netmail (node:  1:151/106)
  610.     ∙ Intelec BBS Doors conferences
  611.     ∙ RoseNet routed mail (system ID:  BB-P)
  612.     ∙ The ULP Support conference (#42) on Salt Air (PCBoard support BBS)
  613.     ∙ The Support conference (#2) on my BBS (listed at the top of this
  614.       document).
  615.  
  616.  
  617. ┌─────────────────────────────┐
  618. │  10. The Future of ROMProc  │
  619. └─────────────────────────────┘
  620.  
  621. ROMProc will be supported as long as I'm in the BBSing business (which will be
  622. quite a while...once it's in your blood, you can never shake it <g>). The
  623. ROMProc system will be continually expanding it's features, so get your
  624. comments in now! Some current plans:
  625.  
  626.       ∙ Add code enabling ROMProc to output status information to the remote
  627.         user for long batch processing on slow systems.
  628.       ∙ Any ideas from you guys? Thanks! <g>
  629.  
  630. If you have any other suggestions, contact me by U.S. snail-mail or on my BBS
  631. at the number at the top of this document.
  632.  
  633. Thanks for giving ROMProc a try!
  634.  
  635.  
  636. ┌────────────────────────────────┐
  637. │  Appendix A:  DOS Errorlevels  │
  638. └────────────────────────────────┘
  639.  
  640. The following is a list of the errorlevels than can be returned by ROMProc. The
  641. reason the successful execution errorlevel may not be zero is because ROMProc,
  642. upon error-free completion, returns the errorlevel of protocol, which makes
  643. ROMProc completely transparent to the BBS software.
  644.  
  645.         0           Successful execution (usually, depends on the protocol)
  646.         99          Help screen (executing a program with no or an
  647.                         insufficient number of arguments)
  648.         100         Could not close all open files
  649.         101         Invalid command-line parameter
  650.         102         Configuration file not found
  651.         103         No download file (or batch list file) specified
  652.         104         No transfer protocol specified
  653.         108         Invalid configuration file format (archiver definitions)
  654.         109         Invalid configuration file format (protocol definitions)
  655.         110         Unable to allocate heap memory
  656.         112         Invalid registration code
  657.         117         Invalid node number
  658.         120         Archiver BBS advertisement insertion error
  659.         121         Archiver commenting error
  660.         122         Time out waiting for a slow drive to unlock
  661.         125         Communication system for online status failure
  662.         200         Undefined error (internal to ROMProc program)
  663.