home *** CD-ROM | disk | FTP | other *** search
/ Mega CD-ROM 1 / megacd_rom_1.zip / megacd_rom_1 / HANDICAP / ROCK114.ZIP / ROCKCOMM.DOC < prev    next >
Text File  |  1991-05-22  |  12KB  |  284 lines
  1. RockComm 1.14 Reference Guide
  2.  
  3. * Summary
  4.  
  5.   A telecommunications program from Rock.  Features dialing directory, macro
  6.   keys, 5 built-in protocols, capability to add external protocols, log file,
  7.   dos shell, screen snapshot, built-in help, and easy user interface.
  8.  
  9.   NOTE: RockComm is not part of the set of Rock Utilities.  The Rock Utilities
  10.   are a set of shareware programs written by the same company.
  11.  
  12.  
  13. * Contents
  14.  
  15.   This file contains the following sections:
  16.  
  17.        Summary
  18.        Contents
  19.        Introduction
  20.        Help Command
  21.        Dialing Directory
  22.        Setup String
  23.        Hangup
  24.        Terminal Emulation
  25.        Transfer Protocols
  26.        External Transfer Protocol
  27.        Buffer Size
  28.        Known Bugs
  29.        Planned Enhancements
  30.        About the Author
  31.        Credits
  32.  
  33.   Note that all section names are preceded by an asterisk, to make it easier
  34.   to find them using file search commands.
  35.  
  36.  
  37. * Introduction
  38.  
  39.   Rockcomm is a basic telecommunications program, providing a dialing
  40.   directory, macro keys, 5 built-in protocols, capability to add external
  41.   protocols, log file, dos shell, screen snapshot, built-in help, and easy
  42.   user interface.  Version 1.14 is released to the public domain, meaning it
  43.   can be used without charge and may be copied and distributed freely.
  44.  
  45.   The original reason RockComm was written was to provide a telecommunications
  46.   program that is more easily accessible to people with visual impairments
  47.   than most of the existing communications packages.  This is accomplished by
  48.   sending all screen output through standard "BIOS" calls, which can be
  49.   intercepted by other programs, such as speech synthesizers.  There are no
  50.   fancy windows, status lines, dialog boxes, pop-up warnings or pull-down
  51.   menus.  These visually appealing screen techniques can make access more
  52.   difficult if the screen cannot be seen.
  53.  
  54.   This no-windows, no-menu interface also appeals to some non-sight-impaired
  55.   users, who don't want the glitz and "automation" of fancier communications
  56.   programs.  For example, it's nice to be able to shell to DOS right after the
  57.   modem dials a number, as it typically won't connect to another modem for 20
  58.   or 30 seconds.  RockComm isn't for everyone, but it appeals to some people,
  59.   novices and pros alike, and if you use communications programs a lot, it's
  60.   worth checking out.
  61.         
  62.  
  63. * Help Command
  64.  
  65.   Help may be obtained in RockComm by pressing the F1 key.  Note that this
  66.   does not work if you are already in the middle of another RockComm function,
  67.   such as updating a directory entry.
  68.  
  69.   The commands displayed by the help command are as follows:
  70.  
  71.  
  72.     Alt-I for program information.
  73.     Alt-D to dial.
  74.     Alt-U to update the dialing directory.
  75.     Alt-P to modify communications parameters.
  76.  
  77.     Page Down to download (receive) file.
  78.     Page Up to upload (send) file.
  79.     Alt-F to display the current DOS directory.
  80.     Alt-F7 to change the current DOS directory.
  81.  
  82.     Alt-F1 to toggle log file.
  83.     Alt-G for screen snapshot.
  84.     Alt-V to view a file.
  85.     Alt-Z     to toggle the full-screen help window.
  86.  
  87.     Alt-F4 for DOS shell
  88.     Alt-X to exit.
  89.  
  90.     Alt-M for macro menu
  91.     Alt-0 to Alt-9 for key macros
  92.  
  93.     Alt-N pause until next key pressed
  94.     Alt-C clear screen
  95.     Alt-E toggle duplex
  96.     Alt-T give time elapsed
  97.     Alt-F2 to pause the log file
  98.  
  99.  
  100. * Dialing Directory
  101.  
  102.   The dialing directory is compatible with the format used by Procomm Plus, a
  103.   commercial program written by Datastorm Technologies, Inc. (Copyright
  104.   1987-1988.  To use their directory, simply rename "PCPLUS.DIR" as
  105.   "ROCKCOMM.DIR".  The dialing directory file must be called "rockcomm.dir",
  106.   and be present in the directory from which RockComm is started.  When
  107.   RockComm is started, it reads the entire directory into memory, and doesn't
  108.   access the file again unless you update the directory.
  109.  
  110.   To change dialing directory entries, press Alt-U.  You will be asked which
  111.   directory entry you wish to update, or if you'd like a list of the entire
  112.   directory first.  You'll then be asked for each option, including the entry
  113.   name, phone number, baud rate, and other modem parameters.
  114.  
  115.  
  116. * Setup String
  117.  
  118.   When RockComm is started, a "modem initialization string" is automatically
  119.   sent to the modem.  The string used is as follows:
  120.  
  121.        ATE1 S7=255 S11=55 V1 M1 L1 X1 S0=0
  122.  
  123.   This will be a user-settable parameter in a future release of RockComm, but
  124.   should satisfy the basic initialization needs of Hayes-compatible modems.
  125.   You can manually type any "AT" commands to the modem yourself, for example
  126.   "ATM0" if you wish to silence the modem speaker even while dialing.
  127.  
  128.  
  129. * Hangup
  130.  
  131.   When you choose the hangup function, RockComm waits a second, sends the
  132.   string "+++", waits two and a half more seconds, sends the string "ATH0",
  133.   then waits another half second.  While not fool-proof, this technique hangs
  134.   up the phone with most Hayes-compatible modems.
  135.  
  136.  
  137. * Terminal Emulation
  138.  
  139.   RockComm acts as a "dumb" terminal with few terminal emulation capabilities.
  140.   Some computer systems transmit special characters to control screen
  141.   functions, for example to clear the screen, place the cursor at a particular
  142.   position on the screen, or change the color of the incoming text.  The most
  143.   common terminal emulation standard is called "VT100".  RockComm does not
  144.   support this standard.  If special VT100 characters are recieved, they are
  145.   output as normal ASCII characters, rather than interpreted as special screen
  146.   control characters.
  147.  
  148.   Note that this is not strictly true if you are using a "resident" program,
  149.   such as ANSI.SYS included with DOS, which intercepts normal output.  ANSI,
  150.   for example, understands some VT100 codes, so you may achieve some degree of
  151.   VT100 emulation by including the command "DEVICE=ANSI.SYS" in your
  152.   CONFIG.SYS file.
  153.  
  154.  
  155. * Transfer Protocol
  156.  
  157.   RockComm currently offers 5 built-in file transfer protocols: ASCII,
  158.   X-Modem, X-Modem CRC, 1K X-Modem, and Compuserve B/B+.  You are prompted for
  159.   which protocol to use each time you upload or download a file (initiated by
  160.   pressing Page-Up and Page-Down, respectively).
  161.  
  162.   CompuServe B/B+ is automatically initiated when an ASCII 5 (Enquiry code) is
  163.   received.  A future feature will be added to allow you to disable this
  164.   automation.  1K X-Modem is the fastest of the X-Modem variants.
  165.  
  166.  
  167. * External Transfer Protocols
  168.  
  169.   Additionally, Rockcomm offers the ability to use one external protocol. To
  170.   use this, you must create two batch files, called upload.bat and
  171.   download.bat, that call your external protocol program.  Rockcomm will
  172.   search for these files when it begins running.  If it finds them, then when
  173.   you choose your protocol for uploads or downloads, option 6 will be
  174.   "External".  Choosing it will cause Rockcomm to execute the upload.bat or
  175.   download.bat file that you created.
  176.  
  177.   Note that Rockcomm also sends parameters to these batch files.  For
  178.   downloads, it sends the current baud rate and the port being used as
  179.   parameters.  For uploads, it sends the baud rate, port, and file name to
  180.   uploads.  For downloads, your external protocol should be able to
  181.   automatically detect the names of files being downloaded.
  182.  
  183.   As an example of how Rockcomm would call your download.bat file, it would be
  184.   equivalent to shelling to DOS and typing "download 2400 2", if you were
  185.   connected at 2400 baud, using COM2:.  An example download.bat and upload.bat
  186.   file are included with Rockcomm, and both work with the "DSZ" program, a
  187.   shareware Z-Modem protocol produced by another company. DSZ is available
  188.   from many sources, including Rock's support BBS.
  189.  
  190.  
  191. * Hardware Requirements
  192.  
  193.   RockComm assumes that you are using a Hayes-compatible modem, meaning it
  194.   understands the Hayes "AT" command set.  These commands are embedded in
  195.   commands such as the dialing directory and cannot currently be changed.
  196.  
  197.   Serial ports COM1: through COM4: should all work.  The default port is
  198.   COM2:, and to use COM1:, type "rockcomm 1", or whatever the port, to start
  199.   the program.
  200.  
  201.  
  202. * Buffer Size
  203.  
  204.   Buffer size is limited to 32 K-bytes.  This is how many characters RockComm
  205.   can hold in its memory without displaying them to the screen.  Normally it
  206.   displays them as it recieves them, but if you are executing a RockComm
  207.   function, they aren't displayed until you are done.  However, if more than
  208.   32,000 characters pass by the screen, the initial ones will be "lost".
  209.   32,000 is a pretty large amount of text, but if you want to make sure you
  210.   don't miss any characters, just don't execute lengthy RockComm commands
  211.   unless the incoming text is paused, for example at a menu prompt.
  212.  
  213.   Another possible source of buffer "overflows" is if an output device such as
  214.   a printer or speech synthesizer handles characters at a much slower rate
  215.   than characters are coming in to the buffer.  Many printers and synthesizer
  216.   packages have their own memory buffer to prevent this from being a problem.
  217.  
  218.   If the buffer limit poses a problem for you, let us know, and we'll try to
  219.   incorporate an adjustable buffer in the next version.
  220.  
  221.  
  222. * Known Bugs and Limitations
  223.  
  224.   1.  RockComm can "lose characters" when the incoming 16K buffer is
  225.       overflowed (see "Buffer Size").
  226.  
  227.   2.  Cancelling uploads/downloads with the escape key is often delayed,
  228.       particularly with the CompuServe B protocol.  The CompuServe protocol
  229.       also fails to halt when it encounters severe line noise.
  230.  
  231.  
  232. * Keyboard Macros
  233.  
  234.   Keyboard macros allow you to assign character strings to the keys [Alt-0]
  235.   through [Alt-9], which may then be used to transmit the assigned string in
  236.   place of actual typing.  RockComm macros are stored in the same format as is
  237.   used by Procomm Plus, allowing for 10 macro strings of up to 50 characters.
  238.   To send a macro string, simply press the appropriate key, Alt-0 through
  239.   Alt-9.
  240.  
  241.   To represent control characters within a macro string, use the ^ ("caret")
  242.   symbol followed by the letter of the control code you want. This will most
  243.   commonly be used as ^M, meaning, control-M, which is the equivalent of the
  244.   return key.  For example, the macro string "line 1^Mline 2^M" would provide
  245.   the equivalent of typing "line 1", pressing return, typing "line 2", and
  246.   pressing return again.
  247.  
  248.   Currently there can be only one macro file active, "ROCKCOMM.KEY", which is
  249.   automatically loaded if the program finds it in the current directory when
  250.   it is started.  To use a Procomm Plus macro file, rename it to
  251.   "ROCKCOMM.KEY", for example, "rename pcplus.key rockcomm.key".
  252.  
  253.  
  254. * About the Developer
  255.  
  256.   RockComm was written by Rob Argyropoulos, a computer engineer with several
  257.   years of experience in the field of enabling technology.  Additionally, Mr.
  258.   Argyropoulos produces a set of more than two dozen general IBM PC utilities
  259.   called the Rock Utilities, sold as shareware.
  260.  
  261.   Rock Systems can be reached through E-Mail sent to CompuServe account
  262.   [71270,146], GENie I.D. R.ARGYROPOULO, or to "Rob Argy" on the DBK Bulletin
  263.   Board System, a tech support system for another firm's products, at (313)
  264.   662-9160 (2400 Baud, None, 8, 1).  Rock's current telephone number is (313)
  265.   971-9123.  Feedback and suggestions are welcome; I'd love to hear if you
  266.   use the program.
  267.  
  268.  
  269. * Credits
  270.  
  271.   The low-level communications routines used in RockComm come from the public
  272.   domain Turbo Pascal unit "IBMCOM.PAS", by Wayne Conrad.
  273.  
  274.   The X-Modem transfer routines XFER, written for use with IBMCOM, were
  275.   written and donated to the public domain by Andrew Bartels.
  276.  
  277.   The dialing directory and key macro file formats were designed after those
  278.   of DataStorm Technologies' Procomm Plus software (Copyright 1987-1988
  279.   DataStorm Technologies, Inc.), in order to enhance compatibility between
  280.   these programs.  (You can read the dialing directory or macro files of one
  281.   program using the other).
  282.  
  283.   Thanks to Kasey for providing prodding, testing, and suggestions.
  284.