home *** CD-ROM | disk | FTP | other *** search
/ C/C++ Interactive Guide / c-cplusplus-interactive-guide.iso / c_ref / csource4 / 260_01 / sz.doc < prev    next >
Text File  |  1988-02-25  |  7KB  |  163 lines
  1. SZ(1)OMEN                                                            SZ(1)OMEN
  2.  
  3.         
  4. NAME
  5.         sz - XMODEM, YMODEM, ZMODEM Batch file Send
  6.         
  7.  
  8. SYNOPSIS
  9.         sz [-2+aBbdefkLlNnquvYy] [-s<speed>] [-] file ...
  10.         sz [-2+aBbdefkLlNnquvXy] [-s<speed>] [-] file
  11.         sz [-2Beqv] [-s<speed>] -c COMMAND
  12.         
  13.         
  14. DESCRIPTION
  15.         Sz uses the ZMODEM, YMODEM or XMODEM error correcting protocol
  16.         to send one or more files over a serial port to a variety of
  17.         programs running under PC-DOS, CP/M, Unix, VMS, and other
  18.         operating systems.  
  19.  
  20.         The first form of sz sends one or more files with ZMODEM or
  21.         YMODEM batch protocol. Normally, only the file name part of
  22.         the pathname is transmitted. On Unix systems, additional
  23.         information about the file is transmitted. If the receiving
  24.         program uses this information, the transmitted file length
  25.         controls the exact number of bytes written to the output dataset,
  26.         and the modify time and file mode are set accordingly.  
  27.  
  28.         The a option causes the receiver to convert Unix newlines to
  29.         PC-DOS carriage returns and linefeeds.  
  30.  
  31.         The second form of uses the flag -X to send a single file with
  32.         XMODEM or XMODEM-1k protocol. The user must supply the file name
  33.         to both sending and receiving programs.  
  34.  
  35.         The third form sends a single COMMAND to the receiver for execution.
  36.         Sz exits with the COMMAND return value. If COMMAND includes spaces
  37.         or characters special to the shell, it must be quoted.  
  38.  
  39.         If sz is invoked with stdout and stderr to different datasets,
  40.         Verbose is set to 2, causing frame by frame progress reports to
  41.         stderr.  This may be disabled with the q option. The meanings of
  42.         the available options are:  
  43.         
  44.         +       Instruct the receiver to append transmitted data to an
  45.                 existing file (ZMODEM only).
  46.         
  47.         2       Use COM2 instead of COM1 (MS-DOS only). By default,
  48.                 COM1 is used. 
  49.         
  50.         a       Convert NL characters in the transmitted file to CR/LF.
  51.                 This is done by the sender for XMODEM and YMODEM, by the
  52.                 receiver for ZMODEM. 
  53.         
  54.         b       (ZMODEM) Binary override: transfer file without any
  55.                 translation.
  56.         
  57.         c COMMAND Send COMMAND to the receiver for execution, return
  58.                 with COMMAND's exit status.
  59.         
  60.         d       Change all instances of "." to "/" in the transmitted
  61.                 pathname. Thus, C.omenB0000 (which is unacceptable to
  62.                 MSDOS or CP/M) is transmitted as C/omenB0000. If the
  63.                 resultant filename has more than 8 characters in the stem,
  64.                 a "." is inserted to allow a total of eleven.
  65.         
  66.         f       Normally directory prefixes are stripped from the 
  67.                 transmitted filename. 
  68.         
  69.         i COMMAND Send COMMAND to the receiver for execution, return
  70.                 Immediately upon the receiving program's successful
  71.                 reception of the command.
  72.         
  73.         k       (XMODEM/YMODEM) Send files using 1024 byte blocks rather
  74.                 than the default 128 byte blocks. 1024 byte packets speed
  75.                 file transfers at high bit rates. (ZMODEM streams the data
  76.                 for the best possible throughput.) 
  77.         
  78.         L N     Use ZMODEM sub-packets of length N. A larger N 
  79.                 (32 <= N <= 1024) gives slightly higher throughput, a
  80.                 smaller N speeds error recovery. The default is 128 below
  81.                 300 baud, 256 above 300 baud, or 1024 above 2400 baud.
  82.         
  83.         l N     Wait for the receiver to acknowledge correct data every
  84.                 (32 <= N <= 1024) characters. This may be used to avoid
  85.                 network overrun when XOFF flow control is lacking.
  86.         
  87.         n       (ZMODEM) Send each file if destination file does not exist. 
  88.                 Overwrite destination file if source file is newer or longer
  89.                 than the destination file.
  90.         
  91.         N       (ZMODEM)  Send each file if destination file does not exist.
  92.                 Overwrite destination file if source file has different
  93.                 length or date.
  94.         
  95.         o       (ZMODEM) Disable automatic selection of 32 bit CRC.
  96.         
  97.         p       (ZMODEM) Protect existing destination files by skipping
  98.                 transfer if the destination file exists.
  99.         
  100.         q       Quiet suppresses verbosity.
  101.         
  102.         r       Resume interrupted file transfer. If the source file is
  103.                 longer than the destination file, the transfer commences
  104.                 at the offset in the source file that equals the length
  105.                 of the destination file.
  106.         
  107.         t tim   Change timeout to tim tenths of seconds.
  108.         
  109.         u       Unlink the file after successful transmission.
  110.         
  111.         v       Verbose causes a list of file names to be appended to
  112.                 /tmp/szlog. More v's generate more output.  
  113.         
  114.         X       Send a single file with XMODEM or XMODEM-1k protocol. 
  115.         
  116.         Y       Send a single file with YMODEM batch protocol. 
  117.         
  118.         y       Instruct a ZMODEM receiving program to overwrite any
  119.                 existing file with the same name.  
  120.  
  121.         
  122. SEE ALSO
  123.         rz(omen), ZMODEM.DOC, YMODEM.DOC, Professional-YAM manual,
  124.         IMP(CP/M), cu(1), sq(omen), todos(omen), tocpm(omen),
  125.         tomac(omen), yam(omen) 
  126.  
  127.  
  128. BUGS
  129.         XMODEM transfers add up to 127 garbage bytes per file (1023 bytes
  130.         with XMODEM-k). Most YMODEM programs use the  file length transmitted
  131.         at the beginning of the transfer to prune the file to the correct
  132.         length; this may cause problems with source files that grow during
  133.         the course of the transfer. This problem does not pertain to ZMODEM
  134.         transfers, which preserve the exact file length unconditionally.  
  135.  
  136.         Most ZMODEM options are merely passed to the receiving program;
  137.         some do not implement all these options.  
  138.  
  139.         Circular buffering and a ZMODEM sliding window should be used when
  140.         input is from pipes instead of acknowledging frames each 1024 bytes.
  141.  
  142.         If no files can be opened, sz sends a ZMODEM command to echo a
  143.         suitable complaint; perhaps it should check for the presence of
  144.         at least one accessible file before getting hot and bothered.
  145.         The test mode leaves a zero length file on the receiving system.  
  146.  
  147.         Some high speed modems have a firmware bug that drops characters
  148.         when the direction of high speed transmissson is reversed.
  149.         The environment variable  ZNULLS may be used to specify the number
  150.         of nulls to send before a ZDATA frame. Values of 101 for a 4.77 mHz
  151.         PC and 124 for an AT are typical.  
  152.  
  153.         Some versions of Unix cu(1) do not operate properly with this program.
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.