home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / CDS260.ZIP / CDS.DOC next >
Encoding:
Text File  |  1992-10-16  |  12.4 KB  |  316 lines
  1.  
  2. CDS Version 2.60
  3. Copyright Nathan Hartwell, PSI Software 1992.  All rights reserved.
  4.  
  5.                               WARNING!
  6.                     -----------------------------
  7. There are rare circumstances in which versions of CDS prior to 2.30 
  8. can result in loss of data.  Please use 2.30 or later.
  9.  
  10.                                *NOTE*
  11.                     -----------------------------
  12. The 11th file bug was fixed in version 2.40 (without my knowledge it even
  13. existed!).  Version 2.41 is nothing but smoothing out the appearance of
  14. CD-Share on the local side.
  15.  
  16.                                *NOTE*
  17.                     -----------------------------
  18. Single file bug in versions 2.40 and 2.41 fixed.  Also, increased max file
  19. count to 1024 files.  Enjoy!
  20.  
  21.                                *NOTE*
  22.                     -----------------------------
  23. Added 'ready' message to 2.50, but forgot to send it to the user.  Fixed.
  24.  
  25.                                *NOTE*
  26.                     -----------------------------
  27. Fixed possible network conflict with swap routines.
  28.  
  29.  
  30.                              DESCRIPTION
  31.  
  32. CDS is a program that allows movement of a file from any drive to any 
  33. other temporary drive and subdirecory before download.  External 
  34. protocols such as DSZ are fully supported and all parameters are 
  35. passed on to the external protocol.  This is fully transparent to the 
  36. caller except a short delay while files are transferred.  The program 
  37. is designed for full use of CD-ROM minichanger devices on a multinode 
  38. BBS's without the use of doors.  It can be used in any BBS environment 
  39. that allows use of external file protocols.  It has been tested with 
  40. PCBoard version 14.5a, 386 and 486 computers, DSZ, and Lantastic NOS 
  41. 4.00.  
  42.  
  43. In addition, this program can be used on any networked BBS to 
  44. significantly decrease LAN traffic during file transfers.  Usually a 
  45. file is sent across the LAN to the local node then out over the modem 
  46. as it is downloaded.  During the entire download, pieces of the file 
  47. are being sent across the LAN. With this program, there is a single 
  48. copy of a file to the local hard disk, then the file is sent from 
  49. the local disk.  LAN traffic for the duration of the download is 
  50. eliminated.  This may significantly increase the efficiency of your 
  51. BBS, especially if you run several busy nodes.
  52.  
  53.  
  54.                      "SUNDAY"  SHAREWARE CONCEPT
  55.  
  56. No, nothing religious here.  This version is fully functional and 
  57. works very quickly... 6 days a week.  On the 7th day, Sunday, there 
  58. is a delay for 5 seconds with each transfer to the hard disk.  Lest 
  59. the caller think there is something wrong, it also puts out a short 
  60. note to the caller telling him about the delay for unregistered 
  61. shareware.   Obviously, this is to encourage registration of the 
  62. software yet to allow full use of CDShare until it is registered.  
  63. With the registration, you'll get a key file that will allow you to 
  64. disable all messages to the caller if you choose.  The key allows 
  65. full use without delays every day of the week.  
  66.  
  67. You may upload and freely distribute this program as long as it is 
  68. unmodified and contains only CDS.EXE and CDS.DOC.  You may not modify 
  69. this DOC file or program code.  You may recompress this file in any 
  70. format but you may not add advertising files to it with the exception 
  71. of a "ZIP header" or equivalent.  
  72.  
  73.  
  74.  
  75.                                  USE
  76.  
  77. This software is not free.  The user may use this program for 
  78. evaluation for a period of 30 days, after which he is expected to 
  79. register the program ($22.50) or discontinue use.  Use for more than 
  80. 30 days without registration represents a violation of copyright. 
  81. Please mail checks to: 
  82.     Portal System Innovations
  83.     Attn: Nathan Hartwell
  84.     212 Shoreline Drive
  85.     Lakesite, TN  37379
  86.  
  87.  
  88.                               DISCLAIMER
  89.  
  90. This program is provided "as is" without warranty of any kind, either 
  91. expressed or implied including but not limited to the implied 
  92. warranties of merchantability and/or fitness for a particular 
  93. purpose.  (Sounds familiar, doesn't it?)  There is no warranty beyond 
  94. refund of any money paid to the author by the user.  In no event 
  95. shall the author, supporting BBS systems, Sysops, or PSI software be 
  96. held liable for any damage or losses resulting from the use of this 
  97. program.  It is up to the user to determine the correct usage of this 
  98. program on his system and he/she bears full responsibility for 
  99. correct implementation of it.  
  100.  
  101.  
  102.                             DOCUMENTATION
  103.  
  104. Now for a quick and simple doc file. 
  105.  
  106. Installation:
  107.  
  108. In each of your external protocol send batch files, add CDS.EXE 
  109. before your external protocol driver. 
  110.  
  111.     Example:  DSZ port %P speed %B estimate 0 sz -m %F
  112.                                  |
  113.                                  v
  114.               CDS DSZ port %P speed %B estimate 0 sz -m %F
  115.  
  116. Execution:
  117.  
  118.   CDS <Protocol Program Name> <Required Argument> [Other Optional Args.]
  119.  
  120.     Required Argument:  If no options are used, this will should be either
  121.                       the filename of the file to send or if the first
  122.                       character is an at sign (@), the control file (list
  123.                       of files to send).  Preferrably, all filenames have
  124.                       full path specs.
  125.  
  126.     Optional Args.:  You can pass all the arguments you would normally use,
  127.                    just make sure the above mentioned required argument is
  128.                    the last argument passed.
  129.  
  130.  
  131. Configuration File:
  132.  
  133.   Filename:  CDS.CFG
  134.   Location:  Either in current directory or directory from which CDS.EXE was
  135.            executed.
  136.  
  137.  
  138. Config file format.  The following is a list of valid commands and their
  139. required arguments:
  140.  
  141.  » LogPath   - Full pathname for the logfile.
  142.  > LogLevel  - A number from 1 to 6, where 1 puts the least amout in the log
  143.                and 6 puts everything in.
  144.    Temp      - Directory to use as temp storage.  Trailing backslash (\) is
  145.                optional.  You may use a RAM-Disk for this directory.
  146.    Drives    - The drive letter(s) of the drive(s) you want CD-Share to
  147.                consider removable media and hence copy files off of.
  148.  » Port      - The COM Port Number (1 - 4)  Use if your COM Port uses standard
  149.                port addressing.  See list below.
  150.  » XPort     - The hexadecimal address of the base port address your COM Port
  151.                is set to.  Example: COM1 is nomrally located at 3F8.
  152. |> Msg       - Used to customize message sent to users.
  153.  > Exec      - Command-line to execute on each file that is copied to the temp
  154.                directory.  Use '%s' in place of the filename to process.
  155. |> UseEMS    - Enables the use of EMS memory for the swap routines.
  156. |> UseXMS    - Enables the use of XMS memory for the swap routines.
  157. |> UseFile   - Enables the use of a temporary swapfile.
  158. |> XMSFirst  - Tells the swap routines to try XMS memory, then EMS.
  159. |> SwapDir   - Must be set to enable the swap.  Set this to where you would
  160.                like the swapfile to be put.
  161. |> Ready_Msg - Specify a custom start transfer message.
  162.  
  163. | = Registered only.
  164. > = Optional parameter.
  165. » = Optional parameter for registered version, required for non-registerd.
  166.  
  167. Commands LogPath, Port, and XPort are required for non-registered copies.
  168. If you are registered, leaving out the LogPath command disables logfile
  169. output, while leaving out either Port or XPort disbales the message output.
  170.  
  171. The order of these in the config file is not important, so long as they are
  172. each on their own line.
  173.  
  174.  
  175. Environment Variable:
  176.  
  177.   Certain BBS packages allow multiple nodes to be based out of one main
  178. directory.  Turbo-Comm (still under development) and Renegade are two such
  179. systems.  Due to these systems, an environment variable has been added so as
  180. to tell CD-Share what the configuration filename is.  The environment
  181. variable is, of course, CDS.  Just SET CDS=[path]<filename> and you're all
  182. set.
  183.  
  184.  
  185. Example config:
  186.  
  187. LogPath C:\BBS\CDS.LOG
  188. LogLevel 3
  189. Temp X:\
  190. Drives ABJKLM
  191. XPort 3F8
  192. Msg Are files all you get?
  193. Exec PKZip.Exe -z %s MySys.Txt
  194. UseEMS
  195. UseXMS
  196. XMSFirst
  197. SwapDir X:\
  198. Ready_Msg Ok, leech, start your download...
  199.  
  200. In this example, drives A:, B:, J:, K:, L:, and M: will have files copied
  201. from them to the temp directory, all others will be skipped.
  202.  
  203. NOTE: Do NOT separate the config commands and their parameters with tab
  204.       characters.  You may put multiple spaces in to make the config file
  205.       pretty, but the tab character will only be removed (and not
  206.       translated).
  207.  
  208. Standard COM Port base addresses: (for COM1 - COM4)
  209.  
  210.   COM1: 3F8
  211.   COM2: 2F8
  212.   COM3: 3E8
  213.   COM4: 2E8
  214.  
  215.  
  216. DOS Critical error trapping has been added.  CD-Share will retry up 
  217. to five (5) times before terminating.  No log entries are generated 
  218. for critical errors.
  219.  
  220.  
  221. Notes:
  222.  
  223.  *  - Files are copied from media devices to the specified path.
  224.       This may be a RAM-Disk.  The files copied are then deleted
  225.       afterwards, so if you are running multi-node make a .CFG for
  226.       each node.
  227.  
  228.  *  - For use with multinode BBS systems, and minichangers you should 
  229.       disable all internal protocols.  With PCBoard, you'd edit the 
  230.       PCBPROT.DAT, see your manual. 
  231.  
  232.  *  - You may want to put a TEMPFILE subdirectory on each local disk 
  233.       to decrease network traffic.  The file(s) will be copied from the
  234.       remote device to the local TEMPFILE subdirectory once and deleted.  
  235.  
  236.  
  237. PLUGS:
  238.   Software alpha tested on Rose and Crown BBS (615) 892-0097 
  239.   (>5GB, over 60,000 files, USR/DS, 1st call downloads).  Current 
  240.   version available.  Contact author, Nathan Hartwell, on this BBS, or 
  241.   RIME CD-ROM echo. 
  242.   
  243.   PSI Software:  Custom programming available.
  244.  
  245. Support BBS:
  246.   The Genetics Lab
  247.   SysOp: Tiberious Velnoq (aka Nathan Hartwell)
  248.   (615) 842-0852 - 24 hr/day - 12/2400 Baud
  249.   FidoNet 1:362/116.0 - PSI-Net 91:615/101.0
  250.   Latest version can be downloaded/file requested from this system.
  251.   Compuserve: 71451,300 - Internet: 71451.300@compuserve.com
  252.   
  253. -------------------------------------------------------------
  254. Further notes on PCBoard installation, (David Ellison, Sysop,
  255. Rose and Crown BBS) 
  256. RIME ->RCROWN     
  257. -------------------------------------------------------------
  258.  
  259. PCBoard SAMPLE BATCH FILES:
  260.   These are for COM2.  Change "port 2" to "port 1" for COM1
  261.  
  262. Zmodem send with DSZ:  PCBSZ.BAT   
  263.    echo off
  264.    if exist cds.log del cds.log
  265.    if exist pcberr.fil del pcberr.fil
  266.    if exist pcbdsz.log del pcbdsz.log
  267.    cds dsz.com handshake both port 2 pB4096 z sz %3
  268.  
  269. Zmodem receive with DSZ:  PCBRZ.BAT
  270.    echo off
  271.    if exist pcberr.fil del pcberr.fil
  272.    if exist pcbdsz.log del pcbdsz.log
  273.    dsz.com handshake both port 2 pB4096 z pr1 rz -p %3
  274.  
  275. Xmodem send with DSZ:   PCBSX.BAT 
  276.   echo off
  277.   if exist cds.log del cds.log
  278.   if exist pcberr.fil del pcberr.fil
  279.   if exist pcbdsz.log del pcbdsz.log
  280.   cds dsz.com handshake both port 2 pB4096 sx %3
  281.  
  282. Xmodem receive with DSZ:  PCBRX.BAT
  283.   echo off
  284.   if exist pcberr.fil del pcberr.fil
  285.   if exist pcbdsz.log del pcbdsz.log
  286.   dsz ha both port 2 pB4096 rx %3
  287.  
  288. Note: Be sure to change PCBPROT.DAT types (PCBSETUP, FILE LOCATIONS 
  289.   2).  "I" reflects internal, "D" is for DSZ.LOG (use for Zmodem 
  290.   protocol), "S" is for shelled protocols (use for Xmodem).  You 
  291.   shouldn't have any internal protocols left when you finish unless 
  292.   that particular node doesn't have access to the CD-ROM minichanger.  
  293.  
  294.   All protocols must be external, either shelled or DSZ.LOG 
  295.   supporting.  Use of the wrong type (D instead of S for example with 
  296.   Xmodem) can result in the filename not being passed to DSZ.  This 
  297.   will cause you a bit of lost time (like a weekend).  
  298.   
  299.   DSZ is exquisitely case sensitive, change the case in any of the 
  300.   above "dsz" lines and you'll have file transfer difficulties.  The 
  301.   above files do work on the Rose and Crown with Dual Standard 
  302.   modems, 16550 UARTS, and registered DSZ.  
  303.  
  304.   If you have questions about what is being 
  305.   passed to DSZ from PCBoard, put the following line in just above 
  306.   the dsz line in the batch file: 
  307.   echo %1 %2 %3 %4 %5 
  308.   You'll see exactly what's being passed on to DSZ by the BBS. 
  309.  
  310. With 1 or 2 Pioneer minichangers you can have 3.9 Gigabytes with a 6 disk 
  311. changer or 7.8 Gigabytes with 2 stacked changers.  For us, it is 
  312. definitely worth the trouble to set up.  Minichanger has been trouble 
  313. free since installation.
  314.  
  315.  
  316.