home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / ENTERPRS / CPM / TERMS / ZMODEM.ZIP / RZ.1 < prev    next >
Text File  |  1987-09-28  |  6KB  |  270 lines
  1. '\" Revision Level 
  2. '\" Last Delta     05-19-86
  3. .TH RZ 1 OMEN
  4. .SH NAME
  5. rb, rz \- XMODEM, YMODEM, ZMODEM (Batch) file receive
  6. .SH SYNOPSIS
  7. .B rz
  8. .RB [\- "\ 1bquv" ]
  9. .br
  10. .B rb
  11. .RB [\- "\ 1bquv" ]
  12. .br
  13. .B rz
  14. .RB [\- "\ 1bcquv" ]
  15. .I file
  16. .br
  17. .RB [ \- ][ v ] rzCOMMAND
  18. .SH DESCRIPTION
  19. This program uses error correcting protocol to receive
  20. files over a serial port from a variety of programs running under
  21. PC-DOS, CP/M,
  22. .SM Unix,
  23. and other operating systems.
  24.  
  25. The first form of
  26. .B rz
  27. (Receive Batch)
  28. receives files with ZMODEM batch protocol.
  29. If the sending program does not support ZMODEM,
  30. .B rz
  31. steps down to YMODEM protocol
  32. after 50 seconds.
  33. This delay can be eliminated by calling the program as
  34. .I rb .
  35.  
  36. .B Rb
  37. accepts either standard 128 byte sectors or
  38. 1024 byte sectors
  39. (YAM
  40. .B -k
  41. option).
  42. The user should determine experimentally
  43. the conditions under which use of 1k blocks
  44. actually improves throughput without causing
  45. problems.
  46.  
  47. Normally, the file contents are converted to
  48. .SM Unix
  49. conventions by stripping carriage returns and all characters
  50. beginning with Control Z (CP/M end of file).
  51. If the raw pathname ends in
  52. ".A",
  53. ".ARC",
  54. ".CCC",
  55. ".CL",
  56. ".CMD",
  57. ".COM",
  58. ".CRL",
  59. ".DAT",
  60. ".DIR",
  61. ".EXE",
  62. ".O",
  63. ".OBJ",
  64. ".OVL",
  65. ".PAG",
  66. ".REL",
  67. ".SAV",
  68. ".SUB",
  69. ".SWP",
  70. ".SYS",
  71. ".TAR",
  72. ".UTL",
  73. ".a",
  74. ".o",
  75. ".tar",
  76. or if the first packet contains
  77. data that suggest a binary file
  78. (parity bits or characters in the range 000 to 006 before the first ^Z),
  79. or if the file mode is transmitted and the 0100000
  80. bit is set, that file will be received in binary mode anyway.
  81. Otherwise,
  82. if the raw pathname ends in .MSG, or .TXT, an existing file will
  83. be appended to rather than replaced.
  84.  
  85. If extended file information (file length, etc.)
  86. is received,
  87. the file length controls the number of bytes written to
  88. the output dataset (YMODEM only),
  89. and the modify time and file mode
  90. (iff non zero)
  91. are set accordingly.
  92.  
  93. If no extended file information is received,
  94. slashes in the pathname are changed to underscore,
  95. and any trailing period in the pathname is eliminated.
  96. This conversion is useful for files received from CP/M systems.
  97. Normally, each file name is converted to lower case
  98. unless it contains one or more lower case letters.
  99.  
  100.  
  101. The second form of
  102. .B rz
  103. receives a single
  104. .I file
  105. with XMODEM protocol.
  106. The user must supply the file name to both sending and receiving programs.
  107.  
  108.  
  109. The third form of
  110. .B rz
  111. is invoked as
  112. .B rzCOMMAND
  113. (with an optional leading \- as generated by login(1)).
  114. For each received file,
  115. rz will pipe the file to ``COMMAND filename''
  116. where filename is the name of the transmitted file
  117. with the file contents as standard input.
  118.  
  119. Each file transfer is acknowledged when COMMAND exits with 0 status.
  120. A non zero exit status terminates transfers.
  121.  
  122. A typical use for this form is
  123. .I rzrmail
  124. which calls rmail(1)
  125. to post mail to the user specified by the transmitted file name.
  126. For example, sending the file "caf" from a PC-DOS system to
  127. .I rzrmail
  128. on a
  129. .SM Unix
  130. system
  131. would result in the contents of the DOS file "caf" being mailed to user "caf".
  132.  
  133. On some
  134. .SM Unix
  135. systems, the login directory must contain a link to
  136. COMMAND as login sets SHELL=rsh which disallows absolute
  137. pathnames.
  138. If invoked with a leading ``v'',
  139. .B rz
  140. will report progress to LOGFILE.
  141. The following entry works for
  142. .SM Unix
  143. 3.0:
  144. .ce
  145. rzrmail::5:1::/bin:/usr/local/rzrmail
  146. If the SHELL environment variable includes
  147. .I "rsh"
  148. or
  149. .I "rksh"
  150. (restricted shell),
  151. rz will not accept absolute pathnames
  152. or references to a parent directory,
  153. will not modify an existing file, and
  154. removes any files received in error.
  155.  
  156. If
  157. .B rz
  158. is invoked with stdout and stderr to different datasets,
  159. Verbose is set to 2, causing frame by frame progress reports
  160. to stderr.
  161. This may be disabled with the
  162. .B q
  163. option.
  164.  
  165. .PP
  166. The meanings of the available options are:
  167. .PP
  168. .PD 0
  169. .TP
  170. .B 1
  171. Use file descriptor 1 for ioctls and reads (Unix only).
  172. By default, file descriptor 0 is used.
  173. This option allows
  174. .B rz
  175. to be used with the
  176. .I cu
  177. ~$
  178. command.
  179. .TP
  180. .B b
  181. Transfer all files in binary
  182. (tell it like it is)
  183. mode.
  184. This option disables file append.
  185. .TP
  186. .B c
  187. Request 16 bit CRC
  188. (XMODEM file transfers default to 8 bit checksum).
  189. Batch transfers use 16 bit CRC.
  190. .TP
  191. .B D
  192. Output file data to /dev/null; for testing.
  193. .TP
  194. .B q
  195. Quiet suppresses verbosity.
  196. .TP
  197. .B v
  198. Verbose
  199. causes a list of file
  200. names to be appended to
  201. /tmp/rzlog .
  202. More v's generate more output.
  203. .TP
  204. .B u
  205. Retain upper case letters in file names.
  206. .PD
  207. .SH EXAMPLES
  208. .ne 6
  209. .RE
  210. (Pro-YAM command)
  211. .RS
  212. .I <ALT-2>
  213. .br
  214. YAM Command:
  215. .I "sz *.h *.c"
  216. .br
  217. (This automatically invokes
  218. .I rz
  219. on the connected system.)
  220. .RE
  221. .SH SEE ALSO
  222. ZMODEM.DOC,
  223. YMODEM.DOC,
  224. IMP(CP/M),
  225. cu(1),
  226. Professional-YAM manual,
  227. sz(omen),
  228. usq(omen),
  229. undos(omen)
  230.  
  231. Compile time options required
  232. for various operating systems are described in the
  233. source file.
  234. .SH BUGS
  235. Pathnames are restricted to 127 characters.
  236. In XMODEM single file mode, the pathname given on the command line
  237. is still processed as described above.
  238. The CR/LF to NL translation merely deletes CR\'s;
  239. undos(omen) performs a more intelligent translation.
  240. .SH "VMS VERSION"
  241. Some of the #includes with file names enclosed with angle brackets <>
  242. may need to have the angle brackets changed to "", or vice versa.
  243.  
  244. The VMS version does not set binary mode according to the incoming
  245. file type.
  246. Non binary file processing consists of stripping all characters beginning
  247. with CPMEOF (^Z).
  248.  
  249. The VMS version does not set the file time.
  250.  
  251. At high speeds,
  252. VMS sometimes loses incoming characters, resulting in retries
  253. and degradation of throughput.
  254.  
  255. The mysterious
  256. VMS C Standard I/O Package and RMS may interact to modify
  257. file contents unexpectedly.
  258.  
  259. The VMS version does not support invocation as
  260. .B rzCOMMAND .
  261. ZMODEM has not yet been implemented on the VMS version.
  262. .SH "ZMODEM CAPABILITIES"
  263. .B Rz
  264. supports incoming ZMODEM binary (-b), ASCII (-a), and append (-+)
  265. requests, and ZMODEM command execution.
  266. .SH FILES
  267. rz.c, rbsb.c, zm.c, zmodem.h source files.
  268.  
  269. /tmp/rzlog stores debugging output generated with -vv option.
  270.