home *** CD-ROM | disk | FTP | other *** search
/ Vectronix 2 / VECTRONIX2.iso / FILES_09 / GSZRZ5_9.LZH / GSZRZ.REG / GSZRZENG.TXT < prev    next >
Text File  |  1995-10-07  |  37KB  |  1,030 lines
  1. GSZRZ ZMODEM Program package for the Atari ST/STE/TT/Falcon
  2. ========================================================================== 
  3.       
  4. Published by:
  5. -------------
  6. XENIA Software
  7. Michael Ziegler
  8. Jagdfeldring 16
  9. D-85540 Haar
  10. Germany
  11.  
  12. Email: Michael Ziegler @M in MausNet
  13.  
  14.  
  15. UK Support by:
  16. --------------
  17. Joe Connor
  18. 65 Mill Road
  19. Colchester
  20. Essex
  21. CO4 5LJ
  22. England
  23.  
  24. Email: jconnor@cix.compulink.co.uk
  25.  
  26.  
  27.  
  28. EXEMPTION FROM LIABILITY
  29. --------------------------------------------------------------------------
  30.  
  31. The programs have been tested exhaustively. Neither XENIA Software nor any 
  32. agent I appoint is liable for any damages resulting from the use or misuse 
  33. of any of the programs in the GSZRZ package.
  34.  
  35. Whilst I will try to resolve any problems you may experience my liability, 
  36. and that of any agents I appoint, for any loss or consequential loss you 
  37. may suffer due to the use of any programs in the GSZRZ package is strictly 
  38. limited to refunding your shareware fee.
  39.  
  40. - All trademarks used are recognised and acknowledged.
  41. - All trademarks mentioned in the documentation are acknowledged and 
  42.   recognised.
  43.  
  44.  
  45.  
  46. OVERVIEW
  47. --------
  48.  
  49. The GSZRZ program package comprises the X/Y/ZMODEM file transfer protocols
  50. for the Atari ST/STE/TT/Falcon computers.
  51.  
  52. The programs can be used in conjunction with almost any communication
  53. program.
  54.  
  55. The transfer status is displayed in a dialog window. When leaving the 
  56. program, the final message is written to STDERR output. If GSZRZ is used 
  57. in conjunction with Michael Bernards' RUFUS or Wolfgang Wander's CoNnect, 
  58. this message is written to the terminal window.
  59.  
  60. GSZRZ can be used under MultiTOS and MAG!X.
  61.  
  62.  
  63.  
  64. FILES
  65. -----
  66.  
  67. The GSZRZ program package consists of the following files:
  68.  
  69. GSZRZ_30.PRG   Atari TT/Falcon version of the accessory or GEM program.
  70.                Cannot be used on an ATARI ST!
  71. GSZRZ_ST.PRG   Atari ST version of the accessory or GEM program.
  72. GSZRZENG.TXT   This documentation.
  73. HISTORY.ENG    GSZRZ history file, English since v5.0.
  74. GACCTEST.ZIP   Example Pure-C source code to call GSZRZ as an accessory.
  75. HSMODAxx.LZH   Archive of Harun Scheutzow's excellent serial patch for all
  76.                Ataris.
  77.  
  78. The GEM (PRG) programs can be used as accessory programs by renaming the 
  79. files with the ACC extension.
  80.  
  81.  
  82.  
  83.  
  84. INSTALLATION
  85. --------------------------------------------------------------------------
  86.  
  87. The installation depends on the communication program used. Here are some
  88. hints for installing with RUFUS.
  89.  
  90. If your computer has enough memory available, you can install GSZRZ as
  91. an accessory: Copy GSZRZ_xx.ACC as GSZRZACC.ACC into the root directory,
  92. use the slot ZMODEM in RUFUS' dialog box 'Protokoll', and save the
  93. parameters using 'Parameter sichern'.
  94.  
  95. If you want to use the TT/FALCON accessory, you have to rename it or
  96. enter the line ACCNAME=GSZRZ_30.ACC into the file RUFUS.RUF.
  97.  
  98. This will not be necessary with CoNnect as it can search for the ACC's
  99. name. In CoNnect, you simply click on the button 'ACC suchen' in the 
  100. dialog box Transfer. If GSZRZ_xx.ACC can be found, CoNnect will enter its 
  101. name accordingly.
  102.  
  103. If you want to use GSZRZ as a PRG, you have to rename the accessory to
  104. GSZRZ_xx.PRG and copy it into RUFUS' module directory. In RUFUS' dialog 
  105. box 'Protokoll', enter a free slot, enter a protocol name, choose type 
  106. EXTERN. At 'Sender', choose GSZRZxxx.PRG by clicking on the name. At 
  107. 'Parameter', enter '-sz' and other parameters as needed separated by 
  108. blanks. Then, at 'Empfänger', choose GSZRZxxx.PRG by clicking on the name. 
  109. At 'Parameter', enter '-rz' and other parameters as needed separated by 
  110. blanks. Save the parameters using 'Parameter sichern'.
  111.  
  112. To use GSZRZ with HARLEKIN III, GSZRZ_xx.ACC has to be renamed to
  113. GSZRZACC.ACC and copied into the root directory of the boot partition. In
  114. 'Optionen' 'ZMODEM' activate 'externes Modul anwenden'. In 'Senden' and
  115. 'Empfangen' you have to enter '-M', at least in HARLEKIN version 3.0 (see
  116. TROUBLE.TXT). The parameters '-sz' and '-rz' are added by HARLEKIN.
  117.  
  118. MultiTOS
  119. --------
  120.  
  121. If you work with MultiTOS and GSZRZ is not used as a program and if 
  122. another serial device then MODEM1 is used, then you must specify the -H 
  123. parameter!
  124.  
  125.  
  126. COMMAND LINE PARAMETERS
  127. --------------------------------------------------------------------------
  128.  
  129. Please note that the case of the parameters is important (e.g., '-g' is
  130. different from '-G') and always use the parameters exactly as indicated.
  131. Multiple parameters have to be separated by spaces (see the examples
  132. below). File name have to be given AFTER the last parameter. If you're
  133. using CoNnect, the '$' has to be the last character of the parameters for
  134. sending.
  135.  
  136. GSZRZ contains routines for sending and receiving. To tell GSZRZ to send 
  137. or to receive, the FIRST parameter has to be '-sz' or '-rz'. If you are 
  138. using GSZRZ as an accessory in conjunction with RUFUS or CoNnect, this 
  139. will be done for you by RUFUS/CoNnect automatically.
  140.  
  141. If you don't specify the parameter '-a', all transfers will be performed 
  142. in binary mode.
  143.  
  144. GSZRZ' ZMODEM routines default to the fastest transfer rate possible. If
  145. the phone line is rather noisy and you don't use MNP/V42, it is safer to
  146. specify block acknowledge mode by the parameter '-l 1024' (see parameter 
  147. -l for sending). This will however slow down the transfer somewhat.
  148.  
  149.  
  150.  
  151.  
  152. PARAMETERS FOR RECEIVING
  153. ------------------------
  154.  
  155. Translation of incoming newline characters
  156.  
  157. -a             This function is used in transferring ASCII files e.g. from
  158.                UNIX systems to the ATARI. Incoming newline characters are
  159.                translated into carriage return/line feed sequences.
  160.  
  161.  
  162. Include protocol end into CPS rate
  163.  
  164. -A             At the end of a file transmission an acknowledge between
  165.                sender and receiver is done. Some people want to include 
  166.                this in the final calculation of the CPS rate.
  167.                If -A is set, the last CPS-rate is calculated after the
  168.                acknowledge.
  169.  
  170.  
  171. Receive buffer size
  172.  
  173. -b SIZE        This parameter is used to specify the size of the receive
  174.                buffer of the serial interface. SIZE indicates the buffer's
  175.                size in bytes. The default value of 1024 bytes should be
  176.                sufficient for most cases.
  177.  
  178.                SIZE: default 1024 bytes, minimum 128, maximum 16384
  179.                      The receive buffer can be completely disabled using 
  180.                      the setting: -b 0
  181.                                          
  182.  
  183.  
  184. Use CRC with XMODEM
  185.  
  186. -c             If this parameter is specified, the XMODEM routines use a 
  187.                16 bit CRC instead of a simple checksum. While this is 
  188.                safer, don't expect every XMODEM protocol program to be 
  189.                able to work in this mode.
  190.  
  191.  
  192. Suppress carrier detect
  193.  
  194. -D             If this parameter is specified, the monitoring of the
  195.                carrier detect line will be suppressed.
  196.  
  197.  
  198. Escaping of control characters
  199.  
  200. -e             If this parameter is specified, the 'escaping' of all
  201.                control characters will be performed. (Often used in
  202.                UNIX systems)
  203.  
  204.  
  205. File buffer size
  206.  
  207. -F SIZE        This parameter specifies the size of the file buffer. When
  208.                receiving a file, all incoming characters are stored in a
  209.                buffer. Whenever this buffer fills, it will be written to
  210.                the hard disk/floppy disk. As this affects the transfer
  211.                rate, this buffer's size can be specified. SIZE indicates
  212.                the size of the buffer in bytes, the suffixes 'K' and 'M'
  213.                indicate kilobyte and megabyte, e.g. '-F 16K' and '-F 2M'.
  214.                '-F -1' results in a buffer that uses all available RAM
  215.                except 100 KB.
  216.  
  217.                SIZE: default 8192 bytes, minimum 1024 bytes
  218.  
  219.  
  220. Stream mode in XMODEM/YMODEM
  221.  
  222. -g             If this parameter is specified, XMODEM and YMODEM transfers
  223.                will use the stream mode, i.e. the acknowledging of each
  224.                data block will be suppressed. Usually, after receiving
  225.                every data block an acknowledgement is returned to the
  226.                sender to signal that the block has been received
  227.                successfully. If the connection is reliable (MNP5, V42bis),
  228.                the transfer rate can be increased by omitting these
  229.                acknowledgements.
  230.  
  231.  
  232. Audible indication of the end of the transfer
  233.  
  234. -G             The end of the transfer will be indicated by an audible
  235.                signal ('ping').
  236.  
  237.  
  238. Serial device
  239.  
  240. -H n           With this parameter You can select a serial device. This is
  241.                useful, if GSZRZ is used as accessory under MultiTOS.
  242.  
  243.  
  244.                      ST           MSTE      TT      FALCON
  245.                 1   AUX           AUX      AUX       AUX
  246.                 3   MIDI          MIDI     MIDI      MIDI
  247.                 6   MODEM1        MODEM1   MODEM1    -
  248.                 7   -             MODEM2   MODEM2    MODEM2
  249.                 8   -             SERIAL2  SERIAL1   SERIAL2/LAN
  250.                 9   -             -        SERIAL2   -
  251.  
  252.  
  253.  
  254. Iconify the GSZRZ window on startup
  255.  
  256.     -I x,y      With this parameter it is possible (only with MultiTOS 
  257.                 with AES version > 4.0) to iconify the window of GSZRZ 
  258.                 already at startup and position the window at x,y (min. 
  259.                 position: 1,1). If MultiTOS isn't used, the normal Window 
  260.                 is placed at this position.
  261.  
  262.  
  263. Log file
  264.  
  265. -L [x:\path\]filename.ext[,level]
  266.                Log all activities to the file specified.
  267.                On level 1, for each transmitted file an entry
  268.                to the file specified using the following format:
  269.  
  270.     SZ: HISTORY.TXT  Len:    20408 Tim: 00.00.18 Err:  0 CPS: x
  271.     RZ: ANSI.SYS     Len:     1709 Tim: 00.00.02 Err:  0 CPS: x
  272.     ^^  ^                    ^          ^              ^
  273.     ||  file name            bytes      duration       error code
  274.     |X/Y/Z protocol
  275.     S or R for Send / Receive
  276.  
  277.                 On level 2, each message displayed on the line
  278.                 'last status/error' is written to the logfile too.
  279.  
  280.  
  281. Use MIDI interface
  282.  
  283. -m             If this parameter is specified, the transfer will be
  284.                performed via MIDI interface. If GSZRZ is used as an
  285.                accessory in conjunction with RUFUS, this parameter
  286.                is added by RUFUS and must not be specified
  287.                (see example below).
  288.  
  289.  
  290. Disable mouse interrupt
  291.  
  292. -M             This parameter disables the mouse interrupt during the
  293.                transfer. Use this parameter if moving the mouse disturbs
  294.                the file transfer. In addition, this parameter causes the
  295.                AES multitasking to be disabled to achieve maximum data
  296.                rates on the ST.
  297.  
  298.  
  299. Reaction to existing file names:
  300.  
  301.                In the YMODEM and ZMODEM protocols, the file name is
  302.                specified by the sender. If a file of that name already
  303.                exists, the receiver's reaction can be specified.
  304.  
  305. -o FILE.EXT    The file name specified by the sender will be replaced by
  306.                FILE.EXT. CAUTION: You cannot specify a path here!
  307.  
  308. -p             The receiver will send SKIP to the sender and the file will 
  309.                not be transferred. CAUTION: lower case 'p'!
  310.  
  311. -E             The extension of the ALREADY EXISTING file will be changed
  312.                to .001, if that one is already existing to .002 etc.
  313.  
  314. -y             The existing file will be deleted.
  315.  
  316. -r             If the sender can handle it, a CRC check is done on the 
  317.                existing part of the file. If the CRC's are identical, 
  318.                transmission is resumed. If the file CRC's are different or 
  319.                the sender can't handle a CRC verification, an alert with 
  320.                the following possibilities is displayed:
  321.  
  322.                Rename:  Enter a new filename for the file to receive
  323.                Delete:  Delete the existing file
  324.                Abort:   Abort the receive
  325.  
  326. -rr            If the sender can handle it, a CRC check is done on the 
  327.                existing part of the file. If the CRC's are identical, the 
  328.                transmission is resumed. If the file CRC's are different or 
  329.                the sender can't handle a CRC verification, a Resume is 
  330.                carried out.
  331.  
  332. -ry            If the sender can handle it, a CRC check is done on the 
  333.                existing part of the file. If the CRC's are identical, the 
  334.                transmission is resumed. If the file CRC's are different or 
  335.                the sender can't handle a CRC verification, the existing 
  336.                file is deleted.
  337.     
  338. -rp            If the sender can handle it, a CRC check is done on the 
  339.                existing part of the file. If the CRC's are identical, the 
  340.                transmission is resumed. If the file CRC's are different or 
  341.                the sender can't handle a CRC verification, the receive is 
  342.                skipped.
  343.  
  344. -rE            If the sender can handle it, a CRC check is done on the 
  345.                existing part of the file. If the CRC's are identical, the 
  346.                transmission is resumed. If the file CRC's are different or 
  347.                the sender can't handle a CRC verification, the extension 
  348.                of the ALREADY EXISTING file will be changed to .001, if 
  349.                that one is already existing to .002 etc.
  350.     
  351. -ro FILE.EXT   If the sender can handle it, a CRC check is done on the 
  352.                existing part of the file. If the CRC's are identical, the 
  353.                transmission is resumed. If the file CRC's are different or 
  354.                the sender can't handle a CRC verification, the file name 
  355.                specified by the sender will be replaced by the filename 
  356.                given on FILE.EXT. CAUTION: You cannot specify a path here!
  357.  
  358. If none of these parameters are in affect, an alert box is displayed in 
  359. the way a different CRC is handled.
  360.  
  361.  
  362. Specify the download directory
  363.  
  364. -P PATH        This parameter specifies the target directory. If this
  365.                parameter has not been specified, all files received will 
  366.                be stored in the current directory.
  367.  
  368.                If a file with path affixed to the file name is received, a
  369.                possible drive specifier will be stripped off. The 
  370.                remaining path will be appended to the current path or, if 
  371.                a path was specified by '-P', to the specified path.
  372.  
  373.                Example: Let C:\MAIL\DOWNLOAD be the current directory.
  374.                Receive a file J:\TEST\XYZ\FILE.EXT. The file stored will
  375.                be:
  376.                without '-P':
  377.                  C:\MAIL\DOWNLOAD\TEST\XYZ\FILE.EXT
  378.                with '-P D:\RECEIVE':
  379.                  D:\RECEIVE\TEST\XYZ\FILE.EXT
  380.  
  381.                Non-existent directories will be created.
  382.  
  383. -d             If this parameter is specified, possible paths on the
  384.                incoming file names will be stripped off. This safety
  385.                precaution should be used with bulletin board systems 
  386.                (BBS).
  387.  
  388.  
  389. Suppress outputs to STDERR when leaving GSZRZ
  390.  
  391. -q             If this parameter is specified, the output of the final
  392.                message to STDERR will be suppressed. Use this in
  393.                conjunction with communication programs that do not 
  394.                redirect STDERR.
  395.  
  396.  
  397. Resume an interrupted transfer
  398.  
  399. -r             With this parameter, the sender tells the receiver that 
  400.                it's possible to handle a CRC protected resume.
  401.  
  402.  
  403. Set the file date
  404.  
  405. -s             Set the file date of the file received to the current date.
  406.                This can be useful in BBS programs.
  407.  
  408.  
  409. Output the CPS rate to STDERR
  410.  
  411. -S             If this parameter is specified, the CPS rate will be 
  412.                written to STDERR at the end of the transfer.
  413.  
  414.  
  415. Set the time-out time
  416.  
  417. -t TIM         This parameter sets the time-out time to TIM/10 seconds. It
  418.                has been implemented as some BBS take rather long to set up
  419.                a ZMODEM transfer. Usually, there should be no problems 
  420.                with the default value of 100 (i.e. 10 seconds). Minimum 
  421.                10, maximum 1000.
  422.  
  423.  
  424. Setting the priority (MultiTOS only)
  425.  
  426. -v pri          Set priority if running with  MTOS. 
  427.                 Default: +20, min: -20, max: +20
  428.  
  429. Protocol for receiving
  430.  
  431.                The default protocol used is ZMODEM. If you want to use one
  432.                of the other protocols, specify one of these parameters:
  433.  
  434. -X             Use XMODEM protocol
  435.  
  436. -Y             Use YMODEM protocol
  437.  
  438.  
  439.  
  440. Checking the on-line time
  441.  
  442. -U time        on-line time remaining
  443. -C baud rate   actual baud rate
  444.  
  445.                For the usage in BBS programs, the checking of the on-line
  446.                time was implemented (key word: "NetCall Hour"). This needs
  447.                two parameters -C and -U. The value following -C gives the
  448.                remaining on-line time in seconds. The value following -U
  449.                gives the actual baud rate. If the remaining time doesn't
  450.                suffice for an upload, RZ will exit with an exit code 9 and
  451.                the message 'not  enough  time for  upload'. At that time,
  452.                no files have been created. If the available on-line time 
  453.                is exceeded, the receive operation will be stopped with an
  454.                error code 10. The partially received file will be closed,
  455.                so that the transfer can be resumed later on.
  456.  
  457.                Example:  -rz -C 19200 -U 100
  458.  
  459.  
  460.  
  461.  
  462. EXAMPLES
  463. --------
  464.  
  465. Some examples of parameters for RZ:
  466.  
  467. -rz                  Receive using ZMODEM
  468.  
  469. -rz -Y               Receive using YMODEM
  470.  
  471. -rz -Y -g            Receive using YMODEM-1k-g
  472.  
  473. -rz -X TEST.XYZ      Receive using XMODEM.
  474.                      NOTE: a file name MUST be specified as it cannot be
  475.                      transferred by XMODEM!
  476.  
  477. -rz -y -o TEST.XYZ -P D:\MAIL\DOWNLOAD
  478.                      Receive using ZMODEM, carrier detect disabled, target
  479.                      directory specified, file name specified, delete
  480.                      possibly existing file
  481.  
  482. -rz -m               Receive via MIDI interface
  483.  
  484. -rz -m -b 8192 -l 8192
  485.                      Receive via MIDI. The Rx buffer has to be set to 8 KB
  486.                      if you are using 8 KB blocks to avoid buffer overflow.
  487.  
  488.  
  489.  
  490.  
  491. PARAMETERS FOR SENDING
  492. ----------------------
  493.  
  494. REMEMBER:      Please remember to specify the file name(s) after all the
  495.                parameters have been given.
  496.  
  497.  
  498. Append to existing file
  499.  
  500. -+             The receiver should append the file transferred to an
  501.                existing file (ZMODEM only).
  502.  
  503.  
  504. ASCII Transfer
  505.  
  506. -a             ASCII Transfer. The receiver has to translate CR/LF (ZMODEM
  507.                only)
  508.  
  509.  
  510. Include protocol end into CPS rate
  511.  
  512. -A             At the end of a file transmission an acknowledge between
  513.                sender and receiver is done. Some people want to include 
  514.                this in the final calculation of the CPS rate.
  515.                If -A is set, the last CPS-rate is calculated after the
  516.                acknowledge.
  517.  
  518.  
  519. Suppress break
  520.  
  521. -b             At a retry, NO break will be sent to the modem (ZMODEM
  522.                only). Usually, a break is sent to the modem at a block
  523.                retry operation to empty the modem's buffer.
  524.  
  525.  
  526. Conversion of '.'
  527.  
  528. -d             Dots '.' in path names are converted to slashes '/'
  529.                (Y/ZMODEM only). This is useful if the receiver isn't able
  530.                to handle dots in file names.
  531.  
  532.  
  533. Suppress carrier detect
  534.  
  535. -D             If this parameter is specified, monitoring of the carrier 
  536.                detect line is suppressed.
  537.  
  538.  
  539. Escaping of control characters
  540.  
  541. -e             If this parameter is specified, 'escaping' of all control 
  542.                characters is performed as is commonplace on UNIX systems.
  543.  
  544.  
  545. Send path name to the receiver
  546.  
  547. -f             If this parameter is specified, the full path name is
  548.                transmitted together with the file name (ZMODEM only).
  549.                Note that '\' is converted to '/' as noted in the
  550.                Zmodem Specification. Some Zmodem programs on PC's
  551.                cannot accept this conversion!
  552.  
  553.  
  554. File buffer size
  555.  
  556. -F SIZE        This parameter specifies the size of the file buffer. When
  557.                sending a file, this buffer is filled by reading from
  558.                hard disk/floppy disk. SIZE indicates the size of the buffer
  559.                in bytes, the suffixes 'K' and 'M' indicate kilobyte and
  560.                megabyte, e.g. '-F 16K' and '-F 2M'.
  561.                '-F -1' results in a buffer that uses all available RAM
  562.                except 100 KB.
  563.  
  564.                SIZE: default 8192 bytes, minimum 1024 bytes
  565.  
  566.  
  567. Audible indication of the end of the transfer
  568.  
  569. -G             The end of the transfer will be indicated by an audible
  570.                signal ('bell').
  571.  
  572.  
  573. Serial device
  574.  
  575. -H n           With this parameter You can select a serial device. This is
  576.                useful, if GSZRZ is used as accessory under MultiTOS.
  577.  
  578.  
  579.                      ST           MSTE      TT      FALCON
  580.                 1   AUX           AUX      AUX       AUX
  581.                 3   MIDI          MIDI     MIDI      MIDI
  582.                 6   MODEM1        MODEM1   MODEM1    -
  583.                 7   -             MODEM2   MODEM2    MODEM2
  584.                 8   -             SERIAL2  SERIAL1   SERIAL2/LAN
  585.                 9   -             -        SERIAL2   -
  586.  
  587.  
  588. Iconify the GSZRZ window on startup
  589.  
  590. -I x,y          With this parameter it is possible (only with MultiTOS 
  591.                 with AES version > 4.0) to iconify the window of GSZRZ 
  592.                 already at startup and position the window at x,y (min. 
  593.                 position: 1,1). If MultiTOS isn't available, the normal 
  594.                 Window is placed at this position.
  595.  
  596.  
  597. Block size for XMODEM/YMODEM
  598.  
  599. -k             Send 1024 byte packages. The X/YMODEM default value is 128
  600.                bytes.
  601.  
  602.  
  603. Request receiver acknowledge
  604.  
  605. -l N           Request an acknowledge from the receiver after N bytes
  606.                (32 <= N <= 1024, 8192 if parameter -8 is used) have been
  607.                transferred (ZMODEM only). The ZMODEM default is to use
  608.                stream mode, i.e. the sender will send data blocks
  609.                continuously and will be requested to repeat blocks in
  610.                cases of errors only. This results in an increased data 
  611.                rate in the stream mode. If no hardware handshake is 
  612.                possible (e.g. MIDI interface), this parameter forces a 
  613.                software handshake to be performed.
  614.  
  615.  
  616. Log file
  617.  
  618. -L [x:\path\]filename.ext[,level]
  619.                Log all activities to the file specified.
  620.                On level 1, for each transmitted file an entry
  621.                to the file specified using the following format:
  622.  
  623.     SZ: HISTORY.TXT  Len:    20408 Tim: 00.00.18 Err:  0 CPS: x
  624.     RZ: ANSI.SYS     Len:     1709 Tim: 00.00.02 Err:  0 CPS: x
  625.     ^^  ^                    ^          ^              ^
  626.     ||  file name            bytes      duration       error code
  627.     |X/Y/Z protocol
  628.     S or R for Send / Receive
  629.  
  630.                 On level 2, each message displayed on the line
  631.                 'last status/error' is written to the logfile too.
  632.  
  633.  
  634. Use MIDI interface
  635.  
  636. -m             If this parameter is specified, the transfer will be
  637.                performed via the MIDI interface. If GSZRZ is used as an
  638.                accessory in conjunction with RUFUS, this is the default 
  639.                and this parameter need not be specified (see example 
  640.                below).
  641.  
  642.                As the MIDI interface does not have handshake lines, a
  643.                software handshake has to be requested by specifying the
  644.                parameter '-l 1024' or '-l 8192' if parameter -8 is used.
  645.  
  646.  
  647. Disable mouse interrupt
  648.  
  649. -M             This parameter disables the mouse interrupt during the
  650.                transfer. Use this parameter if moving the mouse disturbs
  651.                the file transfer. In addition, this parameter causes the
  652.                multitasking to be disabled to achieve maximum data rates 
  653.                on the ST.
  654.  
  655.  
  656. Conditional transfer
  657.  
  658. -n             Send file only if it is newer or longer than the one that
  659.                already exists at the receiver (ZMODEM only).
  660.  
  661. -N             Send file only if it has a different file date or is longer
  662.                than the one that already exists at the receiver (ZMODEM
  663.                only).
  664.  
  665.  
  666. 16 Bit CRC
  667.  
  668. -o             Use 16 Bit CRC only for ZMODEM transfers. Saves 2 bytes per
  669.                block transferred. Some older ZMODEM programs use nothing
  670.                but 16 Bit CRC.
  671.  
  672.  
  673. Protect an existing file
  674.  
  675. -p             If the file to be transferred already exists at the
  676.                receiver, the transfer will NOT be performed (ZMODEM only).
  677.  
  678.  
  679. Suppress outputs to STDERR when leaving GSZRZ
  680.  
  681. -q             If this parameter is specified, the output of the final
  682.                message to STDERR will be suppressed. Use this in
  683.                conjunction with communication programs that do not 
  684.                redirect STDERR.
  685.  
  686.  
  687. Resume an interrupted transfer
  688.  
  689. -r             If this parameter is specified, the receiver is told that
  690.                the sender is able to resume a partial transfer (ZMODEM
  691.                only).
  692.  
  693.  
  694. Use script file for sending
  695.  
  696. -s FILE.EXT    The names of the files to be transferred are being read 
  697.                from the script file FILE.EXT (ZMODEM only). Useful for
  698.                transferring the same files repeatedly.
  699.  
  700.  
  701. Output the CPS rate to STDERR
  702.  
  703. -S             If this parameter is specified, the CPS rate will be 
  704.                written to STDERR at the end of the transfer.
  705.  
  706.  
  707. Set the time-out time
  708.  
  709. -t TIM         Sets the time-out time to TIM/10 seconds. This is the 
  710.                duration of time which will be waited for an answer from 
  711.                the receiver until an error is assumed. Usually, there 
  712.                should be no problems with the default value of 600 (i.e. 
  713.                60 seconds). Minimum 10, maximum 1000.
  714.  
  715.  
  716. Delete file after transfer
  717.  
  718. -u             The file to be transferred will be deleted after the
  719.                transfer has ended.
  720.  
  721.  
  722. Setting the priority (MultiTOS only)
  723.  
  724. -v pri          Set priority if running with MultiTOS. 
  725.                 Default: +20, min: -20, max: +20
  726.  
  727. Replace existing file
  728.  
  729. -y             The receiver will replace a file of the same name that
  730.                possibly already exists with the file transferred (ZMODEM
  731.                only)
  732.  
  733.  
  734. Protocol for sending
  735.  
  736.                The default protocol used is ZMODEM. If you want to use one
  737.                of the other protocols, specify one of these parameters:
  738.  
  739. -X             Use XMODEM protocol
  740.  
  741. -Y             Use YMODEM protocol
  742.  
  743.  
  744.  
  745. Checking the on-line time
  746.  
  747. -U time        on-line time remaining
  748.  
  749.                For the usage in BBS programs, the checking of the on-line
  750.                time was implemented. The value following -C gives the
  751.                remaining on-line time in seconds. If the available on-line
  752.                time is exceeded, the send operation will be stopped with 
  753.                an error code 10.
  754.  
  755.                Example:  -sz -U 100
  756.  
  757.  
  758. Transfer big blocks
  759.  
  760. -8             Use 8 KB blocks for transfer. CAUTION: Don't expect to find
  761.                many ZMODEM programs that can use this option at the other
  762.                end of the line!
  763.  
  764.  
  765.  
  766.  
  767. EXAMPLES
  768. --------
  769.  
  770. Some examples of parameters for sending:
  771.  
  772. -sz TEST.XYZ         send using ZMODEM
  773.  
  774. -sz *.C *.H          send all files with extensions .C and .H using ZMODEM
  775.  
  776. -sz -Y TEST.XYZ      send using YMODEM
  777.  
  778. -sz -Y -k TEST.XYZ   send using YMODEM-1k-g
  779.  
  780. -sz -X TEST.XYZ      send using XMODEM
  781.  
  782. -sz -8 TEST.XYZ      send using ZMODEM in 8 KB blocks
  783.  
  784. -sz -m -l 1024 TEST.XYZ
  785.                      send via MIDI interface
  786.  
  787. If the receiver uses GSZRZ, too, you can use 8 KB block transfers via MIDI
  788. interfaces, too, by specifying:
  789.  
  790. -sz -m -8 -l 8192 TEST.XYZ
  791.  
  792. The receiver has to use these parameters:
  793.  
  794. -rz -m -b 8192
  795.  
  796.  
  797.  
  798. EXIT CODES
  799. ----------
  800.  
  801. When exiting from the program, GSZRZ returns one of the following exit
  802. codes to the caller:
  803.  
  804.  -1  Protocol error
  805.   1  Argument error, command line parameters wrong
  806.   2  File not found
  807.   3  User break by entering Ctrl-C, clicking on 'closer' or abort.
  808.   4  Initialization error (graf_handle,  appl_init)
  809.   5  File skipped by other side
  810.   6  Memory allocation error, not enough memory
  811.   7  Carrier lost
  812.   8  Invalid structure pointer (see ACC protocol)
  813.   9  Not enough time for upload
  814.  10  Time limit exceeded
  815.  11  No/wrong port handle
  816.  12  Disk full
  817.  16  Cancel received   Aborted by other side
  818. 128+ Transfer error (for example, if 4 files are to be transferred and the
  819.      receiver skips 2 files, 128 + 2 = 130 is returned. If no sync is
  820.      established, 128 is returned)
  821.  
  822.  
  823.  
  824.  
  825. ACC PROTOCOL USED BY GSZRZ
  826. --------------------------
  827.  
  828. GSZRZ used as an ACC is addressed using a special protocol via the
  829. application message function of GEM.
  830.  
  831. msgbuf[0]   Contains the ID of the ACC protocol. It consists of the 
  832.             letters 'GZ'. i.e. the hex value 0x475A.
  833.  
  834. msgbuf[1]   Contains the application ID, i.e. the value that is returned 
  835.             by appl_init().
  836.  
  837. msgbuf[2]   Always has to be 0.
  838.  
  839. msgbuf[3]   Contains the length of the command line string.
  840.  
  841. msgbuf[4]   The lower 16 bits of the pointer to the command line string.
  842.  
  843. msgbuf[5]   The upper 16 bits of the pointer to the command line string.
  844.  
  845.             The command line string has to be terminated by 0x00. It
  846.             contains the usual switches as in calls to the PRG, e.g.
  847.             "-rz -D -P C:\\DOWNLOAD"
  848.  
  849. RETURN CODES
  850. ------------
  851.  
  852. At exit, GSZRZ returns the following values to the calling program:
  853.  
  854. msgbuf[0] = GZ_PRIVATE;
  855. msgbuf[1] = appl_id;
  856. msgbuf[2] = Exitcode;
  857. msgbuf[3] = (int) strlen(message);
  858. msgbuf[4] = (unsigned int) ((long) message & 0XFFFF);
  859. msgbuf[5] = (unsigned int) ((long) message >> 16);
  860. msgbuf[6] = 0;
  861. msgbuf[7] = 0;
  862. appl_write(msgbuf[1], 16, txmsgbuf);
  863.  
  864. 'message' is a pointer to a string, that's written to STDOUT when exiting
  865. the program. RUFUS/CoNnect causes this string to be displayed as a GSZRZ
  866. message in the communication window.
  867.  
  868. 'Exitcode' contains GSZRZ's return code.
  869.  
  870.  
  871.  
  872.  
  873. RTS/CTS HANDSHAKE
  874. -----------------
  875.  
  876. As the GSZRZ programs use the ST/TT's operating system routines, the
  877. RTS/CTS handshake has to be performed by the communication program (e.g.
  878. RUFUS) or using the control area.
  879.  
  880. Because the TOS routines are faulty even in TOS 1.04 and TOS 3.05, a patch
  881. has to be installed.
  882.  
  883. With the ATARI ST, I can recommend HSMODEM1 by Harun Scheutzow.
  884.  
  885. With the TT, SERPTCH2 by ATARI is recommended, because it will repair all
  886. interfaces.
  887.  
  888. With TOS 3.06, SERPTCH2 should no longer needed.
  889.  
  890.  
  891.  
  892. SHAREWARE VERSIONS
  893. ------------------
  894.  
  895. The Shareware-Version of GSZRZ is restricted in some functions. The user
  896. can evaluate the programs for 3 weeks, copy them freely, and share them
  897. with other users. All registered versions are for single users and MUST 
  898. NOT be copied and handed on to other users.
  899.  
  900. If you use these programs more than 3 weeks, you MUST pay a fee of DM 
  901. 35.00 to the author (XENIA Software, Michael Ziegler) or £16 registration 
  902. via Joe Connor in the UK. For details refer to SUPPORT.TXT included with 
  903. this archive.
  904.  
  905. If you pay via remittance order from abroad, please don't forget that 
  906. banks may subtract fees of up to DM 12.50. In Europe, the best way is to
  907. pay by EuroCheque.
  908.  
  909.  
  910.  
  911. THANKS TO
  912. ---------
  913.  
  914. I would like to thank the many beta tester, especially:
  915.  
  916.   Jürgen Meyer and Carsten Meyer (Maus @HH2) for the devoted testing,
  917.  
  918.   Michael Bernards for the support by RUFUS,
  919.  
  920.   Wolfgang Wander for the support by CoNnect,
  921.  
  922.   Achim Wilhelm for supporting me in searching for bugs in the FALCON-TOS,
  923.  
  924.   Harun Scheutzow for the best RTS/CTS patch for serial devices on ATARI
  925.   computers I ever seen.
  926.  
  927.   All users of GSZRZ whose suggestions and advice on new features further
  928.   the development of the GSZRZ ZMODEM program package.
  929.  
  930.  
  931.  
  932. UPDATE SERVICE
  933. --------------
  934.  
  935. For registered users of GSZRZ only, an update service has been installed 
  936. in several bulletin board systems (BBS).
  937.  
  938. Please allow for about 2 - 3 weeks after registration until you can use
  939. this service. The files containing the registration data in the BBS are
  940. updated irregularly.
  941.  
  942. This service is free of charge. It has been established on request by BBS
  943. operators. Therefore, I cannot guarantee that this service and the latest
  944. version of the GSZRZ program package will be available at all times.
  945.  
  946. For updating, you need the serial number of your GSZRZ program package. 
  947. You can find it in the file SERIAL.NUM on your registered disk.
  948.  
  949. After logging on to the BBS, call the updater from the menu. The updater 
  950. will answer with the following message in German:
  951.  
  952. >> Registering GSZRZ-Files V 2.6 (c) 1991, 1992 mz <<
  953.  
  954. A C H T U N G:  Nur für REGISTRIERTE Benutzer erlaubt!
  955. aktuelle Version x.yy downloaden ? (J/N)
  956.  
  957. Vorname:
  958. Nachname:
  959. Seriennummer:
  960.  
  961. In English, this would read:
  962.  
  963. >> Registering GSZRZ Files V 2.6 (c) 1991, 1992 mz <<
  964.  
  965. C A U T I O N:  for REGISTERED users only
  966. download current version x.yy ? (Y/N)
  967.  
  968. first name:
  969. last name:
  970. serial number:
  971.  
  972. After you have entered the data requested, the updater will produce a
  973. version registered to you, compress it and send it to you using
  974. YMODEM or ZMODEM, whatever you choose.
  975.  
  976. Please take care to enter the first and last names exactly as they are
  977. displayed in the dialog window or your request to update will be rejected.
  978.  
  979. This update service is currently offered by the following German bulletin
  980. board systems (BBS):
  981.  
  982. ------------------------------------------------------------------------
  983. BBS            :         The Tavern   London - England
  984. Baud rate      :
  985. Telephone      :         ++44 0181 445 6514
  986. Updater        :         Enter: Menu option '/' 
  987. Download times :         24 Hours apart from 2am-5am CET
  988. ------------------------------------------------------------------------
  989. BBS            :         Turbo Tron   Hamburg - Germany
  990. Baud rate      :         2400 - 14400 V32 V32bis
  991. Telephone      :         ++49 / 40 / 890 11 62
  992. Updater        :         Enter: GSZRZ,UPDATER or GSZ
  993. Download times :         00:00 - 08:00 CET
  994. ------------------------------------------------------------------------
  995. BBS            :         Tuma Box   Augsburg - Germany
  996. Baud rate      :         1200 - 19200 V32 V32bis ZyXel-Mode
  997. Telephone      :         ++49 / 8231 / 87 7 87
  998. Updater        :         Enter: GSZRZ,UPDATER or GSZ
  999. Remarks        :         You can download one file per login,
  1000.                          if you want more, you'll have to register
  1001. ------------------------------------------------------------------------
  1002. BBS            :         GIS Gevelsberger Info System Germany
  1003. Baud rate      :         1200 - 19200 V32 V32bis ZyXel-Mode
  1004. Telephone      :         ++49 / 2332 / 84291
  1005. Updater        :         Enter: GSZRZ,UPDATER or GSZ
  1006. ------------------------------------------------------------------------
  1007. BBS            :         Datenpavillon      Berlin - Germany
  1008. Baud rate      :         1200 - 28800 HST / V.Fast / V.Terbo / V.34 /
  1009. Telephone      :         ++49 / 30 / 622 26 36
  1010. Updater        :         Enter: GSZRZ,UPDATER or GSZ
  1011. ---------------------------------------------------------------------------
  1012. BBS            :         no|where           Egeln - Germany
  1013. Baud rate      :         1200 - 16800 V32 V32bis ZyXel-Mode
  1014. Telephone      :         ++49 / 39268 / 33205
  1015. Updater        :         Enter: GSZRZ,UPDATER or GSZ
  1016. not available  :         between 5:30 - 6:00 am
  1017. ========================================================================
  1018.  
  1019. ADDRESS                              BANK ACCOUNT
  1020. -------                              ------------
  1021.  
  1022. XENIA Software                       XENIA Software
  1023. Michael Ziegler                      Michael Ziegler
  1024. Jagdfeldring 16                      Kreissparkasse Muenchen, Germany
  1025. D-85540 Haar, Germany                Bank Number: 702 501 50
  1026.                                      Account Number: 420354680
  1027.  
  1028. ----------------------------------------------------------------------
  1029.  
  1030.