home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / PROTOCOL / SZMODEM2.ZIP / SZMODEM.DOC < prev    next >
Text File  |  1992-05-08  |  49KB  |  1,055 lines

  1. SZMODEM ver 2.00
  2. -----------------
  3. By Scott M. Baker
  4.  
  5.  
  6. What is SZModem?
  7.  
  8.          SZModem is a zmodem-compatible protocol with a few added features. It
  9.    is fully compatible with normal zmodem, but adds special capabilities both
  10.    when talking to normal zmodems and while talking to other copies of
  11.    SZModem.
  12.          The main idea behind SZModem is that you should be able to do other
  13.    things while the transfer is taking place. Rather than have your computer
  14.    tied up for an hour downloading a file, you can move around in the SDOS
  15.    window and do directory maintenance, etc...
  16.  
  17.    NOTE: SZModem is now distributed only as the 286/386/486-specific version.
  18.          this program will no longer run on an 8088/8086 machine.
  19.  
  20. What will it do?
  21.  
  22.       While SZModem is transferring a file, you may do the following:
  23.  
  24.       Connected to a "normal" zmodem such as DSZ.
  25.  
  26.           - List files marked for upload
  27.           - List files received as they are received
  28.           - Uses SDOS (simulated dos) to view directories, copy files,
  29.             etc while the transfer is taking place.
  30.           - View file contents as the file is being received (good for
  31.             text files)
  32.           - Play single-player games such as SZTETRIS while transferring.
  33.           - Built in mail reader allows sysops who are using a BBS program
  34.             that uses FIDO message formats to read mail while transferring.
  35.  
  36.       Connected to another copy of SZModem.
  37.  
  38.           - All of the above capabilities
  39.           - A "chat" mode allows the two sides to talk to each other.
  40.           - Play multiplayer games such as Four-In-A-Row
  41.           - The sender will automatically send a "advance transfer list"
  42.             listing the files to be sent. This way, the receiver knows
  43.             what he is receiving.
  44.           - SZTurbo option allows SZModem to pass flow control characters
  45.             unaltered across the modem. This allows for up to a four percent
  46.             effeciency gain over normal Zmodem.
  47.           - Ability to use large zmodem packet lengths - up to 2048 bytes
  48.             at 2400 baud and 4096 bytes for higher speeds.
  49.  
  50. Command specifics
  51. -----------------
  52.  
  53.    F1 - Transfer (send) list
  54.  
  55.          This command will produce a windowed list of the files that have
  56.      been sent, aborted, marked for sending, etc. Included is the file
  57.      name, size, and all other pertinant information. You may use the up
  58.      and down arrows if necessary to scroll the list.
  59.          Pressing F1 again (i.e. while you are already in TLIST) will toggle
  60.      between the file-information list and the file-description list.
  61.  
  62.    F2 - Received file list
  63.  
  64.          This command will produce a listing of the files are have been
  65.      received. Similar to the "F1" list above, you may use the up/down
  66.      arrows to scroll the list. THe list is updated as files are received.
  67.          If you are connected to another copy of SZModem, the sender
  68.      will transmit a special "advance transfer list" containing a listing
  69.      of the files that will be sent. This list will be displayed with the
  70.      F2 command.
  71.          As with F1 above, pressing F2 again will toggle betweem the file
  72.      information display and the file description display.
  73.  
  74.    F3 - SDOS (simulated dos)
  75.  
  76.          SDOS is a special dos emulator that lets you perform a variety of
  77.      operations while the transfer is taking place. You can copy/move files,
  78.      list directories, change attributes, etc - most of the common things you
  79.      do with normal dos.
  80.          You may get a listing of supported SDOS commands by typing "HELP"
  81.      at the dos prompt. Typing help with a command name (i.e. HELP DIR) will
  82.      display help for that specific command.
  83.          Most SDOS commands are pseudo-multitasked as to not interfere with
  84.      the transfer, although with high speed modems (i.e. 14,400 baud and
  85.      up) the transfer may slow down during disk-intensive operations.
  86.  
  87.    F4 - COMM PARAMS
  88.  
  89.          This command will pop up a display of the current communications
  90.      parameters - baud rate, parity, buffer status, etc. It can be useful in
  91.      debugging difficulties.
  92.  
  93.    F5 - VIEW
  94.  
  95.          Pressing F5 will allow you to "view" the transfer as it is taking
  96.      place. You will actually see the characters of the file, zmodem
  97.      handshaking, and line noise as it takes place.
  98.          If you press F5 while you are already in the view window, you will
  99.      toggle the view mode. There are 6 different modes. Here is a listing:
  100.  
  101.            1 - Direct ascii printing of characters as they are sent or recvd
  102.            2 - Ascii print only RECEIVED characters
  103.            3 - Ascii print only TRANSMITTED characters
  104.            4 - HEX printing of transmitted and received characters
  105.            5 - HEX printing of only received characters
  106.            6 - HEX printing of only transmitted characters
  107.  
  108.          The modes will cycle one at a time each time you press F5. Initially,
  109.      this whole idea of the view mode was simply a debugging option for me,
  110.      but I figure some users might like to watch the transfer taking place.
  111.  
  112.    F6 - MESSAGES
  113.  
  114.          The message display shows a log of the various messages that SZModem
  115.      displays on the screen - CRC Error, Waiting for ZRINIT, stuff like that.
  116.  
  117.    F7 - CHAT
  118.  
  119.          This command can only be used when two SZModems are connected to
  120.      each other - it won't work with a normal Zmodem. The chat mode allows
  121.      you to talk to the user at the other end of the transfer. The screen
  122.      will be split into two windows - one for what you type, one for what
  123.      the other guy types.
  124.          Pressing CTRL-G will page the other user if he isn't at his
  125.      terminal. The page will beep for thirty seconds, one beep every
  126.      three seconds.
  127.  
  128.    F8 - GAMES
  129.  
  130.          The games menu will be displayed and you can select a game to play
  131.      while the transfer is taking place. There are two kinds of games -
  132.      single player games which to play by yourself and multiplayer games
  133.      in which you play against the guy on the other end.
  134.          The single player games may be player no matter what you are
  135.      connected to, but the multiplayer games require you to be connected to
  136.      another copy of SZModem.
  137.  
  138.    F9 - MAIL READER
  139.  
  140.          This is a feature designed to be used by the sysops of Bulletin
  141.      Boards which have a FIDO compatible message format. (See the below
  142.      section on "The Mail Reader" for info on setting up this feature)
  143.          By pressing F9, the sysop will be allowed to read messages in the
  144.      chosen message base. There are several additional UNLISTED keys available
  145.      in this window:
  146.  
  147.          "N"  Move forward one message
  148.          "P"  Move backwards one message
  149.       <Space> If the message is more than one screen, this will scroll the
  150.               window.
  151.  
  152.    F10 - EXIT
  153.  
  154.          This brings you the exit option which aborts all files and returns
  155.      you to the DOS prompt.
  156.  
  157. COMMAND LINE OPTIONS
  158. --------------------
  159.        SZModem was designed specially to have a command line similar to the
  160. popular DSZ Zmodem protocol. This way users with an understanding of DSZ
  161. can easily set up SZModem. The options area as follows:
  162.  
  163. "SZMODEM <options> <transfer type> <filenames>"
  164.  
  165. Options can be any one of the following:
  166.  
  167.    "PORT x"     specifies using comport x. (i.e. "PORT 2" would use com2)
  168.  
  169.    "SPEED x"    specifies the baud rate (i.e. "SPEED 2400 would use 2400 baud)
  170.  
  171.    "IRQ x"      specifies a nonstandard IRQ. (NOTE: please specify the
  172.                 address in DECIMAL, not HEX). You must supply BOTH an IRQ
  173.                 and an address to use nonstandard ports.
  174.  
  175.    "ADDR x"     specifies a nonstandard ADDRESS. (NOTE: please specify
  176.                 the address in decimal, not hex). You must supply BOTH an IRQ
  177.                 and and address to use nonstandard ports.
  178.  
  179.    "/NOLOG"     disables logging to the "SZMODEM.LOG" file.
  180.  
  181.    "/M"         monochrome mode.
  182.  
  183.    "/DORINFO x" Specifies the node number of a dorinfo.def file to grab the
  184.                 user's name from. If you specify this option, SZModem will
  185.                 load in the dorinfo, get the user name, and display it in
  186.                 the screen so you know who is downloading. (I.e. specifying
  187.                 "/DORINFO 1" would load in "DORINFO1.DEF")
  188.  
  189.    "/INSIZE x"  Specifies the size (in bytes) of the internal comm input
  190.                 buffer. (Note: not used if using fossil)
  191.  
  192.    "/OUTSIZE x" Specifies the size (in bytes) of the internal comm output
  193.                 buffer. (Note: Not used if using fossil)
  194.  
  195.    "/SZPATH x"  Specifies a path to which the SZXFER$$.LST and SZMODEM.LOG
  196.                 files will be written to. If not specified, the files will
  197.                 be created in the current directory.
  198.  
  199.  "/DELAYTIME x" SZModem by default will wait 5 seconds at the end of
  200.                 transfer for a keypress to before exiting. BBS sysops may
  201.                 wish to lower this time for faster operation. The "x"
  202.                 specifies the default time to delay, which may be
  203.                 from 0-30 seconds. (NOTE: /DELAYTIME can be abbreviated
  204.                 /DT)
  205.  
  206.    "/SZTURBO"   Causes SZModem to attempt to use the SZTurbo option if
  207.                 possible. If SZTurbo is to operate, both sides must have this
  208.                 option set. See "SZTURBO" below. (NOTE: /SZTURBO can be
  209.                 abbreviated /SZT)
  210.  
  211.    "/NBS"       This stands for "normal block size". By default, if two
  212.                 SZmodem's are connected, they will allow the Zmodem packet
  213.                 length to rise to 2048 bytes/packet at 2400 baud or 4096
  214.                 bytes/packet for higher speeds. Specifying "/NBS" will force
  215.                 SZModem to use block lengths of 1024 bytes or less.
  216.  
  217.    "/NORBL"     Will cause your copy of SZModem to refuse to accept LARGE
  218.                 format (i.e. embedded file description info) advance transfer
  219.                 lists.
  220.  
  221.    "/NOSBL"     Will cause your copy of SZModem to refuse to send LARGE
  222.                 format (i.e. embedded file description info) advance transfer
  223.                 lists.
  224.  
  225.    "/FL"        This will cause SZModem to create an additional log file
  226.                 called "FILELOG.TXT". This log is intended to allow users to
  227.                 keep a record of files they receive. It only logs RECEIVED
  228.                 files and it includes the name, size, and optional description
  229.                 of the file.
  230.  
  231.    "/NOPAGE"    This will prevent another copy of SZModem from paging your
  232.                 copy.
  233.  
  234.   "/FILEDESC x" This specifies an additional FILEDESC list of file
  235.                 descriptions. "x" is the path and filename of the file. See
  236.                 "Large Advance Transfer Lists" for more info.
  237.  
  238.    "/CHECKSNOW" If you are using a CGA card and it gets snow, try using this
  239.                 option.
  240.  
  241.    "/EGA"       If you have an EGA or VGA display, this switch will enable the
  242.                 43/50 line modes.
  243.  
  244.    "/DL"        This option will cause SZModem to create a DSZ.LOG file. This
  245.                 file will contain a DSZ-style log. This option may be used
  246.                 with BBS programs that require a DSZ.LOG file to operate their
  247.                 external protocols. SZMODEM also will enable the DSZ.LOG if
  248.                 the environment variable "DSZLOG=xxx" is used.
  249.  
  250.    "/CFGPATH x" Specifies a path to where the configuration file (SZMODEM.CFG)
  251.                 can be found. "x" is the path with or without a trailing
  252.                 backslash. It doesn't matter.
  253.  
  254.    "/HARD"      This turns on HARD flow control. This means that when your
  255.                 modem drops CTS, SZModem will stop transmitting until CTS
  256.                 is raised again. This option is frequently used with high
  257.                 speed modems and/or locked baud rates.
  258.  
  259.    "/SOFT"      This is similar to the above HARD flow control, but uses
  260.                 ascii characters to control the flow. Namely, the Xon and
  261.                 Xoff characters - when XOFF is received, SZModem will stop
  262.                 transmitting and when XON is received, SZModem will resume.
  263.                 (Note: SZTURBO mode is not available with this type of
  264.                 handshaking)
  265.  
  266.    "/LOCK x"    Specifies a locked baud rate. The com port will be set to
  267.                 the baud rate specified by this parameter, and the baud rate
  268.                 specified by "BAUD x" above will be used for estimation
  269.                 purposes.
  270.  
  271.    "/RR+"       Enable receive recovery option (DEFAULT). If receive recovery
  272.                 is enabled (and then if the sender permits) then szmodem will
  273.                 allow files to be recovered/resumed at the aborted position
  274.                 rather than having to resend the entire file.
  275.  
  276.    "/RR-"       Disables the above receive recovery option.
  277.  
  278.    "/SR+'       Enable send recovery option (DEFAULT). If send recovery is
  279.                 enabled, then szmodem will allow remote zmodem's to recover
  280.                 files.
  281.  
  282.    "/SR-"       Disables the above send recovery option.
  283.  
  284.    "/NO16550"   Disables automatic use of 16550 UART chip.
  285.  
  286. Transfer type may be any one of the following:
  287.  
  288.    "RZ"        receive zmodem file(s)
  289.    "SZ"        send zmodem file(s)
  290.  
  291. Filenames are interpreted as follows:
  292.  
  293.    Send mode:  Multiple filespecs may be present. Wildcards are allowed.
  294.  
  295.    Recv mode:  A path to the receive directory is expected. No filenames
  296.                are necessary. If you add a filename, SZModem will strip it
  297.                from the string and ignore it.
  298.  
  299. EXAMPLES:
  300. ---------
  301.  
  302. "SZMODEM PORT 4 SPEED 9600 SZ \UPLOAD\*.ZIP /HARD"
  303.  
  304.        Send all the .ZIP files in your upload directory using COM4 at
  305.   9600 baud. Hardware flow control (/HARD) will be used.
  306.  
  307.  
  308. "SZMODEM SPEED 1200 RZ"
  309.  
  310.        Receive files at 1200 baud using COM1. Store them in the current
  311.   directory.
  312.  
  313.  
  314. "SZMODEM PORT 3 RZ \TEMP"
  315.  
  316.        Receive files at 2400 baud using COM2. Store them in the "\TEMP"
  317.   directory.
  318.  
  319. Files
  320. -----
  321.        SZMODEM.EXE   -  The executable code for SZModem. This is what you
  322.                         need to call to execute the protocol. Memory
  323.                         requirements should be from 130-170k depending
  324.                         on how you have szmodem set up.
  325.  
  326.        SZCONFIG.EXE  -  This program allows you to set a variety of
  327.                         SZModem's default options. Now modifies SZMODEM.EXE
  328.                         directly.
  329.  
  330.        SZMODEM.DOC   -  These docs that you are reading.
  331.  
  332.        SZMODEM.HLP   -  An ASCII help file which contains help on the SimDos
  333.                         commands.
  334.  
  335.        REGISTER.FRM  -  Registration form for registering your copy of
  336.                         SZModem.
  337.  
  338.       +SZMODEM.TRV   -  A "trivia" file which lets you play trivia during
  339.                         SZModem.
  340.  
  341.       +ROCK&POP.TRV  -  An alternate trivia file written by Michael Crosson
  342.                         of The Carrier Detect Journal.
  343.  
  344.       +APPLYCFG.EXE  -  Utility for applying SZCFG.DAT files to SZMODEM.EXE.
  345.  
  346.       +LOGANA.EXE    -  The SZModem log analizer.
  347.  
  348.       +SZSUP.DOC     -  Doc file for SZSUPxxx.ARJ.
  349.  
  350.       +SZTELIX.ZIP   -  Sample telix setup for szmodem.
  351.  
  352.       *SZMODEM.LOG   -  A log created which contains a listing of files
  353.                         transferred, dates/times, etc. May be disabled
  354.                         with the "/NOLOG" option. You may set the
  355.                         path this file will be placed in with the "/SZPATH"
  356.                         option.
  357.  
  358.       *DSZ.LOG       -  If the /DL parameter was specified, this file will
  359.                         be created to allow for compatibility with the
  360.                         popular DSZ protocol.
  361.  
  362.       *SZXFER$$.LST  -  This is the "advance transfer list" file. It is
  363.                         created by the sender and if the receiver is also a
  364.                         zmodem, is sent to so the receiver may have a list
  365.                         of files to be received ahead of time.
  366.  
  367.       *FILELOG.TXT   -  If the "/FL" parameter is specified, this will will
  368.                         contain a listing of all files received (downloaded)
  369.                         by SZModem. Included is the file name, size, and
  370.                         optional description.
  371.  
  372.       (* Denotes file is CREATED by SZModem, not distributed with the package)
  373.  
  374.       (+ Denotes files supplied in the suppliemental szmodem archive,
  375.          SZSUPxxx.ARJ. They are described further within that archive)
  376.  
  377. Hardware Requirements
  378. ---------------------
  379.      Processor: 10mhz 80286 or above. (Will not work on 8088)
  380.  
  381.      Display:   Anything should work
  382.  
  383.      Memory:    SZMODEM.EXE  130-200k
  384.  
  385.      UART:      NS16550A suggested for use with speeds 9600 baud or above,
  386.                 but old style UARTs may work.
  387.  
  388. A word about the 16550
  389. ----------------------
  390.  
  391.    A 16550 UART is recommended for use with SZMODEM at baud rates of 9600
  392.    or above.
  393.  
  394.          You may be able to get szmodem to work with older UARTs at these
  395.    speeds as well, but I do recommend going with the 16550 if possible. The
  396.    reason is that the communications routines that we are using now are a
  397.    bit slower than the previous routines. This means that at high speeds,
  398.    szmodem may not be able to "keep up" when receiving files.
  399.  
  400.          If you would like more information about 16550 UART's, then you may
  401.    wish to contact your favorite local bbs. There is usually someone
  402.    knowledgable on hand.
  403.  
  404. Nonstandard port addresses:
  405. ---------------------------
  406.          You must use the "IRQ x" and "ADDR x" parameters to specify a
  407.    nonstandard com port. Numbers must be in DECIMAL, not HEX. DO NOT
  408.    specify a "PORT" if you use nonstandards.
  409.  
  410.    For example:
  411.  
  412.    "SZMODEM IRQ 2 ADDR 1016" would cause szmodem to use whatever port is
  413.                              at IRQ=2 and ADDRESS=1016 ($3F8 hex)
  414.  
  415. Flow Control, Handshaking, High-Speed Modems, Locked baud
  416. ---------------------------------------------------------
  417.          SZModem includes two command line options for controlling computer-
  418.    to-modem handshaking. This handshaking allows the modem to send some form
  419.    of signal to SZModem to tell SZModem to stop sending data if the modem's
  420.    buffer becomes overflowed.
  421.          If you are using a 2400 baud modem or lower, and are sending data to
  422.    this modem at 2400 baud, then no handshaking options should be necessary.
  423.    But, if you are using a high speed modem at a locked baud rate, handshaking
  424.    is VERY necessary.
  425.          The are two type of handshaking: HARD and SOFT. Hard handshaking uses
  426.    the CTS/RTS lines (i.e. wires) between your modem to control data flow and
  427.    is considered the better of the two. SOFT handshaking uses two special
  428.    ASCII characters, XON and XOFF, to control handshaking. Basically, you have
  429.    to match SZModem to the type of handshaking your modem uses.
  430.          To enable HARD handshaking, specify the "/HARD" option on the command
  431.    line. To enable SOFT handshaking, specify "/SOFT". You should only specify
  432.    one, not both.
  433.          Consult your modem manual, bbs software docs, etc for more
  434.    information on handshaking.
  435.  
  436. SZTetris!
  437. ---------
  438.          New with version 1.50, a game called "SZTetris" has been included in
  439.    the games (F8) menu. The game is your standard Tetris type game. You can
  440.    use the arrow keys to move the falling blocks, the J,K,L keys, or the
  441.    keypad w/numlock (4,5,6,2).
  442.          The game is in its eary stages and may still have a couple of
  443.    glitches in it.
  444.          NOTE: SZTetris is a processor-speed hog. If your running szmodem
  445.    at 19.2kbaud at a low cpu speed (8mhz or lower), you may get errors. On my
  446.    25mhz 386, however, I have tested szmodem at 19.2kbaud while playing
  447.    sztetris with no troubles whatsoever.
  448.  
  449.  
  450. SZTurbo
  451. -------
  452.          SZTurbo is an option that will allow you to improve file transfer
  453.    efficiency by as much as four percent. To explain how SZTurbo works,
  454.    I must discuss a little about how Zmodem itself works.
  455.          In the Zmodem specification, certain bytes cannot be transmitted
  456.    freely across the modem connection. These bytes are XON, XOFF, ZDLE (a byte
  457.    very important to Zmodem), and a few others. If for example, an XOFF
  458.    was transmitted across the modem link, it could cause difficulties.
  459.          Although these bytes may not be transmitted, they do occur in binary
  460.    files so Zmodem must find someway to transmit them. What it does is send
  461.    a ZDLE followed by byte (i.e. the XOFF) XOR 64. This translates the illegal
  462.    character to a harmless ASCII letter that may be freely sent across the
  463.    modem link.
  464.          A few quick thoughts and you should be able to see that every time
  465.    one of these "illegal" characters are encountered, two bytes (The ZDLE
  466.    and the character XOR 64) must be sent. Sending two characters instead of one
  467.    obviously adds overhead to the transfer, slowing it down.
  468.          It turns out that most of these "illegal" characters are not illegal
  469.    under most situations. Almost all current moedems are able to transfer
  470.    XONs,XOFFs, etc just fine. So basically what SZTURBO does is send these
  471.    illegal characters just like any other character. Here's a quick diagram
  472.    to help explain this:
  473.  
  474.                                      Characters sent        Character(s) sent
  475.        Character in File             without SZTurbo          with SZTurbo
  476.        -----------------          ---------------------     ----------------
  477.          ZCHAT (#14)                ZDLE (#24) "N"            ZDLE (#24) "N"
  478.          DLE   (#16)                ZDLE (#24) "P"            DLE  (#16)
  479.          XON   (#17)                ZDLE (#24) "Q"            XON  (#17)
  480.          XOFF  (#19)                ZDLE (#24) "S"            XOFF (#19)
  481.          ZDLE  (#24)                ZDLE (#24) "X"            ZDLE (#24) "X"
  482.  
  483.          As you can see, SZTurbo shortens the sequences for DLE, XON, and
  484.    XOFF from 2 characters down to one character. While this does not seem like
  485.    much, it can add up to a four percent efficiency gain. When you're paying
  486.    the long distance bill, you'll appreciate this.
  487.          Specifying "/SZTURBO" on the command line will cause your copy of
  488.    SZModem to "attempt" to engage the SZTurbo option. SZTurbo is only
  489.    available if both sides have the option specified.
  490.  
  491. Large Advance Transfer Lists
  492. ----------------------------
  493.          Starting with this version, there is support for a "large" advance
  494.    transfer list. The main difference between the normal list and the "large"
  495.    list is that the large list contains optional file descriptions as well
  496.    as the name, date, etc. The receiver or sender may browse through these
  497.    descriptions while the transfer is taking place.
  498.          The problem is, SZModem can't just make up these descriptions
  499.    itself. The sender must somehow provide SZModem with the descriptions. If
  500.    the sender is a bbs program, then the descriptions are available from
  501.    the BBS's file catalog. The descriptions must, however, still be converted
  502.    to a format that SZModem can understand.
  503.          SZModem will look for file descriptions in the file "FILEDESC.TXT"
  504.    (or "FILEDE1.TXT", "FILEDE2.TXT", etc if you are multinode) in the
  505.    directory specified by the /SZPATH option. This file follows a simple
  506.    format. It is plain ASCII with each line of the file corresponding to a
  507.    file. The filename starts at column 1 and the descriptions starts at
  508.    column 15. For example:
  509.  
  510.  
  511. ::-- Col. 1  ::--- col. 15
  512. ::           ::
  513. \/           \/
  514. SZMOD120.ZIP  Zmodem protocol with Chat, Simdos, etc
  515. GALWAR75.ZIP  Galactic Warzone version 7.5
  516. DOORDR30.ZIP  Doordriver door support routines
  517. MACH10.ZIP    Mach-10 bbs
  518.  
  519.  
  520.          When SZModem loads, providing the /NOSBL switch is not specified and
  521.    providing this file exists, the descriptions will be searched, loaded, and
  522.    sent to the receiver providing his /NORBL switch is not set.
  523.          As you have probably noticed, this format is probably not what your
  524.    bbs uses. Since I don't have information on the file formats of most BBS
  525.    packages, I had to make do with this "generic" format. Hopefully, some
  526.    bbs sysops who are programmers can write a utility to grab the necessary
  527.    descriptions out of their file catalogs and throw them into the
  528.    FILEDESC.TXT file.
  529.          Note: The FILEDESC.TXT file may be named FILEDE1.TXT or FILEDE2.TXT
  530.    depending on your configuration. The /DORINFO switch will determine which
  531.    .TXT file SZModem will look for. If no /DORINFO is specified, FILEDESC.TXT
  532.    will be used. If /DORINFO 1 was specified, FILEDE1.TXT will be loaded.
  533.          Examples:
  534.  
  535.                                                         Filedesc file used
  536.                                                         ------------------
  537.          SZMODEM SZ FOO.BAR                             FILEDESC.TXT
  538.          SZMODEM /DORINFO 1 SZ FOO.BAR                  FILEDE1.TXT
  539.          SZMODEM /DORINFO 2 SZ FOO.BAR                  FILEDE2.TXT
  540.          SZMODEM /SZPATH \protocol SZ FOO.BAR           \PROTOCOL\FILEDESC.TXT
  541.          SZMODEM /SZPATH \protocol /DORINFO 1 .....     \PROTOCOL\FILEDE1.TXT
  542.  
  543.          Now, a quick word on the /NOSBL and /NORBL switches. If you specify
  544.    /NOSBL, your copy of SZModem will not send the description info under any
  545.    circumstances. If you specify /NORBL, your SZModem will not allow another
  546.    SZModem to send the description info under any circumstances. Example:
  547.  
  548.  
  549.          Sender               Receiver                  Desc info sent
  550.          ------------------   -------------------       --------------
  551.          SZMODEM SZ ...       SZMODEM RZ ...                *YES
  552.          SZMODEM /NOSBL SZ    SZMODEM (anything)             NO
  553.          SZMODEM (anything)   SZMODEM /NORBL                 NO
  554.  
  555.          (* only if FILEDESC.TXT, FILEDE1.TXT, etc exists on sender side)
  556.  
  557.          Additional FILEDESC files may be specified using the /FILEDESC
  558.    option. Use the format "/FILEDESC x" where "x" is the path and filename
  559.    of the additional list to search. You may add as many of these additional
  560.    lists as you wish. (NOTE: Operation will occur faster if all of the
  561.    descriptions are in one file rather than many file)
  562.  
  563. File Lists
  564. ----------
  565.          If you specify @<filename> on then command line, <filename> will be
  566.    opened and any file paths contained within will be sent. For example,
  567.    suppose a textfile, "TOSEND.TXT" contained the following:
  568.  
  569.  
  570.    \DOWNLOAD\SZMOD120.ZIP
  571.    \MACH10\WELCOME.TXT
  572.    \GALWAR\TWARS.EXE
  573.  
  574.          If you called up SZModem with the command line "SZMODEM SZ
  575.    @TOSEND.TXT", SZModem would then send the three files listed above. This
  576.    allows you to specify many different filenames in an ascii file rather
  577.    than have to fit them all on the command line.
  578.          You may also specify SZModem parameters in these "file lists". You
  579.    could specify "/DORINFO 1 /SZTURBO /SZPATH \protocols", etc and then call
  580.    it up with the "@" sign rather than having to put all of those options on
  581.    the command line.
  582.  
  583. The Mail Reader
  584. ---------------
  585.          SZModem is equipped with a mail reader capable which allows the
  586.    sysop to read any messages in a fido-format message base. This feature is
  587.    only useful for BBS systems or mail point systems, and has no particular
  588.    interest to users.
  589.          With version 1.60 and above, SZModem may handle up to three
  590.    message areas.
  591.          Message areas are configured within SZConfig.exe. The options are
  592.    under the mAil selection of the Configuration menu. There will be a total
  593.    of five options presented.
  594.          "Front Door Path". If you are using the front-door mailer, then
  595.    you may specify the path to your front door directory here. If you do,
  596.    then szmodem will allow you to view your in/outbound history and your
  597.    recent activity.
  598.          "Message Area x". These configure the three message areas. There
  599.    are three fields to each entry. The first is the "path". Which is used
  600.    in fido format bases. If the base you are trying to add is fido, then
  601.    put the path here.
  602.          The second option is "name". This is the name/tag of the area.
  603.    The third option is type. Zero (0) is for no message area configured,
  604.    One (1) is for a HP format area, and two (2) is for a fido area.
  605.          "HP Message Path". If you are using a HP format message base
  606.    (currently only supported by Mach-10 and the upcoming Safari bbs), then
  607.    put the path to your HP message directory here.
  608.          Then, you may use the F9 key to enter the mail reader. The "N"
  609.    and "P" keys will move you forward or reverse in the area and the SPACE
  610.    bar will scroll a message.
  611.  
  612. Benchmarks
  613. ----------
  614.          The following chart compares the CPS readings for some various
  615.    protocols. SZMODEM ver 1.31 was used for the SZMODEM tests and DSZ1612
  616.    was used for the DSZ Zmodem, Xmodem, and ymodem tests.
  617.          The tests were performed between two AT-class machines running
  618.    at 8mhz.
  619.  
  620.                           SZMODEM    SZMODEM  DSZ     DSZ     DSZ
  621. Filename      File Size   w/SZTURBO           ZMODEM  XMODEM  YMODEM
  622. ------------  ---------   ---------  -------  ------  ------  ------
  623. SYSOP.DOC       18357        399       390      235     200    200
  624. MACHCTL.ZIP     20643        236       232      234     201    200
  625. MOUSE.COM       14249        284       274      234     202    199
  626. SIMCGA.ZIP       2406        233       233      235     200    200
  627.  
  628.  
  629. SZCONFIG.EXE
  630. ------------
  631.          Szconfig.exe is a configuration utility supplied to allow you to
  632.    make changes to the default options within szmodem. Szconfig was written
  633.    with Turbo Vision to allow for a nice, user friendly interface.
  634.          It is important to note that the new version of szconfig.exe
  635.    differs strongly from the older version supplied with Szmodem 1.50 and
  636.    previous.
  637.  
  638.          1> Changes are now made to SZMODEM.EXE directly. This means there
  639.             is no nasty szmodem.cfg file or anything else that you have
  640.             to worry about.
  641.  
  642.          2> Many more options are available. In fact, SZCONFIG is the only
  643.             way to set szmodem's sound options.
  644.  
  645.          3> You can use keyboard as well as mouse to get your way around
  646.             in SZCONFIG.
  647.  
  648.          4> By using SZCONFIG, you may enter your registration code directly
  649.             into szmodem.exe rather than having to bother with that
  650.             szreg.dat file.
  651.  
  652.             NOTE: You should make a backup fo your registration code so the
  653.                   data is not lost when/if you upgrade to a new szmodem.exe
  654.  
  655.          To move around in SZCONFIG, you'll need to either use a mouse or
  656.    the TAB/shift-TAB keys. Use tab to move down an option, and shift-tab to
  657.    move up an option.
  658.  
  659.  
  660. Revison History
  661. ---------------
  662.        Version 1.00  -  First public BETA release.
  663.  
  664.                         This software has not been tested very well at
  665.                         this point. There may be trouble with high speed
  666.                         modems, COM3/4 conflicts, etc. Please report any
  667.                         bugs to my bbs listed below.
  668.  
  669.        Version 1.01  -  Fixed a problem that caused the DORINFO display
  670.                         that caused the users last name and city to be
  671.                         displayed. Now, the user's full name and city is
  672.                         displayed.
  673.  
  674.        Version 1.02  -  Added the "/SZPATH" option to allow the user
  675.                         to specify what directory the SZMODEM.LOG and
  676.                         SZXFER$$.LST files will be placed in.
  677.  
  678.                         Fixed a bug which was causing runtime error
  679.                         2 that had to do with the SZXFER$$ list.
  680.  
  681.                         Added "/DELAYTIME" option to specify time that
  682.                         SZModem will delay after a transmission is completed,
  683.                         waiting for a keypress.
  684.  
  685.                         The CHAT indicator will now blink when a remote user
  686.                         is typing in chat and the local user is in another
  687.                         window.
  688.  
  689.        Version 1.10  -  Added FREE and SIZE commands to simdos. See the
  690.                         SZMODEM.HLP file for more information.
  691.  
  692.                         Various cosmetic improvements.
  693.  
  694.                         Made the SIMDOS parser a bit more intelligent. It can
  695.                         now process commands without spaces between parameters
  696.                         such as "DIR/W" or "CD..".
  697.  
  698.                         Added DELNUL command to delete zero-length files.
  699.  
  700.                         SZModem now displays a small message if the user does
  701.                         not specify SZ or RZ. This helps new users to know
  702.                         they do in fact need to specify SZ/RZ.
  703.  
  704.                         SZModem /HELP command now available. Displays a small
  705.                         help screen of some of SZModem's command line
  706.                         parameters.
  707.  
  708.                         Major revisions to the actual ZMODEM transfer code.
  709.  
  710.                         CRC32 now used rather than CRC16 and the block check
  711.                         display now correctly reflects this. (Note: If the
  712.                         sender requests CRC16, the receiver will be stuck with
  713.                         CRC16 also)
  714.  
  715.                         Error correction will now function properly in both
  716.                         CRC32 and CRC16 modes.
  717.  
  718.                         "Last frame" display on receiver now functions
  719.                         properly.
  720.  
  721.                         Default delay time changed from 10 seconds to 5
  722.                         seconds. (See /DELAYTIME above)
  723.  
  724.                         Added an overlay version of the program (SZMODOVR.EXE)
  725.                         to allow for systems with less available memory.
  726.  
  727.        Version 1.20     Added SZTurbo option to increase transfer efficiency
  728.                         by as much as 4%. See the SZTurbo section of this doc
  729.                         for more info.
  730.  
  731.                         Added "/NBS" option to allow users to restrict
  732.                         SZModem's block size down to the standard 1024 bytes/
  733.                         block like normal zmodem.
  734.  
  735.                         The minor version identifier (i.e. .20) is now sent
  736.                         along with the major version identified (i.e. 1)
  737.  
  738.                         Message screen (F6) code revised to reduce flickering
  739.                         and add smoother scrolling.
  740.  
  741.                         Two ZChallenges are now sent between copies of SZModem
  742.                         to allow for additional information to be passed -
  743.                         version numbers, flags, etc.
  744.  
  745.                         Added provisions for LARGE Advance transfer lists.
  746.                         (See Above). The new large list allows the sender to
  747.                         send file descriptions along with the usual file info.
  748.  
  749.                         Fixed the TLIST and RLIST displays so they scroll the
  750.                         corrent number of lines.
  751.  
  752.                         Added "/FL" switch for a received file log.
  753.  
  754.        Version 1.21     Added more information to the log display.
  755.  
  756.                         Fixed a bug which caused file descriptions to be
  757.                         garbage when receiving file from a normal Zmodem.
  758.  
  759.                         Added ability to process file lists. (See above:
  760.                         File lists)
  761.  
  762.                         Added /FILEDESC option to specify additional
  763.                         filedesc files.
  764.  
  765.                         Added the /CHECKSNOW option to enable snow checking.
  766.  
  767.                         Fixed the DELNUL command in SDOS so that it does not
  768.                         try to delete files as they are being received.
  769.  
  770.                         Control-Break is now trapped and no longer aborts the
  771.                         program.
  772.  
  773.                         Added CTRL-G option to allow users to page in chat
  774.                         mode.
  775.  
  776.        Version 1.30     Default internal output buffer size has been
  777.                         changed from 256 bytes to 512 bytes.
  778.  
  779.                         Revised overlay code so hopefully SZMODOVR.EXE can
  780.                         be used by multiple nodes on a network without
  781.                         difficulty.
  782.  
  783.                         Added file compression capability. LZW compression
  784.                         routines will speed up the transmission of most
  785.                         non-compressed data.
  786.  
  787.                         Default internal input/output buffer sizes
  788.                         re-adjusted to 1k and 6k respectively.
  789.  
  790.                         Added a simple sysop mail reader to allow the sysop
  791.                         to read mail while transfer is in progress.
  792.  
  793.                         Fixed a bug with the ZChallenges that caused SZModem
  794.                         to not abort if the Zchallenges were not responded
  795.                         to.
  796.  
  797.                         Included a "Small" version which is even smaller than
  798.                         the overlay version. Left out are the games module
  799.                         and the mail reader module. The filename is
  800.                         SZMODSML.EXE.
  801.  
  802.                         Added a zip viewer to SimDos. The command "ZIPVIEW
  803.                         <filename>" will display the file directory of a
  804.                         zip file.
  805.  
  806.        Version 1.31     Added DEBUG command to simdos to allow users to
  807.                         browse through files in a hexadecimal mode.
  808.  
  809.                         EGA/VGA 43/50 line modes are available with the
  810.                         /EGA command line switch.
  811.  
  812.                         If SZTURBO is enabled and soft (Xon/Xoff) flow
  813.                         control is enabled, the SZTURBO will automatically
  814.                         be disabled.
  815.  
  816.                         Added SZCONFIG.EXE configuration utility.
  817.  
  818.                         /DL command line will enable a DSZ.LOG file log
  819.                         for compatibility with various bbs programs.
  820.  
  821.        Version 1.40     REMOVED FOSSIL SUPPORT
  822.                         There was just too little demand for use of the fossil
  823.                         interface routines and considering the overhead it was
  824.                         adding (an additional jump and compare for every
  825.                         async function can add up), the code was removed and
  826.                         the INTERNAL routines are now accessed directly.
  827.  
  828.                         Major serial code revisions. On locked baud modems,
  829.                         the keyboard I/O shouldn't slow down quite as bad
  830.                         as before. Chat may still appear choppy though.
  831.  
  832.                         Added a DORINFOx.DEF path to SZCONFIG.EXE. You may
  833.                         now set the path that SZModem will look for
  834.                         DORINFOx.DEF with SZCONFIG.EXE.
  835.  
  836.                         Added CFGPATH parameter to specify path to
  837.                         the SZMODEM.CFG file.
  838.  
  839.        Version 1.41     Added information on HandShaking to docs.
  840.  
  841.                         Added handshaking options to SZCONFIG.EXE.
  842.  
  843.                         Added locked baud capabilities with the "/LOCK"
  844.                         parameter.
  845.  
  846.        Version 1.42     Fixed minor bug with command line options. Command
  847.                         line options now override environment vars at all
  848.                         times (i.e. SZMODEM port 2 would override SET DSZPORT=
  849.                         1)
  850.  
  851.                         If transfer times out, szmodem will return errorlevel
  852.                         of 1.
  853.  
  854.                         DSZLOG is now appended to rather than rewritten
  855.                         by SZMODEM.
  856.  
  857.                         Fixed problem with /CFGPATH causing files to be
  858.                         written to the root directory.
  859.  
  860.        Version 1.43     Added abbreviations "/SZT" for /SZTURBO and "/DT" for
  861.                         delay time.
  862.  
  863.                         Added the "BROWSE" command to simdos. Browse will let
  864.                         you scroll up and down within a file.
  865.  
  866.                         Fixed problem with received file path.
  867.  
  868.                         Altered some code in the Z_challenge routine to
  869.                         compensate for a bug in QMODEM (Qmodem does not
  870.                         understand Z_Challenge requests which caused
  871.                         szmodem to abort the xfer)
  872.  
  873.                         Altered some code to hopefully fix a glitch or
  874.                         two at high speeds. (14,400 and 19,200 baud may
  875.                         have gotten some aborts due to "header is fubar"
  876.                         messages. This should now be fixed)
  877.  
  878.        Version 1.44     Some cosmetic improvements and minor bug fixes.
  879.  
  880.                         Added registration request.
  881.  
  882.                         Added support for nonstandard IRQ/address
  883.  
  884.        Version 1.50     Added SZTETRIS! Available from the games menu!
  885.  
  886.                         default delay time lowered to 2 seconds.
  887.  
  888.                         Replaced the more-or-less meaningless ZFRAME
  889.                         status item with a realtime-updated CPS display.
  890.  
  891.                         With the internal tetris, SZMODEM.EXE got too big
  892.                         to be usable; with some efficiency fixes, SZMODOVR
  893.                         and SZMODSML became about the same, so now we only
  894.                         distribute one version.
  895.  
  896.                         The SZXFER$$.LST transfer list is now deleted after
  897.                         szmodem is completed.
  898.  
  899.                         Shrunk the size of the control-key line at the
  900.                         bottom of the screen a bit to provide for additional
  901.                         screen space in sztetris, simdos, etc. Two extra
  902.                         lines can really make a difference!
  903.  
  904.        Version 1.60     Fixed SZTetris so it will work correctly on
  905.                         monochrome systems.
  906.  
  907.                         Totally re-wrote SZCONFIG.EXE using Turbo Vision. A
  908.                         section is provided above describing the new
  909.                         configuration utility.
  910.  
  911.                         Added sound effects!
  912.  
  913.                         A registration string is now sent across the
  914.                         chat channel at the start of transfer.
  915.  
  916.                         word-wrapping now works in the chat section.
  917.  
  918.                         Added colored directories to SIMDOS so it looks a
  919.                         bit better. (note: colored dirs can be turned
  920.                         on and off from SZCONFIG.EXE)
  921.  
  922.                         Recover option can be turned on/off at the
  923.                         command line and in SZCONFIG.EXE.
  924.  
  925.                         Might have fixed a glitch with the errorlevels
  926.                         not working correctly.
  927.  
  928.                         Fixed the DSZLOG so that files received are
  929.                         denoted by a "Z" and files sent are denoted as
  930.                         a "z".
  931.  
  932.                         Added a display after szmodem exits to tell the
  933.                         errorlevel returned.
  934.  
  935.                         Taking a bit of a risk, I turned off i/o checking
  936.                         (turbo's {$I-}) throghout szmodem to gain a little
  937.                         speed and reduce program size a bit. Overall EXE
  938.                         size dropped by 6k.
  939.  
  940.                         Lowered the default ouptput buffer size to 512
  941.                         bytes to see how it works out. Might provide for
  942.                         better chat response and more reliable error
  943.                         recovery.
  944.  
  945.                         Added a "CMD:" field to the szmodem.log file which
  946.                         shows if szmodem was invoked with "SZ", "RZ" or
  947.                         none.
  948.  
  949.                         Fixed up the four-in-a-row game a little. It should
  950.                         now detect diagonals and ties.
  951.  
  952.                         A file "SZSUPxxx.ARJ" is now being produced which
  953.                         includes some supplimental szmodem utilities and
  954.                         files.
  955.  
  956.                         Switched to Turbo Pascal version 6.0. Don't know
  957.                         if it'll make much of a difference, but it may make
  958.                         some changes.
  959.  
  960.                         Turned off the hardware cursor and put our own
  961.                         software driven cursor in its place. Chat and
  962.                         simdos look a bit better now.
  963.  
  964.                         Reworked the MAIL system a bit. I've added a few
  965.                         statistical functions for people using the Front-
  966.                         Door mailer and I've changed it so you can have
  967.                         up to three message areas.
  968.  
  969.                         Removed LZW compression.
  970.  
  971.                         Fixed a slight bug with the ZIP viewer.
  972.  
  973.        Version 1.61     Fixed bug with SZXFER.LST showing up with wrong
  974.                         filename.
  975.  
  976.        Version 2.00     Replaced the communications routines with a newer
  977.                         library.
  978.  
  979.                         Dropped the old 8088-compatible version (szmodem
  980.                         is now 286/386/486-only)
  981.  
  982.                         Change of registration policy.
  983.  
  984.                         Added a warning message to inform users who are
  985.                         transferring at high speeds without using flow
  986.                         control.
  987.  
  988.                         Added 16550 UART support.
  989.  
  990. Credit to Other Authors
  991. -----------------------
  992.  
  993.        1) Turbo Pascal Zmodem Source. This software was built up from a rather
  994.           buggy source code of Zmodem in turbo pascal. The code did not list
  995.           an author.
  996.  
  997.        2) Chuck Forsberg. Chuck originally developed the zmodem protocol
  998.           specs which szmodem is based on.
  999.  
  1000. Registration/donations
  1001. ----------------------
  1002.        SZModem represents many hours of programming and debugging. If you find
  1003. this software useful, then please register your copy to support my efforts. I
  1004. can not continue to work on major projects like this without some form of
  1005. compensation.
  1006.  
  1007.      Due to the mass of number of registrations of SZMODEM and other
  1008.  programs of mine, I have had to change my registration/donation policy
  1009.  slightly. I simply don't have time to do all of the disk copying
  1010.  and mailing! Since every user who registers SZMODEM obvoisly has access
  1011.  to a modem, I have decided to simply put the registration codes up on my
  1012.  bbs for people to get online.
  1013.  
  1014.      Because I don't need to send out packages, I have lowered the price
  1015.  from the previous $25 to $20.
  1016.  
  1017.      Here is what you do to register:
  1018.  
  1019.      #1: Send me $20+ in the mail. (Smaller donations are always appreciated,
  1020.          but I usually don't issue reg codes)
  1021.  
  1022.      #2: Call up my bbs about a week later and use the "Reglook" command to
  1023.          look up your registration code online.
  1024.  
  1025.      #3: Create a file called SZREG.DAT and with an ASCII text editor or
  1026.          word processor, type in the data given to you by reglook. Then
  1027.          tell SZCONFIG to read in your registration data.
  1028.  
  1029.          - - - or - - -
  1030.  
  1031.          Run the program SZCONFIG.EXE and enter the registration data
  1032.          directly (remember to make a backup of your code in case you
  1033.          lose it)
  1034.  
  1035.      Please note, under this new policy I will not send you a package in
  1036.  the mail (unless you really, really need it!).
  1037.  
  1038.      Please send registrations to the following address:
  1039.  
  1040.  
  1041.                       Scott Baker
  1042.                       6431 Tierra Catalina #48
  1043.                       Tucson, AZ 85718
  1044.  
  1045.        I may also be reached through my online bulletin board:
  1046.  
  1047.                       The Not-Yet-Named BBS
  1048.                       (602) 577-3650 <Node 1> 1200/2400/9600 baud (v.32)
  1049.                       (602) 577-3419 <Node 2> 2400/9600/14400 baud (USR DUAL)
  1050.                       Tucson, AZ
  1051.  
  1052.        The BBS always has the latest copy of SZModem (and any of my other
  1053. projects) available for downloads. We are also part of FidoNet and RBBSNET
  1054. and offer several file and message areas.
  1055.