home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / cmsoriginal / cmsv2hlp.txt < prev    next >
Text File  |  2020-01-01  |  12KB  |  305 lines
  1. .cs 1 on
  2. KERMIT
  3. .sp 2
  4. Kermit-CMS is a program that implements the KERMIT file transfer
  5. protocol for IBM 370-series mainframes running the VM/CMS operating
  6. system.  It allows for the transfer of files between computers over
  7. normal terminal communication lines (asynchronous ASCII lines attached
  8. to a 3705-style front end, such as the COMTEN) or a Series/1 running
  9. the Yale ASCII Terminal Communication System.  The program should also
  10. work on the IBM 7171 ASCII Device Control Unit and the 4994, although
  11. this has not been verified as of this writing.  For more details on
  12. this, see the section SET SERIES1.  The calling format for Kermit-CMS
  13. is:
  14. .sp 1
  15. .cs 1 off
  16. .cs 2 on
  17.         +----------------------------------+
  18.         |          |                       |
  19.         |  KERMIT  |  [kercmd ... kercmd]  |
  20.         |          |                       |
  21.         +----------------------------------+
  22.  
  23. where kercmd is a valid Kermit-CMS command.  If no Kermit commands are
  24. supplied, Kermit-CMS will issue a prompt and wait for instructions.
  25. Kermit may also be invoked with optional command line arguments.  In
  26. this case, Kermit will exit and return to CMS after completing the
  27. specified command or commands.  Several commands may be given on the
  28. command line as long as they are separated by the linend character.
  29. The command line may contain up to 130 characters.
  30. .sp 1
  31. .cs 2 off
  32. .cs 3 on
  33. Commands:
  34. .sp 2
  35. .of 8
  36. SEND <fn> <ft> [<fm>]
  37. .sp 1
  38. Send a file or file group from the CMS system to the Kermit on the
  39. remote system.  The wildcard characters "*" or "%" may be used.  A "*"
  40. matches any string of characters from the current position to the end
  41. of the field, including no characters at all; a "%" matches any single
  42. character.  If the input contains wildcard characters then all
  43. matching files will be sent.  If the optional filemode is omitted, a
  44. filemode of "*" is used.  In this case, the users disks are scanned
  45. according to the search order and the first occurrence of the file is
  46. the one that is sent.  If a file exists by the same name on more than
  47. one disk, only the first one encountered is sent.  The user may
  48. override the search order by specifying a filemode.
  49. .sp 1
  50. .of 8
  51. RECEIVE [<fn> <ft> [<fm>]]
  52. .sp 1 
  53. Receive a file or file group from the other system.  If the optional
  54. filename is not included, Kermit-CMS will use the name(s) provided by
  55. the other Kermit.  If that name is not a legal CMS file name,
  56. Kermit-CMS will delete excessive characters from it, and will change
  57. illegal characters to the letter "X".  Kermit-CMS supplies a default
  58. type of "X" if one is not provided by the remote system.  Use the file
  59. specification to indicate that the incoming file should be stored
  60. under a different name.  The filespec may include a filemode to
  61. designate the destination disk.  If none is provided, the file will be
  62. saved with filemode A1.  If you want to use the same name but a
  63. different filemode, specify "= = FM", where FM is the access mode of
  64. the destination disk.  Wildcards may not be used in any field.  If the
  65. optional filespec is provided, but more than one file arrives, the
  66. first file will be stored under the given filespec, and the remainder
  67. will be stored under their own names on the A disk.  If, however, 
  68. "= = FM" is used, all files will be placed onto the specified disk.
  69. .sp 1
  70. .of 8
  71. TAKE <fn> <ft> [<fm>]
  72. .sp 1
  73. Execute Kermit commands from the specified file. The command file may
  74. include TAKE commands.
  75. .sp 1
  76. .of 8
  77. SERVER
  78. .sp 1
  79. Kermit-CMS is capable of acting as a server.  The user connects to the
  80. CMS system once to set various options and to start the server.  From
  81. then on, he need not connect to the CMS system again.  The current
  82. version of Kermit-CMS can send files (the user on the other end types
  83. the GET command, using either a space or a period as the delimiter
  84. between filename, filetype, and filemode), receive files (the user
  85. types SEND), and terminate by either returning to CMS (user types
  86. FINISH) or logging the user out (user types BYE).  To put Kermit-CMS
  87. into server mode, first issue any desired SET commands to select
  88. various options and then issue the SERVER command.  Kermit-CMS will
  89. await all further instructions from the Kermit on the other end of the
  90. connection.
  91. .sp 1
  92. .of 8
  93. SET <parameter> <value>
  94. .sp 1
  95. Establish or modify various parameters for file transfer.  You can
  96. examine their values with the SHOW command.  Valid options are:
  97. .sp 1
  98. .in 8
  99. .of 8
  100. ATOE <num1 num2> 
  101. .sp 0
  102. Modify the ASCII-to-EBCDIC translate table used by Kermit-CMS to
  103. conform to your system.  Specify the offset of the ASCII value within
  104. the table and the new value for that location.  Both "num1" and
  105. "num2" should be between 0 and 255 (decimal).  Note that the table
  106. is twice as long as necessary because the translate instruction
  107. expects a table that contains 256 characters.
  108. .sp 1
  109. .of 8
  110. BLOCK <num>
  111. .sp 0
  112. Determine the type of block check used during file transfer.  Valid
  113. options for "num" are: 1 (for a one character checksum), 2 (for a two
  114. character checksum) and 3 (for a three character CRC).
  115. .sp 1
  116. .of 8
  117. DEBUG <ON | OFF>
  118. .sp 0
  119. If ON, keep a journal of all packets sent and received in the file KER
  120. LOG A1.  If the file already exists, it is overwritten.  If OFF, stop
  121. logging the packets.
  122. .sp 1
  123. .of 8
  124. END-OF-LINE <num>
  125. .sp 0
  126. If the remote system needs packets to be terminated by anything other
  127. than carriage return, specify the decimal value of the desired ASCII
  128. character.  "num" must be between 0 and 31 (decimal).
  129. .sp 1
  130. .of 8
  131. ETOA <num1 num2>
  132. .sp 0
  133. This command allows you to modify the EBCDIC-to-ASCII translate table
  134. used by Kermit-CMS to conform to your system.  Specify the offset of
  135. the EBCDIC value within the table and the new ASCII value for that
  136. location.  Both "num1" and "num2" should be between 0 and 255
  137. (decimal).
  138. .sp 1
  139. .of 8
  140. FILE <BINARY | TEXT>
  141. .sp 0
  142. If BINARY, CMS Kermit treats each character as a string of bits and
  143. does not perform translation on the data.  Also, carriage returns are
  144. not added to the end of outgoing records.  Incoming bytes are added to
  145. the end of the current record which is written out when the specified
  146. LRECL is reached.  If TEXT, CMS Kermit treats the file as plain text.
  147. ASCII-to-EBCDIC and EBCDIC-to-ASCII translation is performed on the
  148. data.  A carriage return-linefeed is appended to each outgoing record
  149. and is used to determine the end of each incoming record.
  150. .sp 1
  151. .of 8
  152. LRECL <num>
  153. .sp 0
  154. Set the logical record length for incoming files to a "num" from
  155. 1 to 65536 (64K).  This variable is used only for fixed format files.
  156. The default is 80.
  157. .sp 1
  158. .of 8
  159. PACKET-SIZE <num>
  160. .sp 0
  161. Use the specified "num" as the maximum length for incoming packets.
  162. The valid range is 26-94, where 94 is the default.
  163. .sp 1
  164. .of 8
  165. QUOTE <char>
  166. .sp 0
  167. Use the indicated printable character for prefixing (quoting) control
  168. characters and other prefix characters.  The only reason to change
  169. this would be for sending a very long file that contains very many
  170. "#" characters (the normal control prefix) as data.  It must be a
  171. single character in the range: 33-62, 96, or 123-126 (decimal).
  172. .sp 1
  173. .of 8
  174. RECFM <F | V>
  175. .sp 0
  176. Set the record format to use for incoming files, using "F" for fixed
  177. format and "V" for variable format.  The default is variable.
  178. .sp 1
  179. .of 8
  180. SERIES1 <ON | OFF>
  181. .sp 0
  182. Kermit-CMS automatically determines whether you are connected via a
  183. Series/1 emulation controller or a TTY line.  This command is provided
  184. though so you can override Kermit-CMS.  If SERIES1 is ON, Kermit
  185. disables the 3270 protocol conversion function by putting the Series/1
  186. into "transparent mode"; this allows Kermit packets to pass through
  187. the Series/1 intact.
  188. .sp 1
  189. .of 8
  190. WARNING <ON | OFF>
  191. .sp 0
  192. If the incoming file has the same name as a file that already exists,
  193. and WARNING is OFF, the original file will be overwritten.  If WARNING
  194. is set ON, Kermit-CMS will change the incoming name so as not to
  195. obliterate the pre-@|existing file.  It attempts to rename the file by
  196. replacing the first character with a dollar sign ("$").  If a file
  197. by that name exists, it also replaces the second character with a
  198. dollar sign.  It continues in this manner for all characters of the
  199. filename and filetype.
  200. .in 0
  201. .of 8
  202. SHOW <option>
  203. .sp 1
  204. Display the values of all parameters that can be changed with the SET
  205. command, except for ATOE and ETOA (see the TDUMP command).  "option"
  206. can be a particular parameter or the keyword "ALL".
  207. .sp 1
  208. .of 8
  209. STATUS
  210. .sp 1
  211. Return the status of the previous command.  The response will either
  212. display the message "Kermit completed successfully", or the last error
  213. encountered.
  214. .sp 1
  215. .of 8
  216. TDUMP <table-name>
  217. .sp 1
  218. Display the contents of "table-name" since it can be modified using
  219. the SET command.  The ATOE and ETOA tables can presently be 'dumped'.
  220. .sp 1
  221. .of 8
  222. CMS     Issue a CMS command from within Kermit-CMS.
  223. .sp 1
  224. .of 8
  225. CP      Issue a CP command from within Kermit-CMS.
  226. .sp 1
  227. .of 8
  228. HELP    Display a message that briefly explains Kermit-CMS commands.
  229. .sp 1
  230. .of 8
  231. EXIT    Exit from KERMIT back to the host operating system.
  232. .sp 1
  233. .of 8
  234. QUIT    Synonym for EXIT.
  235. .sp 1
  236. .of 8
  237. ?       List all legal Kermit-CMS commands.  
  238. .sp 2
  239. .of 0
  240. You may use the help ("?")  feature while typing Kermit-CMS commands.
  241. A question mark typed at almost any point in a command, followed by a
  242. carriage return, produces a brief description of what is expected or
  243. possible at that point.
  244. .sp 1
  245. .of 0
  246. Usage Notes:
  247. .sp 1
  248. .of 4
  249. 1.  When connecting to the CMS system as a TTY device ("line at a
  250. time" mode) several flags must first be set on the micro version of
  251. Kermit.  You should set the LOCAL-ECHO flag to ON (this is used to
  252. indicate half-duplex).  This is the norm but not true in every case;
  253. if each character appears twice, set the LOCAL-ECHO flag OFF.
  254. HANDSHAKE should be set to XON and FLOW-CONTROL should be set to NONE.
  255. The parity should be set according to the system's specifications.  On
  256. some micro versions of Kermit, all of the above is done in one step
  257. using the DO IBM macro (or SET IBM ON).  Set the baud rate to
  258. correspond to the line speed.
  259. .sp 1
  260. .of 4
  261. 2.  When connecting to the CMS system through the Series/1 terminal
  262. emulation controller ("full-screen" mode), certain flags must be set
  263. on the micro version of Kermit.  You should set the LOCAL-ECHO flag to
  264. OFF (this is used to indicate full-duplex).  HANDSHAKE should be set
  265. to OFF and FLOW-CONTROL should be set to XON/XOFF.  For most systems,
  266. the PARITY should be set to EVEN.  Set the baud rate to correspond to
  267. the line speed.  Immediately after issuing a SEND, RECEIVE or SERVER
  268. command to Kermit-CMS, the screen will be cleared.  This is to make
  269. sure the terminal is not stuck in a MORE or HOLDING state before
  270. packets are sent via the full-screen I/O operation.  After the file
  271. transfer is complete, and you re-connect to Kermit-CMS, you should
  272. enter the Series/1 "Master Reset" sequence (probably "CTRL-G") so that
  273. the screen is refreshed.
  274. .sp 1
  275. .of 4   
  276. 3.  Three CP SET parameters MSG, IMSG and WNG are always set OFF during
  277. the actual file transfer (and restored afterwards) to prevent CP from
  278. interrupting any I/O in progress.
  279. .sp 1
  280. .of 4   
  281. 4.  When receiving files, if the record format is fixed, any record
  282. longer than the logical record length will be split up to as many
  283. records as necessary.  If the record format is variable, the record
  284. length can be as high as 64K.  For sending files, the maximum
  285. record length is 64K.
  286. .sp 1
  287. .of 4
  288. 5.  The current version of Kermit-CMS does not support timeouts.
  289. The user, therefore, should hit the carriage return key after a
  290. long period of inactivity (that is, when the screen display does
  291. not change.)
  292. .sp 1
  293. .of 4
  294. 6.  When sending packets to Kermit-CMS, the micro must use a
  295. carriage return as the end-of-line character.  Both TTY and
  296. Series/1 connections require a carriage return to terminate a read
  297. from the terminal; thus, if any other character is used, Kermit-CMS
  298. will never get the packets.
  299. .sp 0
  300. .of 0
  301. .cs 3 off
  302.  
  303.  
  304.  
  305.