home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / vrac / izmbeta6.zip / IZM.DOC < prev    next >
Text File  |  1994-09-12  |  36KB  |  695 lines

  1.                   IceZmodem File Transfer Protocol Documentation
  2.  
  3.                                 By Alan Caruana
  4.  
  5.                        Copyright (C) 1994 IceSoft Software
  6.                                All Rights Reserved
  7.  
  8.                          Documentation for Version Beta6
  9.              Please note that Version Beta6 is a BETA TEST version and
  10.                                 may contain bugs.
  11.                     Please report ALL bugs to IceSoft Software
  12.  
  13.      Mail:  IceSoft Software       E-Mail: IceNET......: 3@1 or 1@3
  14.             215 Labelle Ave.               WWIV/WW4net.: 3@12180
  15.             Blasdell, NY 14219             Internet....: Icefreezr@delphi.com
  16.  
  17.                   IceSoft Software Support BBS: (716) 823-0424
  18.  
  19. ----------------------------< Table of Contents >-----------------------------
  20.  
  21.  Introduction...:  1. Shareware Notice/License/Distribution
  22.                    2. Disclaimer
  23.                       Description
  24.                    3. What is included
  25.                       Getting Started
  26.  IceZmodem Usage:  4. The IceZmodem Command Line
  27.                    6. Hardware Requirements
  28.                       The IZMSETUP Program
  29.                    7. IceZmodem Functions
  30.  You Should Know: 10. TurboTrans
  31.                       Handshaking
  32.                       The 16550A UART
  33.                       Acknowledgements
  34.  Appendixes....:  11. Appendix A: Freeing Your Memory
  35.                   12. Appendix B: Error Messages
  36.                   13. Appendix C: IceZmodem Command Line Examples
  37.                       Appendix D: Performance
  38.                   14. Appendix E: Revision History
  39.  
  40. --- PAGE 1 -----------------< Shareware Notice >------------------------------
  41.  
  42.  IceZmodem is distributed as an unregistered shareware product. This means
  43.  that an unregistered copy of IceZmodem may be freely distributed to any
  44.  individuals, businesses or organizations for evaluation purposes to decide
  45.  if the product is worth purchasing. If you like IceZmodem and decide to use
  46.  it, you must register (purchase) it. IceZmodem is NOT free software!
  47.  
  48.  Using this shareware system, you will be able to try out the software before
  49.  you make a commitment to purchase it. If you have paid any money for this
  50.  program, it has gone to the distributor of the program and not to IceSoft
  51.  Software.
  52.  
  53.  BENEFITS OF REGISTRATION (Purchase)
  54.  """""""""""""""""""""""""""""""""""
  55.  Registration costs only $25 and will remove all annoying screens and sounds
  56.  and will enable enhanced features such as extended system information and
  57.  other future features. You also get telephone technical support. The best
  58.  part is, $25 will register this and ALL future versions of IceZmodem. You
  59.  will NEVER have to pay for an upgrade! To register, print the file
  60.  REGISTER.FRM or send a check or money order of $25 to:
  61.  
  62.                                 IceSoft Software
  63.                                 215 Labelle Ave.
  64.                                 Blasdell, NY 14219
  65.  
  66. ---------------------------------< License >----------------------------------
  67.  
  68.  IceZmodem, although it is on this computer, is not the property of the owner
  69.  of the computer. It is the property of IceSoft Software. It may be freely
  70.  distributed as long as all files are intact in the original ZIP package.
  71.  This distribution is for evaluation purposes only. Once it is established
  72.  that the operator of the computer is going to use IceZmodem continuously,
  73.  it must be registered. This applies to home, school, business or government
  74.  use.
  75.  
  76.  An UNREGISTERED VERSION (as freely distributed) may be shared freely.
  77.  
  78.  A REGISTERED VERSION of IceZmodem may NOT be distributed. A registered
  79.  version is for use on only ONE computer and may not be shared freely.
  80.  
  81.  If this program is to be used on more than one computer (such as in a
  82.  school or business) then the copies should be purchased in volume or a
  83.  site license should be obtained. Please contact IceSoft Software for more
  84.  information on volume discounts and site licenses.
  85.  
  86. -------------------------------< Distribution >-------------------------------
  87.  
  88.  The unregistered version of IceZmodem may be freely distributed unmodified
  89.  in its original ZIP package. You may charge a fee of no more than $5 for
  90.  distribution costs of IceZmodem. IceZmodem may not be bundled with any
  91.  hardware or software unless written permission is obtained from IceSoft
  92.  Software. IceZmodem program code and IceZmodem setup program may not be
  93.  edited, modified, disassembled or reverse-engineered by any means
  94.  whatsoever. IceZmodem documentation may not be modified, reproduced, edited
  95.  or translated by any means whatsoever.
  96.  
  97. --- PAGE 2 --------------------< Disclaimer >--------------------------------
  98.  
  99.  IceSoft Software is not responsible for any damages to your computer as a
  100.  result of using (or inability to use) IceZmodem. This includes loss of data,
  101.  files, and disk drives. This also includes loss of profit, savings and other
  102.  various damages aroused by the use of IceZmodem.
  103.  
  104.  IceZmodem is thoroughly tested on a variety of computer platforms before
  105.  beta or initial release to perform as stated in the documentation. However,
  106.  no warranty or guarantee may be stated due to the varying hardware systems
  107.  the software will run on.
  108.  
  109. -------------------------------< Description >--------------------------------
  110.  
  111.  IceZmodem is a 100% Zmodem compatible external file transfer protocol with
  112.  several enhancements that will increase your productivity while transfering
  113.  files and make the file transfer process less boring:
  114.  
  115.             * You can chat with the remote user during the file transfer.
  116.  
  117.             * You can shell to DOS and execute DOS commands and programs.
  118.                        (transfer pauses while programs are executed)
  119.  
  120.             * You can edit text files during the file transfer.
  121.  
  122.             * You can play MOD digital music files through a Sound Blaster,
  123.               DAC, or PC Speaker.
  124.  
  125.             * You can get 2 pages of system information about the remote
  126.               computer that you are transfering files with.
  127.  
  128.             * You can play built-in arcade games during the file transfer.
  129.  
  130.  It doesn't end here! IceZmodem also boasts:
  131.  
  132.             * A Screen Saver which shows, in large numbers, the percentage
  133.               the transfer has completed.
  134.  
  135.             * TurboTrans, a Zmodem speed booster which has helped to get
  136.               peaks of 99% efficiency during some file transfers.
  137.  
  138.             * Maximum Block size of 6144 bytes, compared to the standard
  139.               Zmodem maximum size of 1024 bytes.
  140.  
  141.             * An option for BBS Sysops to view information within their
  142.               BBS dropfile.
  143.  
  144.             * One of the most informative status displays found on any
  145.               file transfer protocol.
  146.  
  147. --- PAGE 3 ----------------< What is included >------------------------------
  148.  
  149.    IZM.DOC      - The IceZmodem documentation you are reading now
  150.    IZM.EXE      - The actual IceZmodem protocol
  151.    IZMSETUP.EXE - The setup program which reads/writes the configuration to
  152.                   IZM.EXE.
  153.    INSTALL.DOC  - A text file that explains how to set up IceZmodem with
  154.                   many popular BBS systems and terminal programs.
  155.    REGISTER.FRM - A text file that you can print out to simplify registration
  156.                   of IceZmodem
  157.    IZM-U.BAT,
  158.    IZM-D.BAT    - Batch files for uploading and downloading files using
  159.                   IceZmodem. These batch files will work with most terminal
  160.                   programs, however you may need to modify the batch file.
  161.                   (Refer to INSTALL.DOC for more information)
  162.  
  163. -----------------------------< Getting Started >------------------------------
  164.  
  165.  IceZmodem can easily be configured to work with any BBS or terminal program.
  166.  The command lines that are used to operate IceZmodem are similar to the
  167.  popular DSZ external protocol. INSTALL.DOC contains instructions on how to
  168.  set up IceZmodem with many popular BBS and terminal programs. Refer to this
  169.  file now if you do not know how to get started with your particular BBS or
  170.  Terminal program. Also, be sure to run IZMSETUP.EXE! (see page 6)
  171.  
  172. --- PAGE 4 -------------< The IceZmodem Command Line >------------------------
  173.  
  174.                IZM [OPTIONS] <File Transfer Type> <File/Pathname>
  175.  
  176.  OPTIONS    (See Appendix C for examples on using IceZmodem)
  177.  """""""
  178.    O    -  Put O on the the command line by itself to switch IceZmodem
  179.            into offline mode. This will let you use IceZmodem features
  180.            without having a modem connection.
  181.  
  182.    port - This tells IceZmodem what COM PORT you would like to communicate
  183.           with. It can be any value from 1 to 4.  You do not need to specify
  184.           the port if you have already set up your default port in IZMSETUP
  185.           and the default port is the one you would like to use. Specifying
  186.           this option will override your default port in IZMSETUP, but it
  187.           will NOT override your default address/IRQ nonstandard port in
  188.           IZMSETUP.
  189.  
  190.            * Do not use the PORT option combined with the adrirq option *
  191.  
  192.           Below are the standard addresses and IRQs that IceZmodem recognizes
  193.           when you specify the port command. If your address/IRQ is different
  194.           than these, you need to use the adrirq option or set up your
  195.           default address/IRQ in IZMSETUP.
  196.  
  197.                            PORT 1:  Address 3F8   Irq 4
  198.                            PORT 2:  Address 2F8   Irq 3
  199.                            PORT 3:  Address 3E8   Irq 4
  200.                            PORT 4:  Address 2E8   Irq 3
  201.  
  202.    **** EXAMPLE FOR PORT: IZM port 2
  203.  
  204.  adrirq -  This tells IceZmodem the ADDRESS and the IRQ of your NONSTANDARD
  205.            COM PORT if you have one. If upon examining the chart above, you
  206.            do not find your port address/IRQ, you use this command to specify
  207.            the address/IRQ of your port. It uses the syntax:
  208.  
  209.                             adrirq address,irq
  210.  
  211.            This option will override the address/IRQ you specify in IZMSETUP
  212.                   * DO NOT USE ADRIRQ COMBINED WITH THE PORT OPTION *
  213.  
  214.    **** EXAMPLE FOR ADRIRQ: IZM adrirq 3F8,4
  215.  
  216.  speed  - This tells IceZmodem the speed (bits per second) that the COM PORT
  217.           is operating at. If this option is not specified, IceZmodem will
  218.           assume that the COM PORT is already set at the proper speed (which
  219.           it always should be before IceZmodem is executed) and should work
  220.           properly.
  221.  
  222.    **** EXAMPLE FOR SPEED: IZM port 2 speed 2400
  223.  
  224.  node   - If you are running a multi-node BBS and you have specified the
  225.           location of your BBS dropfile in IZMSETUP with the * macro, you
  226.           must use this command line to tell IceZmodem what node you would
  227.           like to replace the * macro with.
  228.  
  229.    **** EXAMPLE FOR NODE: IZM port 2 speed 38400 node 5 rz C:\BBS\UPLOADS\
  230.  
  231. --- PAGE 5 ------------------------------------------------------------------
  232.  
  233.    flow - After the word flow, you may use SLOW or HARD. Specifying SLOW
  234.           will cause IceZmodem to stop the sender from sending data during
  235.           disk writes. This is good if the receiver is writing the file to
  236.           a floppy disk or a slow hard disk. Specifying HARD will turn the
  237.           hardware handshaking on. This means if the sender is sending data
  238.           too fast and the receiver can't keep up, the receiver will tell the
  239.           sender to stop sending data until the receiver catches up. ALL high
  240.           speed modems MUST use flow hard.  These options override the
  241.           defaults that you specify in IZMSETUP.
  242.  
  243.           To make this plain and simple, if the receiver is writing to a slow
  244.           hard disk or floppy disk, you MUST use flow slow. If you are using
  245.           greater than 2400 bps, you MUST use flow hard.
  246.  
  247.           You may combine both flow slow and flow hard. See below:
  248.  
  249.      **** EXAMPLE FOR FLOW: IZM port 2 speed 2400 flow slow
  250.      **** EXAMPLE FOR FLOW: IZM speed 19200 flow hard
  251.      **** EXAMPLE FOR FLOW: IZM speed 38400 flow slow flow hard
  252.  
  253.    page - Use either PAGE ON or PAGE OFF to allow the remote to page you with
  254.           a loud beep or not. This will override your default selection in
  255.           IZMSETUP. If PAGE OFF is specified, the screen will flash on and
  256.           off instead of making an audible noise.
  257.  
  258.  File Transfer Type
  259.  """"""""""""""""""
  260.      RZ - Use this to receive data. If you do not specify anything after the
  261.           RZ, all files received will go into the current directory. After
  262.           the RZ you may specify a pathname and/or a filename. If a pathname
  263.           is specified, all files will go into that directory. If a filename
  264.           is specified, all received files will be renamed to that filename.
  265.           If a pathname AND filename is specified, all files will go into
  266.           that path and be renamed to the filename specified.
  267.  
  268.      SZ - This is the command to send data. This command must always be
  269.           followed by either:
  270.  
  271.                   A filename: SZ program.zip
  272.                   A pathname: SZ c:\bbs\dloads\sysop\program.zip
  273.                   Many Names: SZ program.zip c:\bbs\log.txt a:\program.exe
  274.                   Wildcards : SZ *.zip
  275.                   File Lists: SZ @file.lst
  276.  
  277.           OR a combination of ANY of the above things. The File List at the
  278.           end is an @ sign followed by a filename. In this file is a list of
  279.           path/filenames to send - one on each line of the file.
  280.  
  281.               For example, if the file LIST.TXT contained the following:
  282.                               \PROGRAMS\QUADL10.ZIP
  283.                               \BBS\DLOADS\SYSOP\MAIL.ZIP
  284.                               IZM110.ZIP
  285.                 ...You could send all 3 of those files with the line:
  286.                          IZM port 1 speed 2400 sz @list.txt
  287.  
  288.  Environment Variables
  289.  """""""""""""""""""""
  290.    If you set the environment variable DSZLOG equal to a filename, IceZmodem
  291.    will create a DSZ-compatible log for programs which require it to run.
  292.                   Example: SET DSZLOG=C:\BBS\DSZLOG.TXT
  293. --- PAGE 6 ----------------< Hardware Requirements >-------------------------
  294.  
  295.    Processor: 8086 or better. You will need at least an 80286 to use the
  296.               Digital MOD Music or to utilize 16800+ bps reliably.
  297.  
  298.    DOS......: Version 3.0 or better. Any earlier versions will not work.
  299.               IceZmodem will work under DesqView, OS/2, and Windows however
  300.               some features (such as MOD player) will not work.
  301.  
  302.    Memory...: At least 200k to transfer files. To play music, edit text files
  303.               and shell to dos, you must have from 200k-300k. This amount of
  304.               memory must be present on top of all the other memory taken by
  305.               terminal programs or BBS systems. (See Appendix A for
  306.               information on gaining more memory)
  307.  
  308.    Display..: Any display will work, but a color monitor is highly
  309.               recommended.
  310.  
  311.    Optional.: Sound Blaster, Disney Sound Source, or a parallel port D/A
  312.               converter for best sounding Digital Music.
  313.  
  314. ----------------------------< The IZMSETUP Program >--------------------------
  315.  
  316.  The IZMSETUP program included with the IceZmodem package lets you set up
  317.  many of the default options in IceZmodem and sets several options which are
  318.  not adjustable anywhere else in the program. I recommend that you run the
  319.  IZMSETUP.EXE program when you first install your IceZmodem and whenever you
  320.  upgrade to a newer version of IceZmodem. The configuration options are
  321.  stored within the IZM.EXE file itself - eliminating the need for more files
  322.  cluttering up your hard disk and causing more headaches. The only problem
  323.  with this is that you will need to run IZMSETUP whenever you receive an
  324.  IZM.EXE upgrade.
  325.  
  326.  When you first execute IZMSETUP, it will want to know where the IZM.EXE
  327.  file is located. If it is in the current directory, simply hit enter
  328.  otherwise tell it where it is. I am not going to document each option in
  329.  IZMSETUP because there is already documentation within the program. I
  330.  suggest that you go through each option and read what each option does and
  331.  choose wisely to get the best performance and reliability out of IceZmodem.
  332.  
  333. --- PAGE 7 -----------------< IceZmodem Functions >--------------------------
  334.  
  335.  Alt-A - Abort File Transfer
  336.  """""""""""""""""""""""""""
  337.     This will abort the file transfer and return an Exit Code of 1.
  338.  
  339.  F1 - Main Screen
  340.  """"""""""""""""
  341.     The main screen is the heart of IceZmodem. Here you will see how the
  342.     transfer is progressing by the numerous indicators and graphs.
  343.  
  344.   Download/Upload Status Window
  345.   """""""""""""""""""""""""""""
  346.     Block Size - This is the number of bytes that are transferred before a
  347.                  checksum takes place. The greater this number, the more
  348.                  efficient the transfer will be. IceZmodem uses up to 6144
  349.                  byte blocks when connected to another IceZmodem. You may
  350.                  increase this number in IZMSETUP. Whatever block size that
  351.                  the SENDING compiter has specified is what will be used.
  352.  
  353.     CPS - This stands for characters per second, how efficient your file
  354.           transfer is going. Please be aware that this is an estimate and
  355.           is NOT very accurate. The actual CPS is usually a bit higher.
  356.  
  357.     TurboTrans - This tells wether TurboTrans is in use or not. (See page 10)
  358.  
  359.       Messages - Information about the transfers progress and remote user
  360.                  status appears here.
  361.  
  362.     Completion - A graph and a percentage that tells how complete the file
  363.                  transfer is.
  364.  
  365.         Method - Usually CRC-32 or CRC-16. Tells what method of CRC is being
  366.                  used to check each block. The CRC-16 method is barely
  367.                  faster and offers half the protection against data errors.
  368.  
  369.     Efficiency - A percentage that will tell how efficient the transfer is
  370.                  going. 99% is the highest ever obtained with IceZmodem. If
  371.                  you are using locked com ports, this feature will read N/A.
  372.  
  373.     Time Total - IceZmodem analyzes the rate of characters comming in to the
  374.                  computer to predict the total time of the transfer, giving
  375.                  IceZmodem very accurate total time prediction.
  376.  
  377.     Batch Status Window - This window contains the same as above with the
  378.                           exception that the Batch is the information on
  379.                           all the files you are transferring if you are
  380.                           transferring multiple files.
  381.  
  382.       User Status Window
  383.       """"""""""""""""""
  384.            User - The name of the person who is operating the IceZmodem
  385.            Regs - Their registration name (if registered)
  386.            Vers - The version of Zmodem or IceZmodem being used
  387.  
  388.  F2 - Chat
  389.  """""""""
  390.      You may chat with the remote user on this screen. If they are not in
  391.      chat, hit F10 to page them. When somebody is paged in IceZmodem, either
  392.      a beeping noise will come out their speaker or (if the page is turned
  393.      off) the screen will flash. Once both people are in chat, just type a
  394.      sentence and hit enter. The message will appear in the upper window.
  395.  
  396. --- PAGE 8 ------------------------------------------------------------------
  397.  
  398.  F3 - DOS Shell
  399.  """"""""""""""
  400.      Using DOS Shell, you may execute any DOS commands or small programs
  401.      without greatly disturbing the transfer. Whenever you execute a
  402.      command or program in the DOS Shell, the file transfer temporarily
  403.      stops and then resumes when the prompt reappears. Knowing this,
  404.      you can execute small commands like DIR, RENAME, DEL, COPY, etc. and
  405.      the transfer wouldn't be harmed at all. You can load small utility
  406.      programs as well providing you dont remain in them for too long.
  407.      I wouldn't recommend staying in any executable file for more than
  408.      15-25 seconds. Especially if you are paying for long distance charges.
  409.      IceZmodem DOS Shell does not multitask. You cannot load up your favorite
  410.      text editor and expect the transfer to continue. There will be a certain
  411.      point where the buffer can no longer hold the incomming data and you
  412.      will loose data. This wont affect the file you are transfering.
  413.  
  414.  F4 - Screen Saver
  415.  """""""""""""""""
  416.      This will print the percentage complete in large numbers on a black
  417.      screen. To exit it, hit F1-F7.
  418.  
  419.  F5 - Text Editor
  420.  """"""""""""""""
  421.      This is a simple text editor that I threw in at the last minute to see
  422.      if it could be done. There are some bugs in the text editor and I am
  423.      going to completely re-write the text editor in a future version.
  424.      Select a file to load. If you wish to create a new file, hit T and then
  425.      type in a filename. If you get an error message, refer to Appendix B.
  426.      The text editor can currently only load files 64k or less. The file must
  427.      not contain more than 78 characters per line. When you are done editing
  428.      the file, hit F9 to save it. If you dont want to save it, hit F8 to
  429.      unload the text file. You must either save or unload the text file
  430.      before IceZmodem will exit when the transfer is complete.
  431.  
  432.  F6 - Module Player
  433.  """"""""""""""""""
  434.      The Module Player will play Amiga Digital MOD music files. These should
  435.      be available on one of your local BBSs or any information service. They
  436.      are quite popular on many platforms these days, especially on the PC.
  437.      You may play the files using a PC Speaker, a D/A converter, a Sound
  438.      Blaster, or a Disney Sound Source. The PC Speaker provides very poor
  439.      sound reproduction and some sort of additional hardware is required to
  440.      hear true high fidelity sound. Assuming you have enough memory and you
  441.      have correctly configured your sound device and sampling rate in
  442.      IZMSETUP, you will now be able to select a file to play. If you get an
  443.      error message, refer to Appendix B. You may adjust the MOD volume, turn
  444.      channels 1,2,3,4 on and off and skip forward/backward in the song while
  445.      it is playing. You can go to any of the other functions in IceZmodem
  446.      and the MOD will continue playing (the sound will stop during DOS Shell)
  447.      including System Info, text editor and Chat. The MOD Player may not work
  448.      properly with LANtastic software or other Local Area Network Operating
  449.      Systems.
  450.  
  451.  F7 - System Information
  452.  """""""""""""""""""""""
  453.      This will present a page or two of system information about the local
  454.      and remote computers. Find out what kind of computer that guy REALLY is
  455.      using. Great for online technical support. Registered users can also
  456.      view the remote device drivers, TSRs, and open file handles. Future
  457.      versions may be expanded in this area even further.
  458. --- PAGE 9 ------------------------------------------------------------------
  459.  
  460.  F8 - Games
  461.  """"""""""
  462.      Just for fun, this will give you something to do during the transfer!
  463.      Speedboat Willy is a simple game where you use the left and right arrow
  464.      keys to avoid the bouys and other obstacles comming at you as you speed
  465.      down the river. There are four waves, if you complete the first group of
  466.      four waves you will go back to wave 1, although the game will be faster
  467.      this time! Good luck. WARNING: Excessive playing of this game will make
  468.      the room look like it is elevating when playing is discontinued!
  469.  
  470.  F9 - User Screen
  471.  """"""""""""""""
  472.      If you are a sysop of a BBS and have told IceZmodem the filename of
  473.      your BBS dropfile in IZMSETUP, you may view your BBS dropfile using
  474.      this option. If you have used the * macro in the path/name, be sure
  475.      you are using the node option on the command line!
  476.  
  477. --- PAGE 10 -------------------< TurboTrans >--------------------------------
  478.  
  479.   TurboTrans is a Zmodem speed booster which will enhance the efficiency of
  480.   your file transfer from 2 to 5 percent over standard Zmodem. It does this
  481.   by eliminating a 'feature' built into the original Zmodem standard. This
  482.   feature will not allow certain characters to flow through to avoid problems
  483.   with packet switching networks. These illegal characters must be sent as
  484.   TWO legal characters. This adds a decent amount of overhead to the file
  485.   transfer. When two IceZmodems are connected together they will usually be
  486.   connected by a direct modem connection, not a packet switching network.
  487.   Knowing this, IceZmodem will allow all but 2 characters to be sent through
  488.   as one character when TurboTrans is set to on. TurboTrans automatically
  489.   turns itself on when connected to another IceZmodem.
  490.  
  491. -------------------------------< Handshaking >--------------------------------
  492.  
  493.   There are thousands of different types of PCs out there, and along with
  494.   that, there are thousands of different speeds of PCs. Speed is dependant
  495.   on not only the processor and computer architecture, but also the software
  496.   that is running. For example, a memory manager slows down the speed of your
  497.   PC by a noticeable factor. Because modems allow us to hook faster PCs up
  498.   to slower ones, we need some way to let the slower PCs tell the faster
  499.   ones that they are sending data too fast for them to handle. That is
  500.   basically what Handshaking is. If the receiver cannot receive data as
  501.   fast as the sender is sending it, it has to tell the receiver to stop.
  502.   Handshaking is needed on ALL modems that run faster than 2400 bps. If
  503.   you use 2400 bps, you don't need to read this (now). If you are using
  504.   9600 bps or faster, you MUST understand handshaking. There are two
  505.   types of handshaking - hardware and software. All modems can use
  506.   software handshaking, but IceZmodem doesn't because it is inefficient
  507.   and adds overhead to the transfer, so lets ignore that for right now.
  508.   Hardware Handshaking. Most high speed modems transmit the CTS/RTS
  509.   (clear to send/request to send) signal on the phone line along with the
  510.   data that is being transmitted/received.  IceZmodem can manipulate this
  511.   signal to tell the sender to stop sending data when the receiver cannot
  512.   keep up. When the receiver catches up, it will resume the data
  513.   transmission. So, if you are using a high speed modem, BE SURE to set
  514.   HARDWARE HANDSHAKING to on - otherwise you will get a lot of errors
  515.   in the data transmission.
  516.  
  517. -----------------------------< The 16550A UART >------------------------------
  518.  
  519.   If you are going to use over 9600 bps, I recommend you use a 16550A UART
  520.   chip. This will eliminate a lot of errors and problems you may have down
  521.   the road. You will be able to use over 9600 bps without a 16550A, but
  522.   in practice, it is not a good idea - especially on slower computers.
  523.  
  524. -----------------------------< Acknowledgements >-----------------------------
  525.  
  526.  IceZmodem as it is today would not have been possible without the code that
  527.  has been written by 1) the person who wrote the Source Code for Pascal
  528.  Zmodem. There was no author listed in the public domain code. 2) Mark J. Cox
  529.  who wrote the module playing routines. 3) Chuck Forsberg who developed the
  530.  original Zmodem protocol which is pretty much the standard protocol for
  531.  file transfers now.
  532.  
  533.  I would like to thank all Beta testers, including Jim Nunn, Mark Niedziela,
  534.  Yaser Behbehani, Tony Jones, George Wheeler, and all others who have helped
  535.  to make IceZmodem what it is today. And for support from God, Mom, and all
  536.  IceZmodem users who support this product.
  537.  
  538. --- PAGE 11 ----------< Appendix A: Freeing your Memory >--------------------
  539.  
  540.     IceZmodem is by no means a memory hog - however, when you load up a 200k
  541.     MOD file and a 50k text file and expect to shell to DOS you better have
  542.     a sufficient amount of memory available! If you dont have at least 400k
  543.     of free memory when you start up IceZmodem, your terminal program or BBS
  544.     program is chewing up all your memory. To get around this, set your
  545.     terminal program or BBS program to 'Maximum DOS Shell' or 'Shrink BBS' or
  546.     'Swap to Disk/EMS' or something to that effect. If your Terminal Program
  547.     or BBS doesn't support a shrink feature, tell the author to include one.
  548.     Most BBS and terminal programs have one nowadays anyway.
  549.  
  550. --- PAGE 12 -----------< Appendix B: Error Messages >------------------------
  551.  
  552. Error 45    This error means you are trying to tell IceZmodem to use both a
  553. """"""""    standard and a nonstandard COM port. You are probably using the
  554. PORT option on the command line when you already have an IRQ and ADDRESS set
  555. up in IZMSETUP. To get around this, set up a standard port in IZMSETUP and
  556. use the IRQADDR option on the command line. Another cause of this problem
  557. is trying to use the PORT and IRQADDR options at the same time.
  558.  
  559. Cannot load file. The file size is greater than 64k!
  560. """"""""""""""""""""""""""""""""""""""""""""""""""""
  561. The text editor is currently limited to editing files 64k or less. This will
  562. be corrected in a future version of IceZmodem.
  563.  
  564. Cannot load file. Line length is greater than 78 characters!
  565. """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  566. The text editor is currently limited to editing files with a line length of
  567. 78 characters or less. This will be corrected in a future version of
  568. IceZmodem.
  569.  
  570. You have reached the maximum text file size. No more data may be added!
  571. """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  572. You are attempting to add more than 64k of data to a large text file.
  573.  
  574. Not a valid ASCII text file!
  575. """"""""""""""""""""""""""""
  576. The text file cannot be parsed as a standard text file would. Either it is
  577. too intricate or it is not a text file.
  578.  
  579. Cannot LOAD or CREATE the filename you have specified!
  580. """"""""""""""""""""""""""""""""""""""""""""""""""""""
  581. An invalid filename has been specified. You may have accidentally typed in
  582. a pathname instead of a filename.
  583.  
  584. Not enough memory to load file
  585. """"""""""""""""""""""""""""""
  586. You must free up some memory by closing an open text file or turn off a MOD
  587. file. If nothing is open, then refer to Appendix A - suggestions for gaining
  588. more free memory.
  589.  
  590. Not enough memory to shell out to DOS!
  591. """"""""""""""""""""""""""""""""""""""
  592. You must free up some memory by closing an open text file or turn off a MOD
  593. file. If nothing is open, then refer to Appendix A - suggestions for gaining
  594. more free memory.
  595.  
  596. Not a 31 instrument MOD file!
  597. """""""""""""""""""""""""""""
  598. The MOD file that you are trying to load either 1) doesn't exist, 2) is not
  599. a MOD music file, or more commonly 3) Is an older 15 instrument MOD. If you
  600. run across a 15 instrument MOD, you will need to convert it to a newer 31
  601. instrument MOD before it can be played with IceZmodem. This can be done very
  602. easily with the program MODEDIT by Norman Lin. Simply load the MOD into this
  603. program (as if you were going to modify it) and then save it. The resulting
  604. save will be a 31 channel version of your older 15 channel MOD.
  605.  
  606. Runtime Error 005
  607. """""""""""""""""
  608. IZM.EXE cannot be modified by itself or IZMSETUP.EXE. You probably have the
  609. file attributes set to read-only or a network is not allowing write access.
  610.  
  611. Disk Read Error
  612. """""""""""""""
  613. Either there is something wrong with your disk drive or you do not have
  614. enough FILES specified in your CONFIG.SYS. Add the line FILES=25 to correct.
  615.  
  616. --- PAGE 13 ---------< Appendix C: Command Line Examples >-------------------
  617.  
  618.  
  619. IZM RZ  - Will open the COM port specified in IZMSETUP at the baud rate that
  620.           the port is currently at. It will then receive files and put them
  621.           in the current directory.
  622.  
  623. IZM port 1 speed 2400 RZ c:\downloads - Will open COM1 at 2400 baud and
  624.                                         receive files into the directory
  625.                                         C:\DOWNLOADS.
  626.  
  627. IZM port 2 SZ F.TXT F2.EXE C.COM - Opens COM2 at the current baud rate and
  628.                                    sends F.TXT, F2.EXE, and C.COM.
  629.  
  630. IZM SZ @FILE.LST - Opens the COM port specified in IZMSETUP at the current
  631.                    baud rate. It then opens the file called FILE.LST and
  632.                    reads the path/filenames stored within and proceeds to
  633.                    send all files.
  634.  
  635. IZM port 3 speed 9600 SZ *.EXE - Opens COM3 at 9600 baud and transmits all
  636.                                  the files ending with EXE.
  637.  
  638. IZM adrirq 3e8,2 RZ - Opens a nonstandard port located at address 3E8(hex)
  639.                       using IRQ 2. It then receives files into the current
  640.                       directory.
  641.  
  642. IZM port 2 speed 57600 flow hard SZ C:\UPLOADS\START???.EXE - Opens COM2 at
  643.             57600 baud and turns hardware handshaking on. It will then send
  644.             all EXE files in the directory C:\UPLOADS that begin with
  645.             START.
  646.  
  647. --------------------------< Appendix D: Performance >-------------------------
  648.  
  649.  On a 2400 bps modem connection, IceZmodem averages about 238 CPS with peaks
  650.  of 239 CPS on 80386 class systems transferring a maximally compressed ZIP
  651.  file.
  652.  
  653.  On a 14400 bps modem connection with the com ports locked at 38400 bps,
  654.  IceZmodem averages about 1640 CPS on 80386 class systems transferring a
  655.  maximally compressed ZIP file.
  656.  
  657.  On a 57600 bps direct null-modem cable connection, IceZmodem averages
  658.  about 5100 CPS on 80386 class systems transferring a maximally compressed
  659.  ZIP file.
  660.  
  661. --- PAGE 14 ----------< Appendix E: Revision History >-----------------------
  662.  
  663.  6/1/1994  Version Beta1 - First public Beta Test Release
  664.  
  665.  7/08/1994 Version Beta2 - Second Beta Test Release (LIMITED RELEASE)
  666.                 BUGS - Corrected too many bugs to mention here (over 30)
  667.             FEATURES - Added large number percent complete in Screen Saver
  668.                      - Added extended system information
  669.                      - Improved CPS
  670.                      - Added Turbo Options
  671.                      - Added Overwrite/Recover/Don't transfer options
  672.  
  673.  7/09/1994 Version Beta3 - Fixed major bug in version Beta2 (LIMITED RELEASE)
  674.  
  675.  7/15/1994 Version Beta4 - Fixed major bug in version Beta3 (Public Release)
  676.  
  677.  7/27/1994 Version Beta5 - Fixed minor bugs in version Beta4 (Public Release)
  678.                          - Fixed Crash Recovery
  679.                          - Fixed Chat Screen Flash
  680.                          - Efficiency "N/A" with locked baud rates
  681.                          - Added Speedboat Willy Game
  682.                          - Added adjustable block size
  683.  
  684.  9/14/1994 Version Beta6 - **** NEW MODEM ROUTINES!
  685.                            Reliability/Stability Greatly Improved
  686.                            Now uploads to DELPHI work
  687.                            DesqView, OS/2, and Windows Time Slice Aware
  688.                            BBS Dropfile Support (F9)
  689.                            Offline Interactive Mode (O on the command line)
  690.                            BIOS Video Support
  691.                            Startup Screen Selection
  692.                            IRQ Rotation
  693.                            System Information Disabling Permitted
  694.                            16550A FIFO Trigger Level Select
  695.