lsz.1
上传用户:tianjinjs
上传日期:2007-01-05
资源大小:309k
文件大小:16k
源码类别:

Modem编程

开发平台:

Unix_Linux

  1. '"
  2. '" Revision Level 
  3. '" Last Delta     04-21-88
  4. .TH SZ 1 2.6.1996 lrzsz-0.12b
  5. .SH NAME
  6. sx, sb, sz - XMODEM, YMODEM, ZMODEM file send
  7. .SH SYNOPSIS
  8. sz
  9. .RB [- +8abdefkLlNnopqTtuvyY ]
  10. .I file ...
  11. .br
  12. sb
  13. .RB [- adfkqtuv ]
  14. .I file ...
  15. .br
  16. sx
  17. .RB [- akqtuv ]
  18. .I file
  19. .br
  20. sz
  21. .RB [- oqtv ]
  22. .B "-c COMMAND"
  23. .br
  24. sz
  25. .RB [- oqtv ]
  26. .B "-i COMMAND"
  27. .br
  28. sz -TT
  29. .SH DESCRIPTION
  30. .B Sz
  31. uses the ZMODEM, YMODEM or XMODEM error correcting protocol to send
  32. one or more files over a dial-in serial port to a variety of programs running under
  33. PC-DOS, CP/M, Unix, VMS, and other operating systems.
  34. While
  35. .I rz
  36. is smart enough to be called from
  37. .I cu(1),
  38. very few versions of
  39. .I cu(1)
  40. are smart enough to allow
  41. .I sz
  42. to work properly.
  43. Unix flavors of Professional-YAM are available for such dial-out application.
  44. .B Sz
  45. sends one or more files with ZMODEM protocol.
  46. ZMODEM
  47. greatly simplifies file transfers compared to XMODEM.
  48. In addition to a friendly user interface, ZMODEM
  49. provides Personal Computer and other users
  50. an efficient, accurate, and robust file transfer method.
  51. ZMODEM provides complete
  52. .B "END-TO-END"
  53. data integrity between application programs.
  54. ZMODEM's 32 bit CRC catches errors
  55. that sneak into even the most advanced networks.
  56. Advanced file management features include
  57. AutoDownload (Automatic file Download initiated without user intervention),
  58. Display of individual and total file lengths and transmission time estimates,
  59. Crash Recovery,
  60. selective file transfers,
  61. and preservation of
  62. exact file date and length.
  63. Output from another program may be piped to
  64. .B sz
  65. for transmission by denoting standard input with "-":
  66. .ce
  67. ls -l | sz -
  68. The program output is transmitted with the filename sPID.sz
  69. where PID is the process ID of the
  70. .B sz
  71. program.
  72. If the environment variable
  73. .B ONAME
  74. is set, that is used instead.
  75. In this case, the Unix command:
  76. .ce
  77. ls -l | ONAME=con sz -ay -
  78. will send a "file" to the PC-DOS console display.
  79. The
  80. .B -y
  81. option instructs the receiver to open the file for writing unconditionally.
  82. The
  83. .B -a
  84. option
  85. causes the receiver to convert Unix newlines to PC-DOS carriage returns
  86. and linefeeds.
  87. .B Sb
  88. batch sends one or more files with YMODEM or ZMODEM protocol.
  89. The initial ZMODEM initialization is not sent.
  90. When requested by the receiver,
  91. .B sb
  92. supports
  93. .B YMODEM-g
  94. with "cbreak" tty mode, XON/XOFF flow control,
  95. and interrupt character set to CAN (^X).
  96. .B YMODEM-g
  97. (Professional-YAM
  98. .B g
  99. option)
  100. increases throughput over error free channels
  101. (direct connection, X.PC, etc.)
  102. by not acknowledging each transmitted sector.
  103. On
  104. .SM Unix
  105. systems, additional information about the file is transmitted.
  106. If the receiving program uses this information,
  107. the transmitted file length controls the exact number of bytes written to
  108. the output dataset,
  109. and the modify time and file mode
  110. are set accordingly.
  111. .B Sx
  112. sends a single
  113. .I file
  114. with
  115. .B XMODEM
  116. or
  117. .B XMODEM-1k
  118. protocol
  119. (sometimes incorrectly called "ymodem").
  120. The user must supply the file name to both sending and receiving programs.
  121. If
  122. .B sz
  123. is invoked with $SHELL set and iff that variable contains the
  124. string
  125. .I "rsh"
  126. ,
  127. .I "rbash"
  128. or
  129. .I "rksh"
  130. (restricted shell),
  131. .B sz
  132. operates in restricted mode.
  133. Restricted mode restricts pathnames to the current directory and
  134. PUBDIR (usually /usr/spool/uucppublic) and/or subdirectories
  135. thereof.
  136. The fourth form sends a single COMMAND to a ZMODEM receiver for execution.
  137. .B Sz
  138. exits with the COMMAND return value.
  139. If COMMAND includes spaces or characters special to the shell,
  140. it must be quoted.
  141. The fifth form sends a single COMMAND to a ZMODEM receiver for execution.
  142. .B Sz
  143. exits as soon as the receiver has correctly received the command,
  144. before it is executed.
  145. The sixth form (sz -TT)
  146. attempts to output all 256 code combinations to the terminal.
  147. In you are having difficulty sending files,
  148. this command lets you see which character codes are being
  149. eaten by the operating system.
  150. If
  151. .B sz
  152. is invoked with stdout and stderr to different datasets,
  153. Verbose is set to 2, causing frame by frame progress reports
  154. to stderr.
  155. This may be disabled with the
  156. .B q
  157. option.
  158. .PP
  159. The meanings of the available options are:
  160. .PP
  161. .PD 0
  162. .TP
  163. .B "-+, --append"
  164. Instruct the receiver to append transmitted data to an existing file
  165. (ZMODEM only).
  166. .TP 
  167. .B "-2, --twostop"
  168. use two stop bits (if possible). Do not use this unless you know
  169. what you are doing.
  170. .TP
  171. .B "-8, --try-8k"
  172. Try to go up to 8KB blocksize. This is incompatible with standard zmodem,
  173. but a common extension in the bbs world. (ZMODEM only).
  174. .TP
  175. .B "--start-8k"
  176. Start with 8KB blocksize. Like --try-8k.
  177. .TP
  178. .B "-a, --ascii"
  179. Convert NL characters in the transmitted file to CR/LF.
  180. This is done by the sender for XMODEM and YMODEM, by the receiver
  181. for ZMODEM.
  182. .TP
  183. .B "-b, --binary"
  184. (ZMODEM) Binary override: transfer file without any translation.
  185. .TP
  186. .B "-B NUMBER, --bufsize NUMBER"
  187. Use a readbuffer of 
  188. .B NUMBER
  189. bytes. Default ist 16384, which should be enough
  190. for most situations. If you have a slow machine or a bad disk interface
  191. or suffer from other hardware problems you might want to increase
  192. the buffersize.
  193. .B -1
  194. or
  195. .B auto
  196. use a buffer large enough to buffer the whole file. Be careful with this
  197. option - things normally get worse, not better, if the machine starts
  198. to swap.
  199. Using this option turns of memory mapping of the input file. This
  200. increases memory and cpu usage.
  201. .TP
  202. .B "-c COMMAND, --command COMMAND"
  203. Send COMMAND to the receiver for execution, return with COMMAND's exit status.
  204. .TP
  205. .B "-C N, --command-tries N"
  206. Retry to send command N times (default: 11).
  207. .TP
  208. .B "-d, --dot-to-slash"
  209. Change all instances of "." to "/" in the transmitted pathname.
  210. Thus, C.omenB0000 (which is unacceptable to MSDOS or CP/M)
  211. is transmitted as C/omenB0000.
  212. If the resultant filename has more than 8 characters in the stem,
  213. a "." is inserted to allow a total of eleven.
  214. This option enables the 
  215. .B "--full-path"
  216. option.
  217. .TP
  218. .B "--delay-startup N"
  219. Wait
  220. .B N
  221. seconds before doing anything.
  222. .TP
  223. .B "-e, --escape"
  224. Escape all control characters;
  225. normally XON, XOFF, DLE, CR-@-CR, and Ctrl-X are escaped.
  226. .TP 
  227. .B"-E, --rename"
  228. Force the sender to rename the new file if a file with the same
  229. name already exists.
  230. .TP
  231. .B "-f, --full-path"
  232. Send Full pathname.
  233. Normally directory prefixes are stripped from the transmitted
  234. filename.
  235. This is also turned on with to 
  236. .B "--dot-to-slash"
  237. option.
  238. .TP
  239. .B "-h, --help"
  240. give help.
  241. .TP
  242. .B "-i COMMAND, --immediate-command COMMAND"
  243. Send COMMAND to the receiver for execution, return immediately
  244. upon the receiving program's successful recption of the command.
  245. .TP
  246. .B "-k, --1k"
  247. (XMODEM/YMODEM) Send files using 1024 byte blocks
  248. rather than the default 128 byte blocks.
  249. 1024 byte packets speed file transfers at high bit rates.
  250. (ZMODEM streams the data for the best possible throughput.)
  251. .TP
  252. .B "-L N, --packetlen N"
  253. Use ZMODEM sub-packets of length N.
  254. A larger N (32 <= N <= 1024) gives slightly higher throughput,
  255. a smaller N speeds error recovery.
  256. The default is 128 below 300 baud, 256 above 300 baud, or 1024 above 2400 baud.
  257. .TP 
  258. .B "-m N, --min-bps N"
  259. Stop transmission if BPS-Rate (Bytes Per Second) falls below N for a 
  260. certain time (see --min-bps-time option).
  261. .TP
  262. .B "-M N, --min-bps-time"
  263. Used together with --min-bps. Default is 120 (seconds).
  264. .TP
  265. .B "-l N, --framelen N"
  266. Wait for the receiver to acknowledge correct data every
  267. .B N
  268. (32 <= N <= 1024)
  269. characters.
  270. This may be used to avoid network overrun when XOFF flow control is lacking.
  271. .TP
  272. .B "-n, --newer"
  273. (ZMODEM) Send each file if
  274. destination file does not exist.
  275. Overwrite destination file if
  276. source file is newer than the destination file.
  277. .TP
  278. .B "-N, --newer-or-longer"
  279. (ZMODEM) Send each file if
  280. destination file does not exist.
  281. Overwrite destination file if
  282. source file is newer or longer than the destination file.
  283. .TP
  284. .B "-o, --16-bit-crc"
  285. (ZMODEM) Disable automatic selection of 32 bit CRC.
  286. .TP
  287. .B "-O, --disable-timeouts"
  288. Disable read timeout handling. This makes lsz hang if the other side
  289. doesn't send anything, but increases performance (not much) and
  290. decreases system load (reduces number of system calls by about 50
  291. percent).
  292. Use this option with care.
  293. .TP
  294. .B "-p, --protect"
  295. (ZMODEM) Protect existing destination files by skipping transfer if the
  296. destination file exists.
  297. .TP
  298. .B "-q, --quiet"
  299. Quiet suppresses verbosity.
  300. .TP
  301. .B "-R, --restricted"
  302. Restricted mode: restricts pathnames to the current directory and
  303. PUBDIR (usually /usr/spool/uucppublic) and/or subdirectories
  304. thereof.
  305. .TP
  306. .B "-r, --resume"
  307. (ZMODEM) Resume interrupted file transfer.
  308. If the source file is longer than the destination file,
  309. the transfer commences at the offset in the source file that equals
  310. the length of the destination file.
  311. .TP
  312. .B "-s HH:MM, --stop-at HH:MM"
  313. Stop transmission at
  314. .B HH 
  315. hours, 
  316. .B MM
  317. minutes. Another variant, using 
  318. .B +N 
  319. instead of 
  320. .B HH:MM,
  321. stops transmission in
  322. .B N
  323. seconds.
  324. .TP
  325. .B "-S, --timesync"
  326. enable timesync protocol support. See timesync.doc for further 
  327. information.
  328. This option is incompatible with standard zmodem. Use it with care.
  329. .TP
  330. .B "--syslog[=off]"
  331. turn syslogging on or off. the default is set at configure time.
  332. This option is ignored if no syslog support is compiled in.
  333. .TP
  334. .B "-t TIM, --timeout TIM"
  335. Change timeout to
  336. .I TIM
  337. tenths of seconds.
  338. .TP
  339. .B "-T, --turbo"
  340. Do not escape certain characters (^P, ^P|0x80, telenet escape sequence
  341. [CR + @]). This improves performance by about 1 percent and shouldn't
  342. hurt in the normal case (but be careful - ^P might be useful if connected
  343. through a terminal server).
  344. .TP
  345. .B "-u"
  346. Unlink the file after successful transmission.
  347. .TP
  348. .B "-U, --unrestrict"
  349. Turn off restricted mode (this is not possible if running under a 
  350. restricted shell).
  351. .TP
  352. .B "-w N, --windowsize N"
  353. Limit the transmit window size to N bytes (ZMODEM).
  354. .TP
  355. .B "-v, --verbose"
  356. Verbose output to stderr. More v's generate more output.
  357. .TP
  358. .B "-X, --xmodem"
  359. use XMODEM protocol.
  360. .TP
  361. .B "-y, --overwrite"
  362. Instruct a ZMODEM receiving program to overwrite any existing file
  363. with the same name.
  364. .TP
  365. .B "-Y, --overwrite-or-skip"
  366. Instruct a ZMODEM receiving program to overwrite any existing file
  367. with the same name,
  368. and to skip any source files that do have a file with the same
  369. pathname on the destination system.
  370. .TP
  371. .B "--ymodem"
  372. use ZMODEM protocol.
  373. .TP
  374. .B "-Z, --zmodem"
  375. use ZMODEM protocol.
  376. .PD
  377. .SH SECURITY
  378. Restricted mode restricts pathnames to the current directory
  379. and PUBDIR (usually /var/spool/uucppublic)
  380. and/or subdirectories thereof, and disables remote command
  381. execution.
  382. Restricted mode is entered if the 
  383. .B R
  384. option is given or if lsz detects that it runs under a restricted
  385. shell or if the environment variable ZMODEM_RESTRICTED is found.
  386. Restricted mode can be turned of with the 
  387. .B U
  388. option if not running under a restricted shell.
  389. .SH ENVIRONMENT
  390. .TP
  391. .B ZNULLS
  392. may be used to specify the number of nulls to send before a ZDATA frame.
  393. .TP
  394. .B SHELL
  395. lsz recognizes a restricted shell if this variable includes
  396. .I "rsh"
  397. or
  398. .I "rksh"
  399. .TP
  400. .B ZMODEM_RESTRICTED
  401. lrz enters restricted mode if the variable is set.
  402. .TP
  403. .B TMPDIR
  404. If this environment variable is set its content is used as the 
  405. directory to place in the answer file to a 
  406. .B timesync 
  407. request.
  408. .B TMP
  409. Used instead of TMPDIR if TMPDIR is not set. If neither TMPDIR nor
  410. TMP is set /tmp will be used.
  411. .SH EXAMPLES
  412. .ne 7
  413. .B "ZMODEM File Transfer"
  414. (Unix to DSZ/ZCOMM/Professional-YAM)
  415. .br
  416. .B "% sz -a *.c"
  417. .br
  418. This single command transfers all .c files in the current Unix directory
  419. with conversion
  420. .RB ( -a )
  421. to end of line conventions appropriate to the receiving environment.
  422. With ZMODEM AutoDownload enabled, Professional-YAM  and ZCOMM
  423. will automatically recieve
  424. the files after performing a security check.
  425. .br
  426. .B "% sz -Yan *.c *.h"
  427. .br
  428. Send only the .c and .h files that exist on both systems,
  429. and are newer on the sending system than the
  430. corresponding version on the receiving system, converting Unix to
  431. DOS text format.
  432. .br
  433. .B
  434. $ sz -\Yan file1.c file2.c file3.c foo.h baz.h
  435. .R
  436. (for VMS)
  437. .br
  438. .B "ZMODEM Command Download"
  439. (Unix to Professional-YAM)
  440. .br
  441.  cpszall:all
  442.     sz -c "c:;cd /yam/dist"
  443.     sz -ya $(YD)/*.me
  444.     sz -yqb y*.exe
  445.     sz -c "cd /yam"
  446.     sz -i "!insms"
  447. .br
  448. This Makefile fragment uses
  449. .B sz
  450. to issue commands to Professional-YAM to change current disk and directory.
  451. Next,
  452. .B sz
  453. transfers the
  454. .I .me
  455. files from the $YD directory, commanding the receiver to overwrite the old files
  456. and to convert from Unix end of line conventions to PC-DOS conventions.
  457. The third line transfers some
  458. .I .exe
  459. files.
  460. The fourth and fifth lines command Pro-YAM to
  461. change directory and execute a PC-DOS batch file
  462. .I insms .
  463. Since the batch file takes considerable time, the
  464. .B "-i"
  465. form is used to allow
  466. .B sz
  467. to exit immediately.
  468. .B "XMODEM File Transfer"
  469. (Unix to Crosstalk)
  470. .br
  471. %
  472. .B "sx -a foo.c"
  473. .br
  474. .B "ESC"
  475. .br
  476. .B "rx foo.c"
  477. .br
  478. The above three commands transfer a single file
  479. from Unix to a PC and Crosstalk with
  480. .I sz
  481. translating Unix newlines to DOS CR/LF.
  482. This combination is much slower and far less reliable than ZMODEM.
  483. .SH ERROR MESSAGES
  484. "Caught signal 99"
  485. indicates the program was not properly compiled,
  486. refer to "bibi(99)" in rbsb.c for details.
  487. .SH SEE ALSO
  488. rz(omen),
  489. ZMODEM.DOC,
  490. YMODEM.DOC,
  491. Professional-YAM,
  492. crc(omen),
  493. sq(omen),
  494. todos(omen),
  495. tocpm(omen),
  496. tomac(omen),
  497. yam(omen)
  498. Compile time options required for various operating systems are described in
  499. the source file.
  500. .SH "VMS VERSION"
  501. The VMS version does not support wild cards.
  502. Because of VMS DCL, upper case option letters muse be represented
  503. by \ proceding the letter.
  504. The current VMS version does not support XMODEM, XMODEM-1k, or YMODEM.
  505. VMS C Standard I/O and RMS may interact to modify the file contents.
  506. .SH FILES
  507. 32 bit CRC code courtesy Gary S. Brown.
  508. sz.c, crctab.c, rbsb.c, zm.c, zmodem.h Unix source files
  509. sz.c, crctab.c, vrzsz.c, zm.c, zmodem.h, vmodem.h, vvmodem.c,
  510. VMS source files.
  511. /tmp/szlog stores debugging output (sz -vv)
  512. (szlog on VMS).
  513. .SH "TESTING FEATURE"
  514. The command "sz -T file"
  515. exercises the
  516. .B Attn
  517. sequence error recovery by commanding
  518. errors with unterminated packets.
  519. The receiving program should complain five times about
  520. binary data packets being too long.
  521. Each time
  522. .B sz
  523. is interrupted,
  524. it should send a ZDATA header followed by another defective packet.
  525. If the receiver does not detect five long data packets,
  526. the
  527. .B Attn
  528. sequence is not interrupting the sender, and the
  529. .B Myattn
  530. string in
  531. .B sz.c
  532. must be modified.
  533. After 5 packets,
  534. .B sz
  535. stops the "transfer" and
  536. prints the total number of characters "sent" (Tcount).
  537. The difference between Tcount and 5120 represents the number of characters
  538. stored in various buffers when the Attn sequence is generated.
  539. .SH BUGS
  540. Calling
  541. .I sz
  542. from most versions of cu(1) doesn't work because cu's receive process
  543. fights
  544. .I sz
  545. for characters from the modem.
  546. On at least one BSD system, sz would hang or exit when it got within
  547. a few kilobytes of the end of file.
  548. Using the "-w 8192" flag fixed the problem.
  549. The real cause is unknown, perhaps a bug in the kernel TTY output routines.
  550. Programs that do not properly implement the specified file transfer protocol
  551. may cause
  552. .I sz
  553. to "hang" the port for a minute or two.
  554. This problem is corrected by using
  555. ZCOMM, Pro-YAM, or other program with a correct implementation
  556. of the specified protocol.
  557. Many programs claiming to support YMODEM only support XMODEM with 1k blocks,
  558. and they often don't get that quite right.
  559. XMODEM transfers add up to 127 garbage bytes per file.
  560. XMODEM-1k and YMODEM-1k transfers use 128 byte blocks
  561. to avoid extra padding.
  562. YMODEM programs use the file length transmitted at the beginning of the
  563. transfer to prune the file to the correct length; this may cause problems with
  564. source files that grow during the course of the transfer.
  565. This problem does not pertain to ZMODEM transfers, which preserve the exact
  566. file length unconditionally.
  567. Most ZMODEM options are merely passed to the receiving program;
  568. some do not implement all these options.
  569. Circular buffering and a ZMODEM sliding window should be used
  570. when input is from pipes instead of acknowledging frames each 1024 bytes.
  571. If no files can be opened,
  572. .B sz
  573. sends a ZMODEM command to echo a suitable complaint;
  574. perhaps it should check for the presence of at least one accessible file before
  575. getting hot and bothered.
  576. The test mode leaves a zero length file on the receiving system.
  577. A few high speed modems have a firmware bug that drops characters when the
  578. direction of high speed transmissson is reversed.
  579. The environment variable ZNULLS may be used to specify the number of nulls to
  580. send before a ZDATA frame.
  581. Values of 101 for a 4.77 mHz PC and 124 for an AT are typical.