home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / comm / pr_ra2g2.zip / PROTO_RA.TXT < prev    next >
Text File  |  1993-03-22  |  18KB  |  404 lines

  1.  
  2.                 P r o t o _ R A   2 . 0 0
  3.                       Gamma Version
  4.  
  5. Mon  03-22-1993  22:17:44
  6.  
  7. NOTE:
  8. Major changes from 1.11!  Includes PROTOCOL.111 to keep some
  9. older protocols that I have dropped available for
  10. experimentation for those so inclined.
  11.  
  12. This is a compendium on the use of external protocols with
  13. RemoteAccess.  With this are sample PROTOCOL.RA that must
  14. be modified for use with your system.  Both use GSZ.EXE, so
  15. if you prefer DSZ.COM, you will have to make those changes.
  16. PROTOCOL.111 is largely for instruction and information; do
  17. NOT use it as is, as some things have changed for 2.00.
  18. PROTOCOL.200 must be renamed to PROTOCOL.RA and edited for
  19. your system setup before use as well.
  20.  
  21. All protocols must be set up first according to their own
  22. documentation.  Any special notes are included below, but
  23. the basic thing to remember is that you MUST set up the
  24. protocol to write a log file, and it must (of course) be the
  25. same name as the log file used in PROTOCOL.RA.
  26.  
  27. The PROTOCOL.RA samples assume you are running single node,
  28. with all protocols in the system directory.  They require a
  29. complete path if elsewhere, or (of course) if you run
  30. multinode.  With a few changes in commands, all will have
  31. enough space to fit the path in, with the exception of
  32. SZModem.  Since it MUST have /DORINFO 1 in version 1.60 and
  33. up, there is not enough room for a long path, so I have as
  34. an example \RA\ only.
  35.  
  36. Note that these are set for locked bps (mine is at 38400),
  37. and must be edited for other systems.  TEST ALL PROTOCOLS;
  38. what works on one system may not work on another, and vice
  39. versa!
  40.  
  41. I have also included a sample .cfg file for FileDoor 3.10
  42. Public Gamma version, which works fine with RA 2.00 Gamma 1.
  43.  
  44. 1) Protocols that work with BPS locked at 38400:
  45.  
  46.  A) DSZ, GSZ
  47.  
  48. These work in all modes, except (in RA 1.01) for single file
  49. protocol modes (Xmodem and derivatives) for uploads.  This
  50. problem is due to RA passing only the path as # on the
  51. command line, and is fixed in RA 1.10/1.11/2.00.
  52.  
  53. The only difference between DSZ and GSZ is the name of the
  54. executable (DSZ.COM or DSZ.EXE versus GSZ.EXE) and that for
  55. display speed you may want to add pV1 just before the
  56. protocol command (e.g., pV1 sz).  GSZ.EXE and DSZ.COM
  57. support file sharing; DSZ.EXE does not.  DSZ.EXE and GSZ.EXE
  58. support up to a 16k pB buffer command, while DSZ.COM is
  59. limited to 4k.  My recommendation is to use the default
  60. unless, as Chuck Forsberg says, you are bloody well sure you
  61. need the pB command!
  62.  
  63. They will also only work for uploads if you have them
  64. registered, as the unregistered versions will not accept a
  65. received file into a pathed directory.  See TXZModem and
  66. VirtualZmodem (in PROTOCOL.200) below for alternatives if
  67. you do not have a registered copy of DSZ and/or GSZ.
  68.  
  69. You must set DSZLOG in your environment as well, and use the
  70. log for PROTOCOL.RA.
  71.  
  72. Some special modes are not practical, but will work.  These
  73. are the modes that DSZ uses only to recieve.  Among these
  74. are ro (Overthruster), rx -g (Xmodem-k-g) and rb -g
  75. (Ymodem-g).  This also includes rc (Xmodem CRC/Xmodem-k
  76. CRC), but rx will also receive CRC.  Now, the thing to do is
  77. use the more generic form to send, and assume the receiver
  78. knows he must use the proper form to get the protocol
  79. desired.  For ro, use sx; for rx -g use sx -k; for rb -g,
  80. use sb -k.  An example for Xmodem Overthruster, with the
  81. proper windowing for packet-switched networks, is included.
  82.  
  83. Another oddball is Zmodem compressed, as it is set on the
  84. SENDING side with sz -Z.  Use the standard rz to receive.
  85.  
  86.  B) MPt (formerly Puma)
  87.  
  88. Works just fine, but you must set the DSZ-type log in
  89. MPTSET.  I suggest using MPT.LOG myself, to separate it
  90. from DSZ.  No real other comments!
  91.  
  92.  C) TASY
  93.  
  94. You must set TLOG in your environment, and use version 4.19
  95. of TASY.  This is a error correcting connection protocol
  96. only, and should be so set.  Later versions do not seem to
  97. work right, and earlier ones had no log.  Seems very fast!
  98.  
  99.  D) SZModem
  100.  
  101. READ THE DOCS and set this one up only after you have them
  102. mastered!  It will use whatever you have set for DSZLOG in
  103. the environment, and the /CFGPATH must point to where the
  104. szmodem.cfg resides.  1.60 and up must be used, as
  105. they work more as they should in regards to the /cfgpath and
  106. DSZ environmental variables.  SZModem as of version 1.50
  107. still uses only uppercase Z to indicate transfers in either
  108. direction, rather than the correct z for send and Z for
  109. receive. Version 1.60 and 2.00+ correct this problem.
  110.  
  111. Occasional modems or conditions will result in status
  112. Unknown transfers, which return no transfer.  Perhaps the
  113. author will reverse this and assume success rather than
  114. failure on such transfers in the future, as for the most
  115. part they ARE successful, and users will be able to leech a
  116. file or two as is once in a while <grin>.
  117.  
  118. SZModem 1.60 and 2.00 fix the DSZ.LOG problem.  It also
  119. stores all config data in the executable.  The dorinfo1.def
  120. processing, though, has to be specified on the commandline,
  121. though the path is set in the configuration. For multinode,
  122. this may well allow such use, as the default dir will be the
  123. place SZModem will look for the dorinfo1.def file.  The
  124. examples given in the sample PROTOCOL.200 files use this new
  125. version; for other added commandline options, see the
  126. FileDoor.Cfg (though you will have to eliminate the
  127. /FIDOAREA for lack of room).
  128.  
  129.  E) SKHST
  130.  
  131. Though SuperK will also work, this is easier to set up and
  132. has new features to make it work a LOT better as a BBS
  133. protocol.  If you do not register, it will die after 30
  134. days.  DO REGISTER it, but if you need more time, you can
  135. reinstall after deleting a hidden file in the root dir of
  136. your hard disk that it creates (name looks like ascii
  137. garbage).
  138.  
  139. The single modes will not work for ULs in RA 1.01 for the
  140. same reason as some DSZ modes, the # character not passing
  141. the path AND filename to the protocol.  Fixed in RA 1.10.
  142.  
  143. With version 1.06, SKHST will try on the receiving end to
  144. match the batch mode send of the remote.  This means if they
  145. make a mistake and use the wrong mode, it will still receive
  146. the file.  Since it cannot match the other way, you still
  147. need the sending modes you want to support.  I recommend the
  148. modes I have in PROTOCOL.RA as they support the ProComm
  149. brain-dead WXModem (whoever heard of a window of 1 block?),
  150. and the old SuperK batch modes.
  151.  
  152. YOU MUST set up SKHST to NOT delete its transfer file!  The
  153. default is to delete it, and since RA tries to delete it as
  154. well, this does not work well!  If you have SHARE loaded,
  155. you will get a violation and a crash.  Also be sure to set
  156. the full path of the log and xfer files in the protocol
  157. setup and in PROTOCOL.RA.  The xfer list file can be
  158. XFER.TXT with the path, or some other; the commandline
  159. overrides the protocol's set xfer list name.  I use
  160. XFER.TXT, myself.
  161.  
  162. By the way, the Jmodem mode of SKHST does not work for me,
  163. for whatever reason, neither in FileDoor nor in RA's
  164. externals.  If it did, it could replace the "real" Jmodem
  165. that does not write a log and thus cannot be used at
  166. present.
  167.  
  168.  F) PCZ - ONLY IN PROTOCOL.111
  169.  
  170. Not reliable for RA 2.00, because of the logging problems
  171. (see below).  I have retained this for information only.
  172.  
  173. The freeware PCZ works well, with some limitations.  The
  174. zmodem mode will accept a DL path, unlike unregistered DSZ.
  175. There is no Ymodem-g or Xmodem-k-g mode, but it does include
  176. an implementation of SEAlink in addition to xmodem,
  177. xmodem-1k, and ymodem.
  178.  
  179. Do not use the DIRXX setting, at least not with the 4.09.90
  180. version of PCZ.  The commandline does not reliably override
  181. the set command.  Do use the Set PCZLOG variable, and use
  182. normal DOS methods (e.g., set pczlog=c:\ra\pcz.log).  Locked
  183. at 38400, the internal flow control seems to break down with
  184. the lower speeds, so the F (fossil) setting is needed.  You
  185. should then, if the fossil is locked, pass the DCE as *b to
  186. the protocol so the time calculations are correct.  You may
  187. wish to advise your users of this as well, and tell them to
  188. load BNU and lock the port, run PCZ, and unload BNU, if they
  189. run at 38400.
  190.  
  191. The only other problem is that the logging PCZ does is
  192. ambiguous to RA's scanning method.  If an aborted transfer
  193. takes place with exactly 1 error, RA will find the 1 for the
  194. logged error, assume the xfer went ok, report it as
  195. complete, and then find the day of the week as the filename.
  196. No harm done, but rather confusing to the user.  The author
  197. is being made aware of this, and either it will be fixed or
  198. perhaps RA can scan for a string including spaces (1  sz for
  199. a zmodem send, for example) in a future version to make it
  200. unambiguous.
  201.  
  202. One other note concerns PCZ's errorlevel generation, not
  203. directly of concern for PROTOCOL.RA use.  The zmodem and
  204. ymodem (not sure about xmodem and xmodem-1k) work correctly,
  205. but the SEAlink seems to always return an errorlevel of 1
  206. (failure).  This has to do with its correctly sending the
  207. EOF, but not the EOT, I believe, or not responding correctly
  208. to the receiving end.  The SEAlink implemention also does
  209. not include SLO (SEAlink Overdrive) and is not very reliable
  210. at 9600 DCE rates.  However, it is MORE reliable than ZSX at
  211. 2400 and below, especially with a non-error correcting
  212. connection.  I have used it therefore for SEAlink.  I have
  213. also used it for Super_Z, a variant similar to DSZ's
  214. MobyTurbo, a faster zmodem than usual CRC32 is.
  215.  
  216.  G) ZSX - ONLY IN PROTOCOL.111
  217.  
  218. This no longer works with RA 2.00.  Since it logs both sends
  219. and recieves with the SAME letter, RA does not distinquish
  220. between the two when checking for bidirectional protocols!
  221. I have left this in for informational purposes, in case the
  222. author corrects this problem.
  223.  
  224. ZSX includes xmodem, xmodem-1k, ymodem, ymodem-g, zmodem,
  225. SEAlink, and SLO (SEAlink Overdrive).  It is not crippled in
  226. any way, and uses the fossil for all communications.  It
  227. uses the DSZLOG environmental variable.  All modes use the
  228. lowercase protocol letter to log success (that is, s for
  229. SEAlink and SLO, z for zmodem, g for ymodem-g, etc.).  The
  230. limitations I have found to date are that it will not accept
  231. the new v.32bis rates as the speed parameter (since it uses
  232. the locked fossil, there is really no reason this must be
  233. this way, and perhaps will be changed in the future) and it
  234. sometimes sends some characters to the remote after a
  235. tranfer is complete, so the user may find themselves not
  236. where they thought once in a while ;-)
  237.  
  238. For whatever reason, it does NOT seem to work well at lower
  239. speeds without error correction in SEAlink mode, at least
  240. not when locked at 38400 bps.  The SLO mode, on the other
  241. hand, works ok, except at 2400/ARQ on uploads.  Thus, I have
  242. used it for SLO, but disabled it in the samples.  It *may*
  243. work just fine on another system, though!
  244.  
  245. The other modes do not seem to share the SEAlink problems,
  246. although my testing has been somewhat limited.  Have fun!
  247.  
  248. Registration is a postcard to the author.  If you cannot
  249. register DSZ, this is a viable alternative as well!
  250.  
  251.  H) Hyperprotocol
  252.  
  253. An odd log file is created by Hyperprotocol, but it can be
  254. read by RA in most cases.  The actual outcome is in TWO
  255. "words", the first and last, so aborts may not always be
  256. recognized by RA.  The bigger problem is that it can only be
  257. used to upload to a specific directory, as RA replaces #
  258. with the upload directory WITH a trailing backslash, and
  259. this confuses Hyperp, which will lock up the machine at
  260. times.  IF you only use a single upload directory, this will
  261. work fine; otherwise, wait until Hilgraeve fixes it!  The
  262. latest I know about, 1.1f, has this problem.  You must have
  263. an option file like HYP.OPT for it to work, in the same dir
  264. as the hyper.exe:
  265.  
  266. DISPLAY:OFF
  267. HANDSHAKE:RTS/CTS
  268. LOGFILE:C:\RA\HYP.LOG
  269.  
  270.  I) TXZmodem
  271.  
  272. Straightforward setup, nice screen display, and works fine
  273. passing an upload directory.  The only thing you will need
  274. to do is hex edit the executable to change the TXZLOG to
  275. DSZLOG, as explained in the documentation for the protocol,
  276. or get a patched copy from someone else.  The author does
  277. NOT wish such patched copies posted for download as his
  278. original archive.  A nice way to get zmodem (other than the
  279. internal version) in RA.
  280.  
  281.  J) Visual Zmodem
  282.  
  283. A beta version of this protocol, lacking the promised Kermit
  284. functions, is available.  This is a nice graphic X/Y/Zmodem
  285. driver, very simple to install, which works fine.
  286.  
  287.  K) Kermit (Visual Z implementation)
  288.  
  289. Included in the PROTOCOL.200, this will not work with the
  290. present beta version.  The setup is here for future use.
  291.  
  292.  L) Hydra
  293.  
  294. This works perfectly in RA's external protocols setup, and
  295. the 1.03 version works fine in FileDoor as well. The .cfg
  296. file defaults are fine, except you may wish to specify the
  297. locked (DTE) rate, and RTS/CTS handshaking by default, to
  298. shorten the commandline to what will fit in PROTOCOL.RA.
  299. This is how the version is set up in this example.  Note
  300. well the use of ! rather than # in the DL command line.
  301. Also note that you might want to specify an alternate upload
  302. area in your FILES.RA for all areas for bidirectional
  303. protocols like this.  The h and H of the 1.03 Hydracom are
  304. used for the dl/ul keywords.  You will have to change those
  305. to H and R if you have v1.00, and that version will NOT work
  306. with FileDoor!
  307.  
  308.  M) HS/Link
  309.  
  310. The command line given works fine, with no need for a
  311. separate .cfg file generated by HSCONFIG.  The same notes
  312. apply to this regarding the ! on the DL command line and
  313. alternate upload areas as for Hydra, the other bidirectional
  314. protocol in this example.
  315.  
  316. 2) Random notes on a lot of other protocols:
  317.  
  318. Protocols that do not write a log will not work.  Perhaps
  319. this can be added to RA at some time, to use errorlevel 0
  320. for success and 1 for failure in lieu of a log file.  Some
  321. good ones are in this group, including Jmodem.  Translink
  322. and HyperDrive would appear also to work if I can find
  323. versions with bugs fixed (the former limits the path an
  324. filename to about 16 characters, the latter I cannot find a
  325. whole copy!).  These all work with 38400 locking as well.
  326.  
  327. BiModem is very complicated to add securely to a bbs
  328. package, so it has not been implemented.  Standalone
  329. programs exist to run it, and FileDoor and others also
  330. support it.
  331.  
  332. Tmodem, the X, Y, Z, and Zmax cousins of Tmodem, and Zyrion
  333. all are to avoided, in my opinion.  They will work at 38400
  334. locked, and do write log files.  However, (except Zyrion)
  335. they all ask for an odd -b parameter.  This seems to be the
  336. DCE rather than the DTE, which must be set in the
  337. environment with a set COMx= command.  With v.32bis CONNECT
  338. codes, this breaks down.  They seem to demand 9600 as the
  339. "baud" rate, which is neither the DTE of 38400 nor the DCE
  340. of 14400.  Appeals for explanation and help have netted
  341. nothing, and I am a registered Tmodem user.  In addition,
  342. Tmodem has several incompatible versions (under 2.0,
  343. 2.0-3.x, 5.0-6.3, 6.4, and now 7.0, NONE of which work with
  344. any others outside their own group), and now that is
  345. extended to the X, Y, Z, and Zmax versions as well.  In
  346. versions under 7.0, the log is written in the default
  347. directory only, which could present problems.  The basic
  348. support does not exist unless registered, and if you
  349. register, the support consists of telling you it works fine
  350. with Isis/Osiris (being as nice as I can be here!).
  351.  
  352. rC-Modem does not work at 38400, or any locked BPS, as far
  353. as I can tell.  NModem does not either, but I am not too
  354. sure if it works at all.  I have been unable to get it to
  355. work, in any case.
  356.  
  357. PC-Kermit barely works as 19200, dies at 38400, and does not
  358. write a log.  Megalink works at 19200, not at 38400, and
  359. also does not write a log.  Clink works fine at 38400, but
  360. does not write a log, and will not accept a path to receive
  361. a file, making it useless even if errorlevel support is
  362. added someday.  It does work with FileDoor, though, if you
  363. do not have philosophical objections to running it at all!
  364.  
  365. Punter does not work locked, not write a log.  Quicktran is
  366. the same, and is terribly slow with archived files anyway.
  367.  
  368. The old Friel Imodem is not even supported by Qmodem any
  369. more, so I suggest you do the same!  Odds are it does not
  370. work locked at 38400, and I know it does not write a log
  371. file.  It also is slower for error correcting transfers than
  372. other g protocols.
  373.  
  374. MSKermit is an OK terminal package, but a horror to use as
  375. an external protocol.  It likes to claim the comm ports as
  376. its own, a bad thing when running under a BBS!
  377.  
  378. I have not tried all the Opus specific protocols, but see
  379. little there to get excited about.  For the sake of
  380. completeness, I will do it someday.  I have tested oKermit
  381. 1.04, which would not work for me at all, though Peter
  382. Janssen runs it.
  383.  
  384. While not an exhaustive list of protocols, I think this
  385. reflects most of those available today.  I think the
  386. internal RA external protocol support could easily work with
  387. all reliable protocols with the addition, some day, of
  388. errorlevel support to the logfile support it has now.
  389.  
  390. I hope this is of use to someone!  Comments, additions, and
  391. all are welcome.  Hopefully this can be the beginning of an
  392. ongoing project to provide protocol installation information
  393. for RA.
  394.  
  395. The files herein contained are only guaranteed to occupy
  396. diskspace, and blah blah (usual disclaimer).
  397.  
  398. Bob R.
  399. 1:154/40@fidonet.org
  400. The Anonymous BBS
  401. Fussville, WI
  402. 414-251-2580
  403.  
  404.