home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / ex142.zip / EX.DOC < prev    next >
Text File  |  1995-01-19  |  8KB  |  200 lines
  1.  
  2. Ex -- the External transfer protocol CD-ROM download driver.
  3.   Program and documentation (C) Copyright 1994 MSG Resources
  4.  
  5. *******************************************************************************
  6. Ex is released as shareware.  User is granted a 14 day evaluation period.
  7. Usage after 14 days requires registration.  Registration for Ex and all future
  8. versions of Ex is (in US funds) a one-time $15 fee.  
  9.  
  10. The standard registered version of Ex supports up to 25 CD-ROM Volumes and 
  11. copies up to 25 files per run; custom versions are available on request for 
  12. additional cost.  Send registrations to:
  13.  
  14.                  MSG Resources
  15.                  PO Box 52183
  16.                  Shreveport, LA 71135-2183
  17.  
  18. (We are working towards credit card and online registrations at our BBS site)
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25. Purpose
  26. *******************************************************************************
  27.   Ex was designed to transparently copy files off of CD-ROM drives before the 
  28.   files are downloaded.  It works with all BBSes that use external file 
  29.   transfer protocol drivers via a redirection file for the download list, such 
  30.   as Maximus, RBBS, and many others.  Ex was developed on a Maximus BBS system.
  31.   
  32.  
  33. Operation
  34. *******************************************************************************
  35.   Ex tracks and sorts by drive up to 50 files per download session, copies up
  36.   to 25 files as needed, loads the transfer driver, and deletes the copied
  37.   files before returning to the BBS program.  Unregistered versions will only
  38.   copy up to 5 files per session.  The errorlevel returned from Ex is whatever
  39.   the transfer program exited with, making it completely transparent.  If the
  40.   file transfer module didn't load, then 255 is returned.  Running Ex with no
  41.   parameters brings up an info screen and exits with errorlevel 0.  Ex needs a 
  42.   config file to determine your system setup; default is Ex.Cfg but can be 
  43.   overridden by the -c command line option.
  44.   
  45.  
  46. OS/2 or DOS
  47. *******************************************************************************
  48.   Ex comes in both native OS/2 32-bit and DOS 16-bit versions.  Both versions
  49.   use the same config file and utilize a temporary file named Ex.Tmp that is
  50.   created in the same directory as the redirection file.  The temporary file 
  51.   exists for only a short time.
  52.  
  53.  
  54. Command line
  55. *******************************************************************************
  56.   Ex reads the command line for an alternate config file and the redirection
  57.   file.  Everything after the config file entry is expected to be a transfer
  58.   driver program and it's associated parameters.  Ex reads and, if needed,
  59.   rewrites the redirection file.  
  60.  
  61.  
  62. Config file
  63. *******************************************************************************
  64.   The default config file is Ex.Cfg located in the current directory.  An 
  65.   alternate config file can be specified with the -c command line switch.
  66.   Cut and paste config file:
  67.  
  68. ; Sample Ex config file
  69. ;
  70. ; All verbs MUST begin in left column!
  71. ;
  72. ; Time, in seconds, to display error messages (optional)
  73. WaitTime 5
  74. ;
  75. ; Target directory for copying files from CD-ROMs into
  76. ; before downloading (max 1, required)
  77. CopyDir C:\Work
  78. ;
  79. ; Semaphor file to restrict only 1 copy of Ex to run at
  80. ; a time  (optional)
  81. Semaphor F:\Mailers\Semaphor\Ex.Flg
  82. ;
  83. ; list of CD-ROM drives (min 1, max 5 or 25 if registered)
  84. ; Volume \\server2\cd1
  85. ; Volume \\server2\cd2
  86. Volume P:\
  87. Volume Q:\
  88. Volume R:\
  89. Volume S:\
  90. Volume T:\
  91. Volume U:\
  92. ;
  93. ; Filespec to use for logging if desired, registered 
  94. ; version only (optional)
  95. LogFile Ex.Log
  96. ;
  97. ; Task # to be recorded in log file (optional)
  98. Task 1
  99. ;
  100. ; END CONFIG FILE
  101.  
  102.  
  103. Detailed description of verbs:  
  104. *******************************************************************************
  105.   WaitTime takes a numeric parameter and specifies how long to display an error 
  106.   message should one occur.  Typical errors are 'cannot read redirection file', 
  107.   'error creating temporary redirection work file', and 'transfer program did 
  108.   not load'.
  109.  
  110.   CopyDir is the directory where Ex will copy CD-ROM based files to before 
  111.   they are downloaded.  After the transfer is complete, the files Ex copied 
  112.   into this directory will be erased.  (If you can spare the memory, use a
  113.   ramdisk!)  
  114.   
  115.   Semaphor requires a full drive, path, and filename and is created when the 
  116.   program starts processing the redirection file and is deleted before calling 
  117.   the file transfer program.  Information written to this file is either a 0 or 
  118.   the task number (described later) for registered versions, 'Unregistered' for 
  119.   the unregistered versions.  If this file exists when Ex runs, Ex will wait 30 
  120.   seconds and continue, or you can force Ex to abotr the semaphor lock-out and 
  121.   run by banging on the ESC key.  This semaphor flag, if implemented, is used 
  122.   to allow only one copy of Ex to run at a time.  If you run multiple Ex config 
  123.   files and wish only one copy of Ex to access your CD-ROMs, this should be the 
  124.   same for all copies.
  125.  
  126.   Volume is a CD-ROM drive.  Both single drive CD-ROM mappings and CD-ROM 
  127.   server names are supported.  IE: P:\ and \\CD_SRVR\P:
  128.   
  129.   LogFile, like Semaphor, takes a full drive, path, and filename and if 
  130.   implemented Ex will record all it's transactions here.
  131.   
  132.   Task is simply a number to be written into the log and semaphor files and is 
  133.   used when running Ex with multiple config files.  At this time it doesn't do 
  134.   or mean anything else.
  135.  
  136.  
  137. Multi-Node
  138. *******************************************************************************
  139.   Ex will run multi-node with either a single config file or a config file for
  140.   each node.  Each session of Ex will only delete the files it copied, so all 
  141.   nodes can share the same CopyDir directory.  Should the same file be 
  142.   downloaded from multiple nodes simultaneously, Ex will only copy the file 
  143.   once for the first node that exits to download, the others will still 
  144.   download off of CD-ROM.  This is a safety feature: if EX can't copy a file it 
  145.   leaves the redirection file unchanged and downloads from CD-ROM will be 
  146.   downloaded from CD-ROM.
  147.  
  148.  
  149. BBS Installation
  150. *******************************************************************************  
  151.   To run Ex with your BBS program, simply add 'Ex' into the command line that 
  152.   calls the driver module.  A typical command line to send a list of files 
  153.   Zmodem might be: 
  154.     Zmodem sz -rr @D:\BBS\Node5.Lst
  155.   and the Ex version would be:
  156.     Ex [-cConfig.Fil] Zmodem sz -rr @D:\BBS\Node5.Lst 
  157.   This would tell Ex to read configuration file 'Config.Fil' in the current
  158.   directory, then to run Zmodem to transfer files listed in D:\BBS\Node5.Lst.
  159.  
  160.   Example PROTOCOL.CTL entry for Maximus BBS and DSZ:
  161.     Protocol Zmodem
  162.     [...]
  163.     Download   Ex Dsz port %P speed %W estimate 0 %b ha rts -Z sz @dsz%k.ctl
  164.     [...]
  165.     End Protocol  
  166.   Or, for multi node systems:
  167.     Protocol Zmodem
  168.     [...]
  169.     Download   Ex -cEx%k.Cfg Dsz port %P speed %W estimate 0 %b ha rts -Z
  170.      (cont) sz @dsz%k.ctl
  171.     [...]
  172.     End Protocol
  173.     
  174.   Example PROT.DEF for RBBS and DSZ
  175.     [...]
  176.     "Z)modem (batch)
  177.     ",1,S,8,,B,1024,,0.95,,1=E,"C:\RBBS\XFER\EX.EXE DSZ port [PORT#] speed 
  178.       [BAUD] estimate 0 [CBAUD] ha on sz -r [FILE]","C:\RBBS\XFER\DSZ.COM port 
  179.       [PORT] speed [BAUD] estimate 0 [CBAUD] ha on rz -p [FILE]"
  180.  
  181.  
  182.   (Please send download parameters for BBS systems not listed here)
  183.       
  184.  
  185. Warranty
  186. *******************************************************************************
  187.   No warranties, expressed nor implied.  User determines usability of program
  188.   and assumes all responsibilities for the usage and consequences of use of 
  189.   this program.  
  190.   
  191.   Feedback is welcomed via the above US Mail address or email to FidoNet 
  192.   1:380/25, or internet remus@secret.com  Support via BBS is available from MSG 
  193.   Resources at 318-865-4503.  You can also telnet and ftp into secret.com
  194.   (199.190.72.11).  The latest version of Ex can be found in the STRANGE
  195.   download directory or file requested as 'EX'.
  196. *******************************************************************************
  197.  
  198.   (Maximus (C)Copyright Scott Dudley, DSZ (C)Copyright Omen Technologies)
  199.  
  200.