Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / HSLK112.ZIP / HSLINK.DOC < prev next >

Wrap

Text File | 1992-05-13 | 97.4 KB | 2,539 lines

▒▒▒▒▄ ▒▒▒▒▄ ▒▒▒▒▒▒▒▒▄ ▒▒█▀ ▒▒█▀ ▒▒█▀▀▀▒▒█ HS/Link ▒▒█ ▒▒█ ▒▒█ ▀▀ ▒▒▒▒▒▒▒▒█ ▒▒▒▒▒▒▒▒▄ High Speed Link ▒▒█▀▀▀▒▒█ ▀▀▀▀▒▒█ ▒▒█ ▒▒█ ▒▒▄ ▒▒█ File Transfer Protocol ▒▒▒▒█ ▒▒▒▒█ ▒▒▒▒▒▒▒▒█ ▀▀▀▀ ▀▀▀▀ ▀▀▀▀▀▀▀▀ HS/Link Version 1.1 Copyright (C) 1991, 1992 Samuel H. Smith All Rights Reserved, Worldwide PLEASE REFER TO HSLINK.NEW FOR DETAILS OF RECENT PROGRAM CHANGES! HS/Link is a high speed, full streaming, bidirectional, batch file transfer protocol with advanced Full-Streaming-Error-Correction. Each side of the link is allowed to provide a list of files to be sent. Files will be sent in BOTH directions until both sides of the link are satisfied. HS/Link is not just another bidirectional protocol, it is also a very fast protocol for normal downloading and uploading, incorporating some new ideas (such as Full-Streaming-Error-Correction and Dynamic-Code- Substitution) to make things happen a bit faster and with greater reliability. This program is not free! You are hereby licensed to use this program for a trial period of 30 days free of charge. If, after 30 days, you decide that you would like to continue using HSLINK, you must complete the registration form (REGISTER.FRM) and return it to the author with the required registration fee enclosed. Registration removes the "UNREGISTERED" and "PLEASE REGISTER" messages, as well as all time delays. Registered copies broadcast their registration number to the remote unit. Please feel free to distribute HSLINK to your friends and local BBSes as long as all of the files in this archive are included and unmodified. See the LICENSE AND REGISTRATION section of this document for more details. HS/Link 1.1 User Documentation - 1 - Table of Contents _________________________________________________________________ Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Full Screen Status Display . . . . . . . . . . . . . . . . . . . . . 5 Command Line Format . . . . . . . . . . . . . . . . . . . . . . . . . 6 Basic Command Line Options . . . . . . . . . . . . . . . . . . . . . 6 HS/Link Configuration Manager . . . . . . . . . . . . . . . . . . . . 8 Advanced Command Line Options . . . . . . . . . . . . . . . . . . . 14 Command Line Examples . . . . . . . . . . . . . . . . . . . . . . . 20 Calling HS/Link from COMM programs . . . . . . . . . . . . . . . . 21 Calling HS/Link from BBS programs . . . . . . . . . . . . . . . . . 22 Flow Control . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Full Streaming Data Transmission . . . . . . . . . . . . . . . . . 26 Full Streaming Error Recovery . . . . . . . . . . . . . . . . . . . 27 Dynamic Code Substitution . . . . . . . . . . . . . . . . . . . . . 28 Transmission of Minimal Blocks . . . . . . . . . . . . . . . . . . 28 DSZLOG Statistic Logging . . . . . . . . . . . . . . . . . . . . . 29 Network Compatibility . . . . . . . . . . . . . . . . . . . . . . . 30 Auto Downloading . . . . . . . . . . . . . . . . . . . . . . . . . 31 Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . 32 License and Registration . . . . . . . . . . . . . . . . . . . . . 38 Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Distributors . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 HS/Link 1.1 User Documentation - 2 - Introduction _________________________________________________________________ What is a file transfer protocol? A file transfer protocol is a means of transferring information from one computer to another. The protocol has the responsibility of protecting against errors in transit, and taking measures to correct any errors that are detected. The design and implementation of a protocol can make the difference between slow and unreliable communication, and fast and trouble free communication. Not all protocols are created equal. With today's high speed modems, packet switched networks (such as PC Pursuit), and expensive long distance charges, users demand more than ever that files get through quickly and without corruption. The HS/Link protocol is the result of years of communication experience, and uses some very new and solid technology to see to it that you can easily move files as quickly as possible, and with the least amount of hassle. The HSLINK program can be used from the DOS command line, from BATCH files, or as an "external protocol" from most modern COMM programs and BBS programs. If your favorite BBS does not yet support the HS/Link protocol, please ask your SYSOP to install it. Recent advances in high speed modem technology have made it possible to simultaneously transfer data at high speeds in both directions. This standardized technology is called "V.32" or "V.32bis", and is available in many ┌───────────────────────────┐ new modems. Until HS/Link, these │Bidirectional features that│ advanced modems were left half idle, due │really work... │ to the single-direction nature of prior │HS/Link can simultaneously │ file transfer protocols. The │send and receive files! │ bidirectional capabilities of HS/Link └───────────────────────────┘ take full advantage of these modems, cutting online time as much as 50% when equal amounts of data are transmitted and received. HS/Link 1.1 User Documentation - 3 - Summary of Key Features _________________________________________________________________ ∙ Speed. HS/Link operates at or very near peak efficiency, often reaching 98% or more with pre-compressed files and non-buffered modems. Even higher speeds are possible with buffered or error correcting modems. A number of features, such as fast 32 bit CRC protection, Full- Streaming-Error-Recovery and Dynamic-Code-Substitution, combine to give maximum performance and security. ∙ Simple interface for beginners. In many cases, HS/Link requires only the COM port number and the filename to be transmitted. Configuration files are not required. The program is easily installed in most COMM programs that support external protocols. The HSLINK program has multiple help screens, providing a quick reference to the basic and advanced command line options, including examples of how the program is used. ∙ Batch file transfers. The protocol can handle any size batch of files, and can take file specifications from either the command line or from a listing file. ∙ Bi-directional options that really work. The program can simultaneously upload and download with a single host request. What's even better is how easy it is to use... instead of a complex setup all you do is: 1) Tell the BBS the names of the files you want to download, and then 2) Press PGUP (or whatever your COMM program uses to UPLOAD files) and then tell your COMM program which files to upload By virtue of the BBS being told that it is sending files and your COMM program telling HS/Link that it too is sending files you then have a bidirectional transfer. There's nothing else to set up. You use the familiar BBS interface to request files to download and your COMM program's familiar interface to tell it which files to upload. It couldn't get easier! ∙ Aborted file crash recovery. When desired, HS/Link can resume an aborted transfer, verifying all existing data blocks to insure the resumed file completely matches the file being transmitted. This function can also update a file that has only a small number of changed, added, or deleted blocks. HS/Link 1.1 User Documentation - 4 - Full Screen Status Display _________________________________________________________________ When HS/Link is operating, it produces a full screen status display, divided into five windows. For example: ╒══════════ HS/Link v1.1 (5/11/92) Copyright 1992 Samuel H. Smith ══════════╕ │ [UNREGISTERED] Courtesy of The Tool Shop BBS (818) 891-6780. │ │ Command line: -@tolap.cfg test\*.* -s2048 -w12 -a │ └────────────────────────────────────────────────────────────────────────────┘ ╒═════════ 5 InComing Files, 710782 bytes ═════════╕ ╒══════ Settings ═══════╕ │ \TMP\VIROSCAN.ZIP (79 blocks, 161003 bytes) │ │ COM2 open at: 115200 │ │ File received OK, 2930 cps, 58 seconds. │ │Remote Serial#: 00001 │ │ \TMP\PM.ZIP (37 blocks, 73745 bytes) │ │Remote Version: 1.10 │ │ Block 14 (28672 bytes) 2622 cps │ │ Window: NONE │ │ █████████████░░░░░░░░░░░░░░░░░░░░░░ 18 seconds │ │ Block size: 2048 │ └──────────────────────────────────────────────────┘ │ XON/XOFF: ON │ ╒════════ 9 OutGoing Files, 2297792 bytes ═════════╕ │ CTS handshake: OFF │ │ TEST\PHASE1.EXE (179 blocks, 365810 bytes) │ │ RTS handshake: OFF │ │ File sent OK, 5907 cps, 01:01 minutes. │ │Slow handshake: ON │ │ TEST\PHASE2.EXE (204 blocks, 416884 bytes) │ │ Resume: OFF │ │ Block 20 (40960 bytes/w:20) 5570 cps │ │ Keep partial: ON │ │ ███░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 01:08 minutes│ │ Overwrite: ON │ └──────────────────────────────────────────────────┘ └─ ^X^X^X^X to abort! ──┘ ╒═══════════════════════════════ Batch Status ═══════════════════════════════╕ │ Total 2047451 bytes (of 3008574) in 04:00 minutes, thruput 8509 cps. │ │ ██████████████████████████████████░░░░░░░░░░░░░░░░░ 01:53 minutes remaining│ └───────────────────────── PLEASE REGISTER HS/LINK! ─────────────────────────┘ The first window contains the program identification and copyright. When you register your copy of HSLINK, this window will also show the registered serial number. Some warning messages may also appear in this window. The "Settings" window shows a summary of the various parameters that can be altered with command line options. The "InComing Files" window shows the status of files being received from the remote system. The "OutGoing Files" window shows the status of files being transmitted to the remote system. The "Batch Status" window summarizes overall session progress and estimates the time remaining for the selected files. To stop display bleedthrough under DesqView or DoubleDOS, use the -NV option to disable direct video writing. If desired, the full screen status display can be turned off. To do this, use the -NF command line option. When running in -NF mode, a simple line-oriented status display will scroll down the screen. This may be desired under some circumstances. HS/Link 1.1 User Documentation - 5 - Command Line Format _________________________________________________________________ To run the HSLINK program, a command line must be given. The command line has the following format: HSLINK [options] [SENDFILE] [@DRIVE:\PATH\FILELIST] SENDFILE Indicates a list of files to be transmitted to remote computer. The list may include the DOS wildcard characters '?' and '*'. Specify ONLY files to be transmitted; received file names are determined automatically. @FILELIST Transmit list of files contained in FILELIST to remote computer. This is used when you want to make a long list of files in advance, then transmit them all with a single command. It is also used by BBS programs to produce long batches of downloads. ∙ Anything shown in brackets "[]" is optional and may not need to be specified for proper operation of HS/Link. ∙ The HSLINK command line is NOT case sensitive, and will work when typed in upper, lower or mixed case. ∙ Please make sure that HSLINK.EXE is in a search PATH directory. Basic Command Line Options _________________________________________________________________ The most important command line options are -P (set COM port), -U (set download file directory), and -HS (enable slow handshake). -Pport This option specifies which COM port you are using. Example: -P2 -Udir This option controls the destination directory for downloaded files. Without this option, all download files are placed into the current directory. Example: -Uc:\bbsfiles -HS Handshake Slow (send XOFF and/or lower RTS during disk I/O). This option may be required if your computer is unable to simultaneously access the disk and the COM port. If you see frequent CRC error messages, even on clean phone lines, you probably need to include -HS in your command line. To abort an HS/Link transfer, press Control-X four or more times. HS/Link 1.1 User Documentation - 6 - Configuration Files _________________________________________________________________ Because of the large number of possible command line options, it is possible to store frequently used command options in a configuration file. This eliminates the need to ┌────────────────────────┐ repeatedly type the options at a command │HS/Link does NOT require│ line. If you are calling HSLINK from │configuration files. │ multiple batch files, you can also use └────────────────────────┘ configuration files to store "common" options, that can be changed in one place rather than separately in the various batch files. HSLINK will first search the current for the HSLINK.CFG file. If not found, it ┌───────────────────────────┐ will then search the directory where │For best results, add your │ HSLINK.EXE is stored, followed by all │HS/Link or COMM program │ directories in the DOS PATH setting. If │directory to your PATH │ the HSLINK.CFG file is found, each file │statement. │ line is loaded as a command line option. └───────────────────────────┘ If you want to use an alternate configuration file, use the -@fname command line option, which will cause 'fname' to be loaded. For example: HSLINK -@C:\WORK\TOLAP.CFG will cause HSLINK to use C:\WORK\TOLAP.CFG as the configuration file. If -@fname is not the first command line option, the default HSLINK.CFG file will be searched for and loaded before the specified configuration file. Use -@ (without a filename) to prevent HSLINK from searching for a configuration file, slightly speeding operation on systems that have a long search PATH setting in effect. To aid in creation and alteration of configuration files, the HS/Link ┌───────────────────────────┐ Configuration Manager program, HSCONFIG, │Use HSCONFIG to create and │ was written. │edit HS/Link option │ │(configuration) files. │ └───────────────────────────┘ HS/Link 1.1 User Documentation - 7 - HS/Link Configuration Manager _________________________________________________________________ HSLINK includes the HS/Link Configuration Manager program, HSCONFIG.EXE. With this program you can easily manipulate most of HS/Link's many options. The opening display for HSCONFIG looks like this: Node-3 C:\HSL >hsconfig HS/Link Configuration Manager 1.1 (C)1992 Samuel H. Smith; ALL RIGHTS RESERVED ┌────────────────── New Configuration ─────────────────────┐ │ │ │ The specified configuration file cannot be located. │ │ │ │ This probably indicates that you are creating a new │ │ configuration for HS/Link. All options will be set │ │ to default values. │ │ │ │ Alternate configuration files can be specified on │ │ the command line to HSCONFIG. The default configuration │ │ file is HSLINK.CFG, and it may be located either in the │ │ current directory, or in any PATH directory. │ │ │ │ Press <ENTER> or <ESC> to continue. │ │ │ │ Index <ESC> │ └──────────────────────────────────────────────────────────┘ Can't find: C:\UTIL\HSLINK.CFG HSCONFIG can be used to edit any configuration file, but the default is to edit HSLINK.CFG in the current directory, or the same directory in which HSLINK.EXE is found. If you want to edit some other configuration file, you must specify the filename on the HSCONFIG command line. For example: HSCONFIG TOLAP.CFG will create or edit TOLAP.CFG, which can later be used by HSLINK with a command line like this: HSLINK -@TOLAP.CFG When no configuration filename is specified, and the default configuration file HSLINK.CFG cannot be located, it will automatically be created in the same directory that HSLINK.EXE is found in. If you wish to create the configuration file in a different directory, you must explicitly specify the directory/filename to be used on the HSCONFIG command line. HS/Link 1.1 User Documentation - 8 - The primary screen in HSCONFIG is the "Basic Settings" screen, which controls the most important settings for HS/Link operation. The other screens contain advanced settings that need not be changed until you become more familiar with the program and begin to explore the advanced capabilities. ╒════════════════════════ HS/Link: Basic Settings ════════════════════════╕ │ │ │ These are the most important settings for proper HS/Link operation │ │ │ │ COM port number (1-8) . . . . . . . . . . . 1 │ │ │ │ Directory for downloaded files. . . . . . . __________________________ │ │ │ │ Use "SLOW HANDSHAKE" during disk I/O. . . . N │ │ │ ╘═════════════════════════════════════════════════════════════════════════╛ ┌──────────────────── Welcome! ───────────────────────┐ │ Welcome to the HS/Link Configuration Manager. │ │ The easy way to handle HS/Link configuration files. │ │ │ │ Use the arrow keys to select entries on this page. │ │ Use the PgUp/PgDn keys to change pages. │ │ Press ESC to save changes when you are finished. │ │ │ │ Use the F1 key to get HELP at any prompt. │ └─────────────────────────────────────────────────────┘ PgDn [next page] PgUp [prior page] F1 [help] ESC [exit] The HSCONFIG program contains context sensitive pop-up help for each and every input prompt. Simply press the F1 key to get an explanation of the current entry. For example: ┌───────────────────────────── -U ────────────────────────────────┐ │ -Udir > Download directory. │ │ │ │ This option controls the destination directory for downloaded │ │ files. Without this option, all download files are placed into │ │ the current directory. │ │ │ │ Index <ESC> │ └─────────────────────────────────────────────────────────────────┘ When in the online help system, press the SPACE and BACKSPACE keys to select from the topics available at the bottom of the window, and press ENTER to select a topic. Press ESCAPE to return to the prior screen. HS/Link 1.1 User Documentation - 9 - The "Advanced COM Settings" screen determines the settings of many communications related options. See the following section, "Advanced Options" for a description of each of these options. ╒════════════════════ HS/Link: Advanced COM Settings ═══════════════════OVR═╕ │ │ │ These settings control advanced communication features │ │ │ │ Non-Standard COM base (in HEX, 0 = standard COM port) . . . . . . 0000 │ │ │ │ Non-Standard COM IRQ (1-15, 0 = standard COM port). . . . . . . . 0_ │ │ │ │ COM port open speed (300-115200, 0 = automatic) . . . . . . . . . 0_____ │ │ │ │ Effective modem-to-modem speed (0 = same as open speed) . . . . . 0_____ │ │ │ │ Enable CTS hardware handshake . . . . . . . . . . . . . . . . . . Y │ │ │ │ Enable RTS hardware handshake . . . . . . . . . . . . . . . . . . Y │ │ │ │ Enable XON/XOFF software handshake. . . . . . . . . . . . . . . . Y │ │ │ │ Enable Carrier Detect checking. . . . . . . . . . . . . . . . . . Y │ │ │ │ Preserve original time/date stamp on received files . . . . . . . Y │ │ │ ╘═══════════════════════════════════════════════════════════════════════════╛ PgDn [next page] PgUp [prior page] F1 [help] ESC [exit] This screen manipulates the following options: -PB (define non-standard COM base address), -PI (define non-standard COM irq), -B (COM port open speed), -E (effective modem to modem speed), -HC (disable CTS handshake), -HR (disable RTS handshake), -HX (disable XON/XOFF handshake), -C (disable carrier detect monitoring) and -NT (disable preservation of original date/time stamp) These options will be described in detail in the next section. HS/Link 1.1 User Documentation - 10 - The "Advanced Optional Features (part 1)" screen controls many advanced protocol features. See the following section, "Advanced Options" for a description of each of these options. ╒═════════════ HS/Link: Advanced Optional Features (part 1) ════════════OVR═╕ │ │ │ These settings control various optional features │ │ │ │ Attempt to Resume aborted transfers . . . . . . . . . . . . . . . N │ │ │ │ Keep partial files from aborted transfers . . . . . . . . . . . . N │ │ │ │ Allow received files to overwrite/modify existing files . . . . . N │ │ │ │ Enable file read/write buffering. . . . . . . . . . . . . . . . . Y │ │ │ │ Enable "Dynamic-Code-Substitution" logic. . . . . . . . . . . . . Y │ │ │ │ Size of transmitted data blocks (64-4096 bytes/block) . . . . . . 1024 │ │ │ │ Number of blocks in transit before ACK is required (0-1000) . . . 8___ │ │ │ │ Disable transmission of ACK for each block received . . . . . . . N │ │ │ │ Force remote unit to use local option settings. . . . . . . . . . N │ │ │ ╘═══════════════════════════════════════════════════════════════════════════╛ PgDn [next page] PgUp [prior page] F1 [help] ESC [exit] This screen manipulates the following options: -R (resume aborted transfers), -K (keep partial files), -O (allow overwrite of receive files), -NB (disable file buffering), -NC (disable dynamic code substitution), -S (data block size), -W (acknowledge window size), -A (disable receive acknowledge) and -! (force remote to use local options) These options will be described in detail in the next section. HS/Link 1.1 User Documentation - 11 - The "Advanced Optional Features (part 2)" screen controls more advanced protocol features. See the following section, "Advanced Options" for a description of each of these options. ╒═════════════ HS/Link: Advanced Optional Features (part 2) ════════════OVR═╕ │ │ │ These settings control more optional features │ │ │ │ Idle method (0=none, 1=bios, 2=desqview, 3=ddos). . . . . . . . . 0 │ │ │ │ Disable NS16550AN buffering logic . . . . . . . . . . . . . . . . N │ │ │ │ Enable "Minimal-Blocks" logic (requires MNP). . . . . . . . . . . N │ │ │ │ Incoming file duplication check list. . . . ____________________________ │ │ │ │ DSZLOG status logging file. . . . . . . . . ____________________________ │ │ │ │ Force CTS handshake even when CTS is initially missing. . . . . . N │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ╘═══════════════════════════════════════════════════════════════════════════╛ PgDn [next page] PgUp [prior page] F1 [help] ESC [exit] This screen manipulates the following options: -I (what to do during idle time), -N5 (disable hardware buffering if NS16550 is present), -NM (enable minimal blocks logic), -NO (incoming file duplication checklist), -FL (DSZLOG status logging file), and -FC (force CTS handshake even when CTS is missing) These options will be described in detail in the next section. HS/Link 1.1 User Documentation - 12 - The "Screen Settings" screen allows you to control the format of the status display screen, the colors to be used, and to enable or disable direct-video screen updates. ╒════════════════════════ HS/Link: Screen Settings ════════════════════OVR═╕ │ │ │ These settings control the screen format and colors │ │ │ │ Enable Full-Screen status display . . . . . . . . . . . . . . . . Y │ │ Enable direct video writing (turn off in DesqView/DoubleDOS/etc). Y │ │ │ │ Color of BORDER in full screen mode . . . . . . . . . . . . . . . 7__ │ │ Color of PROMPTS in full screen mode. . . . . . . . . . . . . . . 47_ │ │ Color of WINDOW TITLE in full screen mode . . . . . . . . . . . . 79_ │ │ Color of WINDOW CONTENTS in full screen mode. . . . . . . . . . . 31_ │ │ Color of PROGRESS GRAPHS in full screen mode. . . . . . . . . . . 14_ │ │ │ ╘══════════════════════════════════════════════════════════════════════════╛ ┌── Color Table ───────────────────────────────────────────────────┐ │ 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 │ │ 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 │ │ 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 │ │ 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 │ │ 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 │ │ 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 │ │ 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 │ │ 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 │ └──────────────────────────────────────────────────────────────────┘ PgDn [next page] PgUp [prior page] F1 [help] ESC [exit] This screen manipulates the following options: -NF (disable full screen status display), -NV (disable direct video screen updates), -CB (define border color), -CM (define main/prompt color), -CT (define title color), -CW (define window contents color) and -CG (define bargraph color) These options will be described in detail in the next section. HS/Link 1.1 User Documentation - 13 - Advanced Command Line Options _________________________________________________________________ The HS/Link protocol program has a number of command line options, most of which are rarely needed, or which are provided for advanced users to obtain maximum performance and flexibility. -@fname Uses fname as an alternate configuration file. Each line in the specified file may contain a single command line option. The default is to search PATH directories for HSLINK.CFG. -! Take priority. Locally specified -A, -HX, -S, and -W settings will be used by the remote system. -A Disable transmission of ACK codes after each block. This may improve transfer speeds under some conditions. -Bbaud COM port opening baud rate 300- ┌───────────────────────────┐ 115200 (default=current port OPEN │Don't use the -B option if │ speed). │you don't need to! In most│ This option controls the speed at │cases HS/Link is able to │ which the COM port will be opened. │automatically determine the│ │proper port opening speed. │ Normally, the COM port speed can be └───────────────────────────┘ determined from hardware and need not be specified. -C Disable carrier detect checking. Use this option when directly connecting two machines via a null modem cable. -CBcolor Defines the border color in full screen mode. -CMcolor Defines the main screen color in full screen mode. -CTcolor Defines the window title color in full screen mode. -CWcolor Defines the window contents color in full screen mode. -CGcolor Defines the file and batch progress bargraph color in full screen mode. HS/Link 1.1 User Documentation - 14 - -Ebaud Effective modem-to-modem baud rate. This is used to estimate transfer times, and is included in the DSZLOG output. (default=current -B setting) -FC Force CTS hardware handshake. This option prevents HSLINK from automatically disabling CTS hardware handshake if CTS is not active initially. -HC Disables CTS hardware handshake. CTS transmitter handshake is automatically enabled, but may conflict with some unusual modem cables or serial ports. If the CTS signal is not active when HSLINK loads, it will automatically disable CTS handshake for you. Use the -HC command to manually disable CTS handshake. -HR Disables RTS hardware handshake. RTS receiver handshake is used when the slow-handshake option is selected. This form of handshake causes the RTS line to the modem to be lowered whenever the disk is being accessed. Some unusual modem or cable arrangements may not tolerate the RTS line being lowered. In this case, the RTS handshake can be disabled with the - HR option. -HS Handshake Slow (send XOFF and/or lower RTS during disk I/O). The slow handshake option is available for systems with slow disk access. Use this if you get frequent CRC errors or COM Overrun errors on otherwise clean lines. The slow handshake option causes XOFF to be sent and/or RTS to be lowered during any disk activity. Even when -HS is active, the HS/Link protocol should transfer data very nearly as fast as the slowest part of the link allows. -HX Disable XON/XOFF handshake. XON/XOFF handshake is a software handshake scheme that should work well on all combinations of modems and networks, and is enabled by default. If you prefer not to use XON/XOFF handshake, or you find that it is not required for error-free transfer, you can disable it with the -HX option. Note that both the sender and the receiver must simultaneously disable XON/XOFF handshake, otherwise it will remain in effect. HS/Link 1.1 User Documentation - 15 - -Iidle This option controls how idle time is given up under multitasking environments. The possible values are: -I0 Default, do not give up idle time -I1 Spend idle time checking keyboard status -I2 Give up idle time under DesqView -I3 Give up idle time under DoubleDOS Some network server software, such as LanTastic, performs best when the -I1 option is used. -K Keep partial files from aborted transfers. -LFlogfile Specify status log file. This option allows you to override the DSZLOG environment variable to specify the file to be used for status logging. Omit this option, or leave blank to control this function through the DSZLOG environment variable. -N5 This option causes HS/Link to disable NS16550 buffering logic. This option may be needed with some early versions, or incorrect clone versions of the NS16550 chip, which do not properly perform buffering. -NB Disable buffering of receive and transmit files. The default is to divide approximately 24k of memory between InComing and OutGoing files. -NC Disable Dynamic Code Substitution logic. Certain byte codes cannot be transmitted directly over the COM link. For instance, the codes for Control-X, Control-S and Control-Q must be "escaped" to prevent a conflict with flow or program control. The HS/Link protocol uses a new Dynamic Code Substitution system to drastically reduce the number protocol overhead and "escape" codes needed to transmit certain data streams. Highly compressed data files (such as ZIP and GIF files) benefit the most, since they often have many byte codes that cannot be transmitted directly over the COM link. -NF Disable Full screen mode. The standard status display takes over the full screen (except the top 2 lines, which may contain a BBS status line). This option bypasses the full screen display and causes a line- oriented output to be used. Use this option if your environment's screen management does not allow a full-screen display. HS/Link 1.1 User Documentation - 16 - -NM Enable Minimal Blocks logic. Use ┌─────────────────────────┐ with caution. This option is │HS/Link's Full Screen │ recommended for use only on error- │status display does not │ corrected links, such as with MNP │alter the first 2 display│ or V.42 connections. │lines. The last display │ │line is also left alone. │ -NT └─────────────────────────┘ Stamp current file time. This option stamps the current time/date on received files, instead of retaining the original file time/date. -NOdirlist Incoming file duplication checklist. This option allows you to check incoming files for duplication in a list of directories. This feature prevents incoming files from duplicating files in directories other than the current -U setting. The dirlist is a text file which contains one filename or directory specification per line. See MKDLIST documentation for special instructions to speed CD-ROM duplication checking. -NU Block uploads. This option is used by BBS programs that cannot (yet) cope with bidirectional uploads. It is used in place of the - U option on the 'download' command line, and has the effect of blocking any simultaneous upload requests from a user. -NV Disable direct Video for ┌─────────────────────────┐ DesqView/DoubleDOS/etc. Use this │You may need to use -NV │ option if you experience "bleeding" │to stop display bleeding.│ of the status display from one └─────────────────────────┘ partition to another. -O Allow receive files to overwrite existing files. -Pport Use COM port 1-8 (default=1). Standard COM port definitions: Channel I/O Port Interrupt COM1 0x3F8 4 COM2 0x2F8 3 COM3 0x3E8 4 COM4 0x2E8 3 COM5 undefined COM6 undefined COM7 0x2E8 5 COM8 0x3E8 5 Use -PB and -PI instead of -P to define a non-standard COM port. HS/Link 1.1 User Documentation - 17 - -PBbase Set non-standard COM port base address. Base addresses may be specified in either decimal or hex. Hex addresses must begin with $ or 0x. For example, -PB1000, -PB$3E8 and -PB0x3E8 all specify the same port base address. -PIirq Set non-standard COM port IRQ level to 1-15. This option must be used when -PB is used. IRQ levels 8-15 are supported only on AT class machines with cascaded interrupt controllers. HS/Link 1.1 User Documentation - 18 - -R Resume aborted transfer. The ┌────────────────────────┐ receiver and transmitter will │Use -R -K -O if you want│ verify the contents of an existing │Download Crash Recovery │ file, and will begin transmission └────────────────────────┘ at the first block that does not match. This provides a reliable means of restarting an aborted transfer, or of updating a modified file. You must also use -O to recover aborted downloads. -Ssize Sets transmit block size 2-4096 (default=1024) Larger block sizes may result in higher transfer speeds under clean line conditions. -Udir Destination directory for received files (default=current directory) -Wwindow Number of blocks allowed without ┌──────────────────────┐ ACK 1-1000 (default=8) │Use -W4 -S512 -! with │ Use -A to establish an "infinite" │PC-Pursuit │ window (i.e. no ACK required at └──────────────────────┘ all). The "ACK window" is the number of blocks that will be sent to the modem before an ACKnowledge code is required. If the specified number of blocks have been sent and no ACK has yet been received, output will be suspended until the ACK is received or the link times out. This provides a form of software flow control that works well when parts of the link are very slow compared to other parts, such as when PC Pursuit is in use. The /w:XXX value displayed in the InComing Files window reports the actual number of blocks that are being transmitted prior to acknowledge. Setting the -W value higher than the highest /w:XXX value observed will have no further effect on transfer thruput. HS/Link 1.1 User Documentation - 19 - Command Line Examples _________________________________________________________________ HSLINK -? Display a summary of HS/Link command line formats. HSLINK -P1 Download from a BBS using HS/Link. COM1 will be used at the current port speed. Received files will go into the current directory. HSLINK -P2 -Uc:\bbsfiles -K Download from a BBS using HS/Link. COM2 will be used at the current port speed. Received files will go into the c:\bbsfiles directory. Partial files from aborted transfers will be kept. HSLINK -P1 -Uc:\bbsfiles -R -K -O Continue an aborted download from a BBS using HS/Link. COM1 will be used at the current port speed. Received files will go into the c:\bbsfiles directory. HSLINK -Uc:\bbsfiles c:\uploads\*.zip Download from a BBS using HS/Link. COM1 will be used at the current port speed. Received files will go into the c:\bbsfiles directory. Simultaneously upload all *.ZIP files in the c:\uploads subdirectory. HSLINK file1.zip file2.zip file3.zip Upload to a BBS using HS/Link. COM1 will be used at the current port speed. Simultaneously downloads selected files from the BBS into the current directory. HSLINK -b115200 -p2 -c -hs -hc -a file1.zip file2.zip Communicate files with a laptop computer using port COM2 and a three wire null modem cable. HSLINK -w4 -s512 -! -uc:\download Download files through PC-Pursuit using a window of 4 blocks and a block size of 512 bytes. This setting stops most errors when PC- Pursuit is heavily loaded. HS/Link 1.1 User Documentation - 20 - Calling HS/Link from COMM programs _________________________________________________________________ The HS/Link protocol can be easily installed in most modern COMM programs. Specific instructions have been prepared for many popular COMM programs, and are available in separate files for download. Communication program Instructions posted in _____________________ _______________________ BOYAN 4.01 HS-BOY40.ZIP BOYAN 5.0 HS-BOY50.ZIP {COMMO} HS-COMMO.ZIP GT POWER 15.50 HS-GT15.ZIP ProComm Plus and ProComm Plus Test Drive HS-PCPTD.ZIP QMODEM 4.3 HS-QMOD.ZIP ROBO COMM 3.1 HS-RC31.ZIP TELEMATE 2.1 HS-TMATE.ZIP TELIX 3.1 HS-TELIX.ZIP Installation instructions for new COMM programs are being written all the time, ┌───────────────────────────┐ so check with your local bulletin board │Check The Tool Shop BBS for│ or on the Tool Shop for instructions for │the latest version of │ additional communication programs. │HS-INST.ZIP. New COMM and │ │BBS programs are frequently│ │added to the library of │ │install instructions │ │available. │ └───────────────────────────┘ HS/Link 1.1 User Documentation - 21 - Calling HS/Link from BBS programs _________________________________________________________________ The HS/Link protocol can easily be installed in most modern BBS programs as an external protocol. Specific instructions have been prepared for many popular BBS programs, and are available in separate files for download. BBS program Instructions posted in ___________________________ _______________________ Searchlight BBS HS-SLBBS.ZIP Spitfire BBS version 3.0 HS-SF30.ZIP UltraBBS version 2.08 HS-UB208.ZIP Wildcat! Test Drive v. 2.15 HS-WC215.ZIP Auntie 5.12 HS-AU512.ZIP GAP 5.1 HS-GAP51.ZIP MarkMail under Gap HS-MKML.ZIP PCBOARD 14.5 (11/90) HS-145.ZIP PCBOARD 14.5a (10/30/91) HS-145A.ZIP PROBOARD 1.17 HS-PB117.ZIP PRODOOR 3.43 (10/30/91) HS-PROD.ZIP RemoteAccess 1.10 HS-RA110.ZIP RemoteAccess 1.11 HS-RA111.ZIP RemoteAccess HS-RA.ZIP RBBS 17.3C (12/05/91) HS-R173C.ZIP Rybbs HS-RYBBS.ZIP SuperBBS 1.15 Gamma4 HS-S1154.ZIP Searchlight BBS HS-SLBBS.ZIP Spitfire BBS version 3.0 HS-SF30.ZIP UltraBBS version 2.08 HS-UB208.ZIP Virtual BBS version 5.40 HS-VBB54.ZIP Waffle HS-WAF.ZIP Wildcat! Test Drive version 2.15 HS-WC215.ZIP WWIV version 4.20 HS-WWIV.ZIP HS/Link 1.1 User Documentation - 22 - BBS Requirements _________________________________________________________________ HS/Link's demands on a bulletin board program are extremely easy to fill. The following is all that is necessary: 1) The protocol accepts either a filename to download or a list of ┌────────────────────────┐ files of the form │Send file lists are text│ @DRIVE:\PATH\DOWNLIST.LST. The │files that contain one │ protocol will send only the │path/filename per line. │ specified files if filenames └────────────────────────┘ (without leading @) are given, or all of the files found in C:\BBS\DOWNLIST.LST if @C:\BBS\DOWNLIST.LST is specified. 2) The protocol will create a DSZLOG compatible log file indicating the names of all files transferred as well as their status (refer to the DSZ standard and the "DSZLOG Statistic Logging" section for the specific contents of the file). 3) Any files found in the DSZLOG file which BBS did not tell the protocol ┌─────────────────────────┐ to SEND are assumed to have instead │HS/Link does NOT modify │ been RECEIVED by the protocol. The │BBS upload listings! │ BBS should then check for the │The BBS program must │ existence of such files and if │detect uploads and do │ found, ask for descriptions and │it's own file management.│ post them in the upload directory. └─────────────────────────┘ If the BBS program is not yet able to cope with bidirectional uploads, the -NU ┌──────────────────────┐ option can be used on the 'download' │Use -NU to block all │ command line to prevent attempts to │bidirectional uploads.│ perform a bidirectional upload. └──────────────────────┘ HS/Link 1.1 User Documentation - 23 - Flow Control _________________________________________________________________ Flow Control is required when the sending and receiving computers or modems operate at different speeds, or when computers are unable to simultaneously access disk drives and the COM port. Flow Control is a software and/or hardware means of slowing down the faster parts of the connection to prevent overloading the slower parts of the system. HS/Link uses both XON/XOFF (software) and RTS/CTS (hardware) handshake when communicating with high speed modems or slow packet switched networks. The protocol also uses a window algorithm to suspend data transmission if the receiver does not eventually respond to transmitted data. XON/XOFF handshake is a software handshake scheme that should work well on all combinations of modems and networks, and is enabled by default. If you prefer not to use XON/XOFF handshake, or you find that it is not required for error-free transfer, you can disable it with the -HX option. Note that both the sender and the receiver must simultaneously disable XON/XOFF handshake, otherwise it will remain in effect. The slow handshake option (-HS) is available for systems with slow disk access. Use this if you get frequent CRC errors or COM Overrun errors on otherwise clean lines. The slow handshake option causes XOFF to be sent and/or RTS to be lowered during any disk activity. Even when -HS is active, the ┌───────────────────────────┐ HS/Link protocol should transfer data │The -HS option stops most │ very nearly as fast as the slowest part │Overrun and CRC errors that│ of the link allows. │occur during or immediately│ │after disk I/O takes place.│ CTS transmitter handshake is └───────────────────────────┘ automatically enabled, but may conflict with some unusual modem cables or serial ports. If the CTS signal is not active when HSLINK loads, it will automatically disable CTS handshake for you. Use the -HC command to manually disable CTS handshake. RTS receiver handshake is used when the slow-handshake option is selected. This form of handshake causes the RTS line to the modem to be lowered whenever the disk is being accessed. Some unusual modem or cable arrangements may not tolerate the RTS line being lowered. In this case, the RTS handshake can be disabled with the -HR option. If you have frequent CRC errors or COM Overrun errors, which persist in spite of the handshake-slow option (-HS), you should consider upgrading your serial port from the usual 8250 to a newer, buffered NS16550AN chip. The buffered chips are highly recommended if you are operating at high baud rates (>9600) or are accessing extended memory or are multi-tasking. HS/Link 1.1 User Documentation - 24 - I have also had reports that use of large numbers of dos BUFFERS in CONFIG.SYS can cause overrun errors. Try reducing the BUFFERS setting to 10 or less, especially if you also use a DISK cache. Some disk cache programs have also been reported to cause overrun errors. Try turning the cache OFF before calling HSLINK, and turning it back ON again after the transfer is completed. Buffered ASYNC chips _________________________________________________________________ The National NS16550AN is a pin compatible plug in replacement for 8250 and 16450 serial chips. It contains hardware buffering to allow faster operation in systems with high interrupt service latency. If you have an NS16550AN buffered UART chip, HS/Link will automatically enable ┌───────────────────────────┐ buffering for better performance with │The NS16550AN chip stops │ high speed modems and multi-tasking │most Overrun and CRC errors│ environments. │encountered with COM port │ │opening speeds of 9600 and │ The -N5 option may be needed with some │higher. │ early versions, or incorrect clone └───────────────────────────┘ versions of the NS16550 chip, which do not properly perform buffering. HS/Link 1.1 User Documentation - 25 - Full Streaming Data Transmission _________________________________________________________________ The HS/Link protocol allows multiple data blocks to be transmitted before an acknowledgement is required by use of block numbers combined with a window algorithm. The protocol also allows acknowledgements to be combined with data flowing in the opposite direction, making it possible to achieve full streaming simultaneously in both directions over a full duplex communication link. Even though the transmitters operate in full streaming mode, the receivers normally will periodically acknowledge that data is being received. This acknowledgement can be disabled with the -A option. Recent advances in high speed modem technology have made it possible to simultaneously transfer data at high ┌───────────────────────────┐ speeds in both directions. This │The HST modem is not well │ standardized technology is called "V.32" │suited for bidirectional │ or "V.32bis", and are available in many │transfers. Switch to V.32 │ new modems. The bidirectional │modes, if available, for │ capabilities of HS/Link take full │higher thru-put. │ advantage of these modems, cutting └───────────────────────────┘ online time as much as 50% when equal amounts of data are transmitted and received. Some older high speed modems, such as the HST and Hayes-V, do not implement V.32 and are able to transfer quickly in only one direction, while the other direction is relatively slow. HS/Link will still perform well as a single direction protocol with these modems, but bidirectional thruput will be low due to the "ping pong" effect of the modem switching the ┌────────────────────────┐ high speed channel back and forth. │The "Ping Pong" effect │ │slows bidirectional │ │transfers on older 9600 │ │baud modems. │ └────────────────────────┘ HS/Link 1.1 User Documentation - 26 - Full Streaming Error Recovery _________________________________________________________________ The HS/Link protocol has the unique ability to recover from many transmission errors without breaking out of full streaming mode. This is important with buffered modems or packet switched networks with long turnaround times. Conventional protocols, such as Zmodem, simply reposition the transmitter after an error, requiring a retransmission of not only the erroneous data, but also the entire stream of data that was in transit at the time the error was detected. The HS protocol can correct bad blocks without retransmitting intermixed good ┌───────────────────────────┐ blocks, resulting in excellent transfer │Full-Streaming-Error- │ speeds under moderate line noise │Correction cannot stop flow│ conditions. │control failure-related │ │errors. See the section │ │on Flow Control if you have│ │persistent errors. │ └───────────────────────────┘ HS/Link 1.1 User Documentation - 27 - Dynamic Code Substitution _________________________________________________________________ Certain byte codes cannot be transmitted directly over the COM link. For instance, the codes for Control-X, Control-S and Control-Q must be "escaped" to prevent a conflict with flow or program control. The HS/Link protocol uses a new Dynamic Code Substitution system to drastically reduce number protocol overhead and "escape" codes needed to transmit certain data streams. Highly compressed data files (such as ZIP and GIF files) benefit the most, since they often have many byte codes that cannot be transmitted directly over the COM link. The Dynamic Code Substitution feature can be disabled, if you wish, with the -NC option. Transmission of Minimal Blocks _________________________________________________________________ The HS/Link protocol includes a Minimal Blocks feature, which when activated, ┌───────────────────────────┐ causes the protocol to strip away │Enable Minimal-Blocks with │ repeated information from the protocol │the -NM option only if you │ frames and transmit only the minimal │are operating with an error│ amount of information required for data │free link. │ flow. └───────────────────────────┘ This feature results in a savings of over 50% of the normal protocol overhead characters in each block of data, while retaining full data integrity. All data and control blocks are fully protected by a 32 bit CRC calculation, even when Minimal Blocks is in effect. The final block in a file rarely ends on an exact transfer block boundary. The HS/Link protocol automatically shortens the final block, eliminating extraneous data transmission at the end of file. HS/Link 1.1 User Documentation - 28 - DSZLOG Statistic Logging _________________________________________________________________ When you define the environment variable DSZLOG, the HSLINK program will enable transfer logging to the specified filename. The log file can also be set with the -FL option. For example, the AUTOEXEC statement: SET DSZLOG=C:\LOGS\LOG.OUT will cause HSLINK to log files transmitted to C:\LOGS\LOG.OUT. This form of logging provides compatibility with programs that are designed to operate with DSZ or other DSZLOG-type protocols. The log file consists of a single line of text for each file transferred. Here are some sample log entries: h 227596 10100 bps 1138 cps 0 errors 112 2316 V:\UPLOAD\ZLABP_13.ZIP 0 H 177901 10100 bps 1116 cps 1 errors 0 749 U:\PLAY1\ECOMM22.ZIP 0 h 16155 10100 bps 1061 cps 0 errors 4 795 W:\ULW\WINROACH.ZIP 0 L 136991 10100 bps 0 cps 0 errors 55 1823 W:\ULW\WINDE223.ZIP 11 E 152614 10100 bps 0 cps 14 errors 22 38 W:\ULW\CLPGR21C.ZIP 0 2 Each line contains the following fields: Size Description ---- ------------------------------------------- 1 'H'=file received from remote 'h'=file sent to remote 'E'=file receive was aborted 'e'=file transmit was aborted 'L'=lost carrier during file receive 'l'=lost carrier during file transmit 7 The length of the file, in bytes. If the transfer was aborted, this field will contain the number of bytes transferred before the transfer was aborted. 6 The effective modem-to-modem connect speed. 4 Literally ' bps' 5 The average transfer rate, in characters per second. 4 Literally ' cps' 4 The total number of blocks which required retransmission during the transfer. 7 Literally ' errors' 6 The number of flow control restrictions. 5 The length of the last block transferred in the file. ? The full pathname of the file which was transferred. ? The Serial Number of the remote HSLINK, if registered. Otherwise 0. HS/Link 1.1 User Documentation - 29 - Network Compatibility _________________________________________________________________ All file processing is fully network and "share" compatible. HSLINK can be ┌────────────────────────┐ easily installed in multi-user or │HS/Link automatically │ networked computers. This works with │enables file sharing in │ DOS version 3.0 and later. │network environments. │ └────────────────────────┘ When transmitting a file, the file is opened in "allow read, deny none" mode. When receiving a file, the newly created file is created in "allow read, allow write, deny all" mode, which prevents other programs from altering the file which is being created. If a file sharing violation is detected when opening a file, the program passes control to the system's current "critical error" handler. To automate recovery from file sharing violations, you should consider installing my FATAL14.ZIP program, which will automatically retry after sharing violations, and which will keep a detailed log of all critical errors in a system since the time the program was loaded into memory. All files transmitted or received with HS/Link retain their original exact size and time/date stamp. No extraneous data is added beyond EOF as with some older protocols. The current date/time will be stamped on incoming files if the -NT option is used. Otherwise, the original file's time/date stamp will be retained. When run under DOS 2.x, HSLINK automatically reverts to non-share file modes. HS/Link 1.1 User Documentation - 30 - Auto Downloading _________________________________________________________________ It is possible for some terminal programs to support HS/Link auto ┌───────────────────────────┐ downloading by means of "scripts" which │With HS/Link Auto-Download │ wait for the HS/Link "ready" packet, and │You don't have to hit any │ then shell out to the HSLINK receiver │additional keys to execute │ protocol. │the HSLINK driver. │ └───────────────────────────┘ This capability is currently active when HS/Link is installed in {COMMO} and BOYAN 5.0, any may be available soon under many other terminal programs as the respective authors add the capability to recognize external protocol signon signatures. The HS/Link "ready" packet is repeated at 10 second intervals when waiting for the HSLINK receiver to be started. The format of the "ready" packet is: "HS*" ^B "R" or in hex, 0x02 0x52 When this sequence of characters is received during a terminal session, the HSLINK protocol should be executed. The HSLINK program sends a different "ready" packet when no files need to be sent, but upload files are expected from the remote system. This "ready" packet signature can be used to implement HS/Link Automatic Upload. The format of the "upload ready" packet is: "HS*" ^B "Q" or in hex, 0x02 0x51 When this sequence of characters is received during a terminal session, an HS/Link upload should be started. The three character prefix "HS*" was added with version 1.1 and is needed only if the shorter 2 character signatures are being used for another purpose. HS/Link 1.1 User Documentation - 31 - Error Messages _________________________________________________________________ Bad ____ CRC These messages indicate that an error was detected in a control message between the sender and the receiver. All control packets are protected by a 32 bit CRC calculation to provide highly secure and reliable communication. If you repeatedly receive the "Bad ready packet CRC" message, it may indicate that the internal protocol formats have been changed and that you need to upgrade to a newer beta copy of HSLINK. Bad data CRC (#) Dropped bytes -# (#) Noise burst # (#) These messages indicate that an error was detected in a block of data in the file being received. "Dropped bytes" indicates that some expected bytes did not arrive, and "Noise burst" indicates that more bytes than expected arrived. Error correction is automatic, because of Full-Streaming-Error-Correction, may occur without breaking the stream of data being received. If this message occurs at regular intervals, it is a sign of flow control failure. In most cases, this can be corrected with the addition of the -HS command line option. COM#: Break! COM#: Framing! COM#: Overrun! COM#: Parity! These messages indicate that an error was detected in the serial port receiver. Framing and Parity errors often indicate a baud rate mismatch. Overrun errors usually indicate the need for flow control or for an upgrade to a buffered serial chip. Overrun errors can often be reduced or eliminated with the use of the -HS command line option. Can't create file '___' This indicates that the received file could not be created. This usually indicates that the directory specified in the -U command line option is invalid, or that the disk is full. Carrier lost! This indicates that Carrier detect was dropped, aborting the HSLINK session. If your connection does not provide a carrier detect signal, you can disable this check with the -C command line option. This is often required when directly connecting two computers by means of a "null modem" cable. Control-X abort! This indicates that the control-x character was received twice in succession, either over the COM port or from the local keyboard. HS/Link 1.1 User Documentation - 32 - Disk write failure! (#) This usually indicates that the disk is full and that further downloads cannot be received. Flow control released (#### t:# r:#) If output flow has been suspended by either software or hardware flow control for more than 15 seconds, the program will assume that there has been a failure of flow control and will release the hold so data can continue. The codes in parenthesis indicate which flow controls were active at the time (C=CTS was down, T=transmitter XOFF was pending, R=receiver XOFF was pending, A=transmitter is currently active) and the counts of bytes in the transmit and receive holding queues. FILE was incomplete! (# #) This message indicates that the transfer was aborted in some way before the specified file was completely received. Normally incomplete files are erased from disk, but they will be retained of the -K command line option is used. Not allowed to overwrite existing file '___' This indicates that a file was received but there was another file with the same name already in the download file directory. Either erase the duplicate file, or use the -O option to allow existing files to be overwritten. Insufficient memory to load program. Not enough memory! There was not enough memory available to run HSLINK. Free additional memory by removing "TSR" software, device drivers, ramdisks or disk caches. If your COMM program has the option of swapping to DISK or EMS, enable the option to free additional memory for HSLINK's use. Current beta copies of HSLINK require about 64k of RAM, but the specific amount of memory required is subject to change from beta to beta. You can reduce the amount of memory required if you use the -NB command line option to disable file buffering. Read failure at # This indicates that there was a disk error reading a file being transmitted. Remote not responding! This indicates that the remote computer did not execute HSLINK and establish a connection within the two minute timeout period. HS/Link 1.1 User Documentation - 33 - Information Messages _________________________________________________________________ Receive timeout (#) ACK timeout, resend # This message indicates that it has been too long since the receiver responded to data transmission. The last data block is repeated in an attempt to wake up the receiver. Block size: # This message indicates the actual block size being used for file transfers. The block size is controlled by the -W parameter, and may be overridden by the remote computer if the remote uses the -! (take priority) option. COM#: # bps This message indicates the actual COM port speed in use, either as specified with the -B command line option, or as determined from the current hardware settings. HS/Link finished! (t:# r:#) Exit code = # When HSLINK terminates, it sets the dos ERRORLEVEL to the specified value. This can be checked in batch files to detect error conditions. Under normal conditions, HSLINK exits with an ERRORLEVEL of 0. If, however, the session terminated due to errors, or was aborted by the operator, the ERRORLEVEL will be non-0. The following ERRORLEVEL codes are possible: ERRORLEVEL Reason for link termination ---------- ---------------------------------------- 0 One or more files transferred successfully 1 ^X typed at local keyboard 2 ^X received over COM port 3 Incompatible BETA versions 4 No files transmitted or received 5 Remote did not respond within 2 minutes 6 Too many framing errors, possible -B mismatch 7 Possible tampering or corruption in HSLINK.EXE 8 Possible tampering or corruption in HSLINK.EXE 9 COM port not responding, incorrect -P options 10 Carrier lost during initial handshake with remote 11 Link aborted due to CTS lockup COMM and BBS programs should use the DSZLOG output file to determine more specific details of transfer results. The (t:# r:#) display indicates the number of files successfully transmitted and received. HS/Link 1.1 User Documentation - 34 - File received OK, # cps, # seconds. The file was received correctly and is now closed. The average transfer speed is calculated based on the elapsed time between receiving the file open packet and the last byte of the file. Transfer speeds are calculated using the DOS timer tick, which is not accurate for transfers taking less than 1 second to complete. For very short transfers, a cps rating of 9999 will be returned. File sent OK, # cps, # seconds. The file was transmitted correctly and is now closed. The average transfer speed is calculated based on the elapsed time between sending the first byte of the file and the last byte of the file. Transfer speeds are calculated using the DOS timer tick, which is not accurate for transfers taking less than 1 second to complete. For very short transfers, a cps rating of 9999 will be returned. File skipped! The transmitter prints this message when the receiver requests the current file be skipped. This usually happens when the receiver detects a duplicate filename and is not allowed to overwrite existing files. Handshake: CTS XON/XOFF SLOW This message indicates the current combination of flow control options that are in effect. CTS indicates CTS hardware flow control is active. XON/XOFF indicates that XON/XOFF software flow control is active. SLOW indicates that flow will be restrained during disk I/O to prevent overrun errors. Out of sequence # (#) This indicates that the received block was out of sequence, indicating that a block was possibly missed or lost during transmission. The receiver will request the transmitter to retransmit the missing block(s). Received block # (# bytes) # cps This displays the current status of the file being received. The current number of blocks and bytes received is displayed after each block is received. The estimated transfer speed in ch/sec is also displayed. Received block # (# bytes) E# When "E#" is displayed following the received block # message, it indicates that error recovery is in progress, and that the specified block number was in error and is in transit from the transmitter. When the erroneous block has been received correctly the E# display will advance to the next erroneous block number, or will be erased if no more erroneous blocks are pending. Received block # (# bytes) R When "R" is displayed following the received block # message, it indicates that current block has been previously received correctly and is therefore a "repeat" block. Repeat blocks occur under severe error conditions and are usually corrected automatically. HS/Link 1.1 User Documentation - 35 - Receiving file: ___ (# blocks, # bytes) This message indicates that a new file is being received from the transmitter. The file size is displayed in blocks and bytes. Resending block # This message indicates that the receiver has detected an erroneous block and is requesting a retransmission to correct the data. Data flow continues where it left off prior to the resend, allowing error recovery to take place without breaking out of full streaming mode and without discarding data that is already in transit to the receiver. This is the basis of Full- Streaming-Error-Correction. Restarting current file This indicates that the receiver was unable to recover from errors encountered in processing the current file being transmitted, and has requested that the file be started again from scratch. Seek from block # to # Under the most severe error conditions, the receiver may request the transmitter to discard data that is in transit to the receiver and to rewind to an earlier position in the file and resume transmission. Sending block # (# bytes/w:#) # cps This is the normal status display while a file is being transmitted. The message indicates the latest block number to be transmitted, and in parenthesis indicates the number of bytes transmitted and the current number of blocks that have been transmitted without acknowledgement, which represents the size of the transmit "window" that is currently in use. If this value hangs at the current -W setting, you may benefit from a higher -W setting on the command line. The estimated transfer speed is also reported in ch/sec. Sending file: ___ (# blocks, # bytes) This message indicates that a new file is being transmitted to the receiver. The file size is displayed in blocks and bytes. Transfer aborted! This message indicates that the current file transfer has been aborted for some reason. The specific reason for the transfer abort is usually also printed on the screen. Waiting for remote. This message indicates that HSLINK is waiting to handshake with the remote computer. HSLINK will wait for 60 seconds for the other computer to come online; after that the transfer is aborted. Warning: CTS signal missing! -HC will be assumed. The CTS hardware handshake is normally enabled by default. If, on initial loading, HSLINK finds that the CTS signal is down, it assumes that the current hardware configuration is not using CTS handshake and automatically disables further CTS handshake checks. Use the -HC command line to manually disable CTS handshake. HS/Link 1.1 User Documentation - 36 - Window: # This indicates the actual number of blocks that are allowed to be in transit without acknowledgement. This is controlled by the -W parameter, and may be overridden by the remote computer if the remote uses the -! (take priority) option. Window: NONE This indicates that the -A command line option has been specified, and that the transmitter is required to continue indefinitely without receiving any kind of acknowledgement from the receiver that data is being received correctly. HS/Link 1.1 User Documentation - 37 - License and Registration _________________________________________________________________ This program is not free! You are hereby licensed to use this program for a trial period of 30 days free of charge. If, after 30 days, you decide that you would like to continue using HSLINK, you must complete the registration form (REGISTER.FRM) and return it to the author with the required registration fee enclosed. Registration removes the "UNREGISTERED" messages as well as all time delays. Your registration number will be broadcast to the remote copy of hslink. Basic HSLINK registration costs $20 US, which includes a registration certificate showing a Serial Number and Password. For $30 US, a disk containing the latest release of HSLINK, along with a registration certificate can be obtained. Printed and bound operation manuals are also available for $15 each. Each registration is valid for use on a single CPU or on a single BBS system (multi-node systems require only a single registration). Please feel free to distribute unregistered HSLINK to your friends and local BBSes as long as all of the files in this archive are included and unmodified. Send your registration payment to: SAMUEL H. SMITH P. O. BOX 4808 PANORAMA CITY, CA 91412-4808 U.S.A. HS/Link registration can also be ordered ON LINE by credit card through any of the Tool Shop BBS phone lines. LICENSE AGREEMENT FOR SHAREWARE DISTRIBUTORS Shareware distributors may distribute this program as long as the author has been notified, in writing, prior to ANY distribution. The "per disk" charge may not exceed $6 and the shareware distributor will not change the above license fee for the end user of HSLINK. End users are not exempt from registering HSLINK with the author at the normal registration fee. HS/Link 1.1 User Documentation - 38 - Support _________________________________________________________________ HS/Link was Written by Samuel H. Smith. Contact me at: The Tool Shop BBS Phone number Modem type -------------- -------------------------------------------- (818) 891-6780 US Robotics 2400 (free line) (818) 891-3772 US Robotics HST 9600 ($20/yr subscription) (818) 891-1344 Supra v.32bis/v.42bis ($20/yr subscription) You will always find the latest release version of HS/Link on the Tool Shop, as well as a variety of support files and programs. HS/Link is also supported by a number of authorized distributors throughout the world. Please refer to DISTRIB.DOC for the latest distributor list. The HS/Link Support Conference is carried by UN'I-Net/US, SmartNet, RIME and possibly a number of other echo networks. You can get direct product support through a local BBS that carries this echo conference. DISCLAIMER IN NO EVENT WILL I BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY. HS/Link 1.1 User Documentation - 39 - Distributors _________________________________________________________________ The following individuals are valid distributors as of 04/23/92. UNITED STATES William G. Poissant AMCOM 5530 State Road Cleveland, Ohio 44134-2260 (216) 398-1331 (voice) (216) 398-1330 (fax) (216) 526-9480 AMCOM BBS 2400 baud (8 lines) (216) 526-9490 AMCOM BBS HST 14,400 v.32/V,32bis (3 lines) (216) 526-9096 AMCOM BBS HST/DS 14,400 v32/v32bis/v42/v42bis UNITED STATES Gene De Libero East Coast MIDI(tm) Information Systems 21 September Street, Coram, New York 11727 (516) 928-4284 (voice) (800) 736-0181 (voice - HS/Link orders ONLY!) (516) 928-4986 BBS HST 14,400/v42bis (multi-node) CANADA Daniel Coulombe Synapse BBS 22 Beloeil, Gatineau, Quebec J8T 7G3 (819) 561-1697 (VOICE) (819) 561-4321 (v.32) (819) 243-0306 (Hayes) (819) 561-0950 (HST) EUROPE - Netherlands Arthur A. Mol The Owl's Nest PO Box 227 3760 AE Soest Netherlands +31-2155-26527 (FAX) +31-2155-12571 (BBS up to 14.4Kb HST/V32) +31-2155-26527 (BBS node 2 shared w/fax) HS/Link 1.1 User Documentation - 40 - EUROPE - Germany Frank Maroke BMS-Online / BMS-Systems GmbH Waldstrasse 5-7 D(W)-6050 Offenbach/M. FRG/Germany ++49-69-881121 (BBS HST/DS) ++49-69-885042 (Voice) EUROPE - Switzerland Ernesto Guerber PRO - DOS Lenggenbachstr. 1 8951 Fahrweid Switzerland +748-27-75 (BBS HST/DS) +748-33-32 (Voice) +748-27-75 (FAX) SOUTH AMERICA Horacio Stolovitzky SatLink Communications Casilla de Correo 3618 (1000) Correo Central Buenos Aires - ARGENTINA For SOUTH AMERICA (Argentina, Chile, Brazil, Uruguay, Paraguay, Bolivia, Peru, Ecuador, Colombia and Venezuela) +54-1-52-1057 (BBS) +54-1-983-6740 (Voice) INTERNET: hslink@satlink.org.ar SINGAPORE Anthony Chin Artist On-Line Information System Blk 458, Ang Mo Kio, Avenue 10, #14-1584 Singapore 2056 Republic of Singapore +65-456-1100 (BBS HST/DS v.32bis) AUSTRALIA Peter Deegan My Computer Company BBS P.O. Box 99, Erskineville, NSW 2043 Australia +61-2-565-1044 (BBS, v.32) +61-2-550-4459 (FAX) +61-2-565-1991 (Voice) If you experience any problems with a particular distributor, please contact me immediately so that we can get it resolved quickly. HS/Link 1.1 User Documentation - 41 - Index _________________________________________________________________ Aborting a transfer . . . . 6 -B . . . . . . . . . . 10 Auto-download . . . . . . . 31 -Bbaud . . . . . . . . 14 Auto-Upload . . . . . . . . 31 -C . . . . . . . . 10, 14 Basic settings . . . . . . 9 -CB . . . . . . . . . 13 Configuration files -CBcolor . . . . . . . 14 HSCONFIG . . . . . . . 7 -CG . . . . . . . . . 13 specifying alternate -CGcolor . . . . . . . 14 configuration -CM . . . . . . . . . 13 files . . . . . . 7 -CMcolor . . . . . . . 14 Context sensitive help . . 9 -CT . . . . . . . . . 13 Crash recovery -CTcolor . . . . . . . 14 -K . . . . . . . . . . 11 -CW . . . . . . . . . 13 -O . . . . . . . . . . 11 -CWcolor . . . . . . . 14 -R . . . . . . . . 11, 19 -E . . . . . . . . . . 10 DesqView -Ebaud . . . . . . . . 15 -I . . . . . . . . . . 12 -FC . . . . . . . 12, 15 -I2 . . . . . . . . . 16 -FL . . . . . . . . . 12 -NV . . . . . . . . . 17 -HC . . . . . . . 10, 15 Display bleeding . . . . . 5 -HR . . . . . . . 10, 15 Display colors . . . . . . 13 -HS . . . . . . 6, 9, 15 Distributors . . . . . . . 40 -HX . . . . . . . 10, 15 DoubleDOS -I . . . . . . . . . . 12 -I3 . . . . . . . . . 16 -Iidle . . . . . . . . 16 -NV . . . . . . . . . 17 -K . . . . . . . . 11, 16 DSZLOG . . . . . . . . . . 29 -LFlogfile . . . . . . 16 ERRORLEVEL . . . . . . . . 34 -N5 . . . . . . . 12, 16 Errors -NB . . . . . . . 11, 16 -HS . . . . . . . . . 6 -NC . . . . . . . 11, 16 COM Overrun . . . 15, 24 -NF . . . . . 5, 13, 16 Error messages . . . . 32 -NM . . . . . . . 12, 17 Exit codes . . . . . . . . 34 -NO . . . . . . . . . 12 File buffering . . . . . . 11 -NOdirlist . . . . . . 17 File sharing . . . . . . . 30 -NT . . . . . . . 10, 17 Flow control . . . . . . . 24 -NU . . . . . . . . . 17 -HC . . . . . . . . . 10 -NV . . . . . 5, 13, 17 -HR . . . . . . . . . 10 -O . . . . . . . . 11, 17 -HS . . . . . . . . . 6 -P . . . . . . . . . . 9 -HX . . . . . . . . . 10 -PBbase . . . . . . . 18 HSCONFIG . . . . . . . . . 7 -PI . . . . . . . . . 10 HST . . . . . . . . . . . . 26 -PIirq . . . . . . . . 18 Installation -Pport . . . . . . 6, 17 In BBS programs . . . 22 -R . . . . . . . . 11, 19 In COMM programs . . . 21 -S . . . . . . . . . . 11 Non-standard COM ports 10, 18 -Ssize . . . . . . . . 19 NS16550AN . . . . . . . . . 25 -U . . . . . . . . . . 9 Options . . . . . . . . . . 10 -Udir . . . . . . 6, 19 -! . . . . . . . . 11, 14 -W . . . . . . . . . . 11 -@ . . . . . . . . . . 7 -Wwindow . . . . . . . 19 -@fname . . . . . . . 14 PC-Pursuit -A . . . . . . . . 11, 14 -W . . . . . . . . . . 19 HS/Link 1.1 User Documentation - 42 - Example . . . . . . . 20 Registration . . . . . 38, 40 Support . . . . . . . . . . 39 V.32 . . . . . . . . . . . 26 Zmodem . . . . . . . . . . 27 HS/Link 1.1 User Documentation - 43 -