home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 8 / CDASC08.ISO / VRAC / ROMPR133.ZIP / ROMPROC.DOC < prev    next >
Text File  |  1993-09-11  |  31KB  |  650 lines

  1.  
  2.     ┌────┐
  3.     │──═─│
  4.     │ ── │ ─────┐      ┌────┐             ROMProc Documentation Fil
  5.     │    │   ROMProc   │──═─│                    Version 1.33
  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. (The -P may be omitted from the
  260.         command line in favor of the DSZPORT environment variable).
  261.  
  262. * NOTE: If you are using a non-standard COM port, define the COM port IRQ and
  263.         base address on the command line. For example, if COM3 (a non-standard
  264.         port for IBM PCs) is used with 3e8 is the base address and 5 is the
  265.         assigned IRQ, the -P parameter would be "-P3e8,5" (no quotes).
  266.  
  267. Most of the switches are self-explanatory. To be safe, if your BBS system
  268. is capable of passing a parameter, pass it on to ROMProc using the appropriate
  269. command-line switch. It can't hurt...
  270.  
  271. PCBOARD INSTALLATION:
  272. ─────────────────────
  273. Installation in PCBoard is very easy. PCBoard uses two batch files for each
  274. protocol, named PCBR?.BAT and PCBS?.BAT, where ? is the protocol letter. The
  275. PCBR?.BAT (receive) batch files do not need to be changed for ROMProc, however,
  276. the PCBS?.BAT batch file does. Below are sample Zmodem and HS/Link send (and
  277. receive, for reference) batch files from my multinode system:
  278.  
  279. PCBSZ.BAT:
  280. @Echo off
  281. if exist pcberr.fil del pcberr.fil
  282. if exist pcbdsz.log del pcbdsz.log
  283. c:\romproc\romproc -Cc:\romproc\romproc.cfg -Tz -N%PCBNODE% -F%3 -P%1 -S%2 -E%5
  284.  
  285. PCBRZ.BAT:
  286. @Echo off
  287. if exist pcberr.fil del pcberr.fil
  288. if exist pcbdsz.log del pcbdsz.log
  289. dsz port %1 speed %2 ha cts est 0 %5 pB4096 pr1 rz %3
  290.  
  291. PCBSH.BAT:
  292. @Echo off
  293. if exist pcberr.fil del pcberr.fil
  294. if exist pcbdsz.log del pcbdsz.log
  295. c:\romproc\romproc -Cc:\romproc\romproc.cfg -Th -N%PCBNODE% -F%3 -P%1 -S%2 -E%5
  296.     -U%6
  297.  
  298. PCBRH.BAT:
  299. @Echo off
  300. if exist pcberr.fil del pcberr.fil
  301. if exist pcbdsz.log del pcbdsz.log
  302. hslink -b%2 -p%1 -e%5 -u%6 -noc:\pcb\gen\dlpath.lst
  303.  
  304.  
  305. With the exception of the -T parameter, all of your PCBS?.BAT files should be
  306. identical; change the -T parameter to reflect the appropriate protocol letter.
  307. For bi-directional protocols, such as HS/Link and BiModem, add the -U%6 command
  308. switch.
  309.  
  310. If you wish full implementation of ROMProc, all protocols have to be shelled
  311. instead of using the internal Xmodem and Ymodem protocols. Fortunately, DSZ is
  312. capable of all variations of Xmodem and Ymodem as well as Zmodem. The following
  313. is a screen snapshot of my PCBPROT.DAT file from PCBSETUP, with all protocols
  314. running through ROMProc:
  315.  
  316.                        Port Lock
  317.      Use Type Size MNP Open Lines             Protocol Description
  318.      ═══ ════ ════ ═══ ════ ═════ ═══════════════════════════════════════
  319.       A   I    128  N   N     N   ASCII (text files only)
  320.       X   S    128  N   N     Y   Xmodem
  321.       C   S    128  N   N     Y   Xmodem-CRC
  322.       O   S   1024  N   N     Y   1K-Xmodem
  323.       F   S   1024  Y   N     Y   1K-Xmodem/G
  324.       Y   D   1024  N   N     Y   Ymodem    [Batch]
  325.       G   D   1024  Y   N     Y   Ymodem/G  [Batch]
  326.       Z   D   1024  N   N     Y   Zmodem    [Batch]
  327.       M   D   1024  N   N     Y   Zmodem MobyTurbo  [Batch]
  328.       H   B   2048  N   N     Y   HS/Link (bi-directional)  [Batch]
  329.       N   I      0  N   N     N   None (ask each transfer)
  330.  
  331. Note the type for the Xmodem and Ymodem transfer protocols is now (S)helled or
  332. (D)SZLOG batch, instead of (I)nternal.
  333.  
  334. OTHER BBS INSTALLATION:
  335. ───────────────────────
  336.  
  337. * NOTE: As my BBS is PCBoard, I have written the PCBoard-specific instructions.
  338.         I would greatly appreciate some feedback from other BBS software users
  339.         regarding ROMProc installation specifics.
  340.  
  341. APPLICATION NOTES:
  342. ──────────────────
  343. PKZIP:
  344.     PKZIP 2.04 uses direct-video output by default that will make the
  345.     processing window look rather ugly when executed. To remedy this, set the
  346.     PKNOFASTCHAR environment variable which will revert PKZIP 2.04 to the older
  347.     1.10-style video output. (It doesn't matter what your set the variable to,
  348.     PKZIP just looks for its existence).
  349.  
  350. SQZ:
  351.     SQZ also uses direct-video output, but unlike PKZIP 2.04, it cannot be
  352.     defeated. The processing window may look odd, but rest assured it is
  353.     operating correctly.
  354.  
  355. DSZ:
  356.     In many cases, the use of DSZPORT environment variable is more desirable
  357.     than passing the COM port information. This allows easier definition of
  358.     non-standard COM ports addresses. For example, if you are using COM2 for a
  359.     BBS node, add:
  360.  
  361.             SET DSZPORT=2
  362.  
  363.     to your node batch file. If you are running a non-standard COM port, define
  364.     the base address and IRQ on the command line. For example, if COM3 (a
  365.     non-standard port for IBM PCs) is used with 3e8 is the base address and 5
  366.     is the assigned IRQ, the setting would be:
  367.  
  368.             SET DSZPORT=3e8,5
  369.  
  370.     If you elect to use the DSZPORT environment variable, it is no longer
  371.     necessary to pass the -P command-line switch or to add the "port @PORT@"
  372.     parameter to the DSZ command lines for Xmodem, Ymodem, and Zmodem transfers
  373.     in the ROMProc configuration file.
  374.  
  375.     In addition, ROMProc will search the environment for the DSZPORT variable
  376.     and use it for the com port definitions for it's user status output.
  377.  
  378. HS/Link:
  379.     The HS/Link command-line can include the -NF switch to turn off HS/Link's
  380.     full-screen display, allowing it to run in ROMProc's transfer protocol
  381.     window. Otherwise, ROMProc's local display will be overwritten by HS/Link's
  382.     display.
  383.  
  384.  
  385. ┌────────────────────┐
  386. │  8. Configuration  │
  387. └────────────────────┘
  388.  
  389. The sample configuration file included in the distribution archive is heavily
  390. commented, but some additional information is provided below:
  391.  
  392. GENERAL PARAMETERS:
  393. ───────────────────
  394. REG_CODE
  395.     The registration code EXACTLY as provided to you on your registration
  396.     letter. If this is an unregistered version, comment out this line. Note
  397.     that this is case-sensitive, as the serial number, BBS name and sysop name
  398.     are all encrypted into this code.
  399.  
  400. BBS_NAME
  401.     The BBS name EXACTLY as provided to you on your registration letter. If
  402.     this is an unregistered version, comment out this lines. Note that this is
  403.     case-sensitive!
  404.  
  405. SYSOP_NAME
  406.     The sysop name EXACTLY as provided to you on your registration letter. If
  407.     this is an unregistered version, comment out this line. You get the picture
  408.     by now...
  409.  
  410. WORK_DIR
  411.     The full path for the specific subdirectory for ROMProc to store file(s) to
  412.     be downloaded. This must include the trailing backslash (ROMProc will add
  413.     it if necessary)! If this directory does not exist at runtime, ROMProc will
  414.     attempt to create it. This can be set to a RAM disk for greater speed,
  415.     since ROMProc will detect an out of disk space condition and allow the
  416.     download to continue from the original file. An environment variable may
  417.     also be entered using the standard %VARIABLE% notation DOS uses; note that
  418.     the environment variable definition must adhere to the same requirements as
  419.     specifying a work directory. For example, the following are both valid:
  420.         WORK_DIR c:\work\
  421.         WORK_DIR %TEMP%
  422.     where %TEMP% is defined as "c:\work\" in your AUTOEXEC.BAT file.
  423.  
  424. DISK_BUFFER
  425.     The size of the disk I/O buffer you wish to allocate in bytes (valid values
  426.     are between 2048 bytes and 16384 bytes). Optimal performance is obtained
  427.     with a value that is a multiple of 2048 bytes, since this is the size of a
  428.     typical hard disk cluster. 4096 seems to be a good number for me, although
  429.     a larger size will improve performance somewhat. If you find yourself
  430.     running out of memory when executing archivers or protocols, reduce this
  431.     number to increase your available memory. If no value is specified, the
  432.     disk buffer will default to 4096 bytes.
  433.  
  434. LOG_FILE
  435.     The complete path and filename of the log file for ROMProc to record
  436.     errors. Comment the line out if you don't want any disk error logging.
  437.  
  438. LOCK_LINES
  439.     If you want ROMProc to preserve two lines at the top or bottom of the local
  440.     display, enter TOP or BOTTOM as desired, otherwise, enter NONE or comment
  441.     the line out.
  442.  
  443. BBS_AD_FILE
  444.     The directory path and filename for your BBS ad to be inserted into each
  445.     and every archive processed by ROMProc. Note that you must provide a path,
  446.     or it will not be copied. I STRONGLY recommend against them; BBS ads are
  447.     aggravating to other sysops, so please be considerate and use the archive
  448.     comment instead. BBS ad files are the scourge of the BBS world. This
  449.     parameter is commented out by default.
  450.  
  451. COMMENT_ARC
  452.     If you want ROMProc to comment archives (if supported by the archive
  453.     format) enter YES. If not, enter NO or comment the line out. This is much
  454.     more desirable than inserting BBS ads.
  455.  
  456. DRIVE PROCESSING DEFINITIONS:
  457. ─────────────────────────────
  458. PROC_DRIVE
  459.     Specify the drive letters for file preprocessing (BBS ad insertion and/or
  460.     commenting). Any file requested from a non-specified drive will still be
  461.     tranmitted (unmodified) from the original location. This allows
  462.     preprocessing of certain drives (e.g. CD-ROMs), but not all. Drives may be
  463.     specified in ranges, seperated by a hyphen, and/or individual drives may be
  464.     seperated by spaces, commas or semi-colons. The following examples are all
  465.     valid, and will select drives letters C through J:
  466.         PROC_DRIVE C-J
  467.         PROC_DRIVE C D E F G H I J
  468.         PROC_DRIVE C-F G H-J
  469.         PROC_DRIVE C-F,G-I,J
  470.  
  471. LOCK_DRIVE
  472.     Specify the drive letters for locking, by entering the individual drives to
  473.     be locked, one physical drive per line. Ranges may be seperated by a
  474.     hyphen, and/or individual drives may be seperated by spaces, commas or
  475.     semi-colons. Note that you normally lock by physical drive; if you have
  476.     multiple logical drives per physical drive (e.g. a partitioned hard disk or
  477.     CD-ROM changer), list all the logical drive letters on the same LOCK_DRIVE
  478.     command line. Each LOCK_DRIVE line constitutes a single drive unit as far
  479.     as ROMProc is concerned. It is not required that all drives defined to be
  480.     processed be locked. In this example, drive D will be locked if accessed by
  481.     ROMProc and drives E-J will be locked if ROMProc accesses any drive from E
  482.     to J.
  483.         LOCK_DRIVE D
  484.         LOCK_DRIVE E-J
  485.  
  486. DELAY_TIME
  487.     This is the amount of time (in seconds) that ROMProc will wait for a drive
  488.     to unlock before displaying the text indicated by DELAY_PROMPT. I would
  489.     recommend a value of 5 to 10 seconds. If commented out, ROMProc will
  490.     default to 5 seconds.
  491.  
  492. ABORT_TIME
  493.     This is the amount of time (in seconds) that ROMProc will wait for a drive
  494.     to unlock. If this time is exceeded, ROMProc will abort the transfer. I
  495.     suggest that at least 10 seconds be given, more if you are using CD-ROM
  496.     changers and/or slow networks. If commented out, it will default to 30
  497.     seconds.
  498.  
  499. COMMUNICATION DEFINITIONS:
  500. ──────────────────────────
  501. COMM_IO
  502.     If you want ROMProc to output status information to the user on-line, enter
  503.     YES; if you do not want ROMProc to output information, enter NO or comment
  504.     the line out. Note that the -P and -S command line switches must be passed
  505.     for user status information to be generated by ROMProc. The output looks
  506.     similar to the following, depending upon the prompts selected:
  507.  
  508.         Please wait while preparing your files for download...
  509.             FILE1.ZIP...
  510.             FILE2.ZIP...
  511.             [ etc. ]
  512.         Preparation complete.  Begin your download now...
  513.  
  514. PROC_PROMPT
  515.     This line of text will be displayed to the user upon the start of download
  516.     file processing. It should be used to inform the user that it may take a
  517.     few moments to get the files ready. If more than a 80 character message is
  518.     desired, an external ASCII text file may be defined by setting this
  519.     parameter to a filespec preceeded by a '%' character. For example:
  520.         PROC_PROMPT %c:\romproc\prompt.txt
  521.  
  522. DL_PROMPT
  523.     This line of text will be displayed to the user upon the start of the
  524.     transfer protocol. It should be used to inform the user to start the
  525.     download on their end. If more than a 80 character message is desired, an
  526.     external ASCII text file may be defined by setting this parameter to a
  527.     filespec preceeded by a '%' character.
  528.  
  529. DELAY_PROMPT
  530.     This line of text will be displayed to the user if ROMProc waits for a
  531.     locked drive to unlock for the specified amount of time defined by
  532.     DELAY_TIME. An ASCII text file may also be defined for this parameter.
  533.  
  534. ABORT_PROMPT
  535.     This text will be displayed to the user if ROMProc waits for a locked drive
  536.     to unlock for the amount of time specified by ABORT_TIME, and the transfer
  537.     will be aborted at that time. An ASCII text file may be defined for this
  538.     parameter.
  539.  
  540. ARCHIVER DEFINITIONS:
  541. ─────────────────────
  542. Each archiver, is denoted by ARCHIVER x, where x is a sequential number. Up to
  543. 10 archivers can be executed by ROMproc. ROMProc is capable of automatically
  544. detecting ARC, ARJ, HYP, LZH, PAK, SQZ, ZIP and ZOO archives. The next 4
  545. keywords are required after the ARCHIVER statement; do not comment any of them
  546. out or insert other parameters or comments between them. I would also advise
  547. against changing the command options I have set, unless you have need to do so.
  548. Any other archiver can be added, if desired; the only requirement is that the
  549. archiver must return a DOS errorlevel so that ULP can determine if it ran
  550. properly. If you do not explicitly define the path to your archiver(s), it must
  551. in a directory included in the DOS PATH environment variable.
  552.     ARCHIVER    = denotes a new archiver definition.
  553.     ARC_EXT     = the extension for this particular archiving format.
  554.     ARC_ADD     = the command line to add files to an archive, including all
  555.                   command-line switches desired. Place the variable @ARCHIVE@
  556.                   where the filename is to be inserted in the command line and
  557.                   @FILE@ where the filespec is to be inserted.
  558.     ARC_COMMENT = the command line to comment archives, including all command-
  559.                   line switches desired. Place the variable @ARCHIVE@ where the
  560.                   filename is to be inserted in the command line. If the
  561.                   archive utility does not support commenting, leave this line
  562.                   blank.
  563.     ARC_ERR     = the errorlevel that the archiver returns upon success. This
  564.                   information should be available in the program's
  565.                   documentation.
  566.  
  567. PROTOCOL DEFINITIONS:
  568. ─────────────────────
  569. Each protocol, is denoted by PROTOCOL x, where x is the letter designating the
  570. protocol. Up to 15 protocols can be executed by ROMproc. The next keyword is
  571. required after the PROTOCOL statement; do not comment it out or insert other
  572. parameters or comments between them. I have configured most of the popular
  573. protocols, using the PCBoard default lettering scheme. If you do not explicitly
  574. define the path to your archiver(s), it must in a directory included in the DOS
  575. PATH environment variable.
  576.     PROTOCOL    = denotes a new protocol definition
  577.     PROT_SEND   = the command line to transmit the file(s) to remote, including
  578.                   all command-line switches desired. Place the following
  579.                   variables as needed for ROMProc to properly invoke the
  580.                   protocol.
  581.                   @PORT@     COM port to be used by the protocol
  582.                   @SPEED@    COM port computer-to-modem speed (DTE)
  583.                   @CARRIER@  modem-to-modem carrier speed (DCE)
  584.                   @FILE@     File (or batch list file) to be downloaded
  585.                   @ULDIR@    path to upload directory for bi-directional
  586.                              protocols.
  587.  
  588.  
  589. ┌──────────────┐
  590. │  9. Support  │
  591. └──────────────┘
  592.  
  593. If you require support for ROMProc, I can be contacted by any of the following
  594. means:
  595.  
  596.     ∙ Fidonet netmail (node:  1:151/106)
  597.     ∙ Intelec BBS Doors conferences
  598.     ∙ RoseNet routed mail (system ID:  BB-P)
  599.     ∙ The ULP Support conference (#42) on Salt Air (PCBoard support BBS)
  600.     ∙ The Support conference (#2) on my BBS (listed at the top of this
  601.       document).
  602.  
  603.  
  604. ┌─────────────────────────────┐
  605. │  10. The Future of ROMProc  │
  606. └─────────────────────────────┘
  607.  
  608. ROMProc will be supported as long as I'm in the BBSing business (which will be
  609. quite a while...once it's in your blood, you can never shake it <g>). The
  610. ROMProc system will be continually expanding it's features, so get your
  611. comments in now! Some current plans:
  612.  
  613.       ∙ Add code enabling ROMProc to output status information to the remote
  614.         user for long batch processing on slow systems.
  615.       ∙ Any ideas from you guys? Thanks! <g>
  616.  
  617. If you have any other suggestions, contact me by U.S. snail-mail or on my BBS
  618. at the number at the top of this document.
  619.  
  620. Thanks for giving ROMProc a try!
  621.  
  622.  
  623. ┌────────────────────────────────┐
  624. │  Appendix A:  DOS Errorlevels  │
  625. └────────────────────────────────┘
  626.  
  627. The following is a list of the errorlevels than can be returned by ROMProc. The
  628. reason the successful execution errorlevel may not be zero is because ROMProc,
  629. upon error-free completion, returns the errorlevel of protocol, which makes
  630. ROMProc completely transparent to the BBS software.
  631.  
  632.         0           Successful execution (usually, depends on the protocol)
  633.         99          Help screen (executing a program with no or an
  634.                         insufficient number of arguments)
  635.         100         Could not close all open files
  636.         101         Invalid command-line parameter
  637.         102         Configuration file not found
  638.         103         No download file (or batch list file) specified
  639.         104         No transfer protocol specified
  640.         108         Invalid configuration file format (archiver definitions)
  641.         109         Invalid configuration file format (protocol definitions)
  642.         110         Unable to allocate heap memory
  643.         112         Invalid registration code
  644.         117         Invalid node number
  645.         120         Archiver BBS advertisement insertion error
  646.         121         Archiver commenting error
  647.         122         Time out waiting for a slow drive to unlock
  648.         125         Communication system for online status failure
  649.         200         Undefined error (internal to ROMProc program)
  650.