home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD2.bin / bbs / dev / tbsource.lha / TBSource / ShellTerm / Final / ShellTerm.DOC < prev    next >
Text File  |  1993-12-21  |  24KB  |  697 lines
  1.  
  2. 27/05-93            ShellTerm V1.19
  3.  
  4. Updated: 05/08-92 - for version 1.01 - Preliminary docs
  5. Updated: 06/08-92 - for version 1.02 - Preliminary docs
  6. Updated: 08/08-92 - for version 1.03 - Almost finished docs
  7. Updated: 11/08-92 - for version 1.04 - Release version
  8. Updated: 14/08-92 - for version 1.05 - Bug fixes
  9. Updated: 28/08-92 - for version 1.06 - Additions and beta testing
  10. Updated: 30/08-92 - for version 1.07 - Additions and beta testing
  11. Updated: 04/09-92 - for version 1.08 - Additions
  12. Updated: 06/09-92 - for version 1.09 - Release 2
  13. Updated: 20/10-92 - for version 1.10 - Bug fixes
  14. Updated: 13/11-92 - for version 1.11 - Private release
  15. Updated: 01/01-93 - for version 1.12 - Release 3
  16. Updated: 02/01-93 - for version 1.13 - Additions
  17. Updated: 06/02-93 - for version 1.14 - Bug fixes
  18. Updated: 10/02-93 - for version 1.15 - Release 4. 'Feature' removed
  19. Updated: 24/03-93 - for version 1.16 - Release 5. Major bug fix
  20. Updated: 25/03-93 - for version 1.17 - Release 6. Additions
  21. Updated: 22/05-93 - for version 1.18 - Additions
  22. Updated: 27/05-93 - for version 1.19 - Release 7. Additions
  23.                         
  24.  Copyright (C) Tomi Blinnikka 1993, All Rights Reserved.
  25.                     ^^^^^^^^^^^^^^^^^^^^
  26. This program is SHAREWARE. This means that you can copy it and give it
  27. to all your friends, upload it to a BBS or include it in a PD-library
  28. (FISH etc.). BUT (!!!) if you use this program frequently you must 
  29. pay $5 - $10. The other restrictions are: all of the files must be 
  30. included in their original form without additions, deletions, or 
  31. modifications of any kind and it IS NOT TO BE SOLD. THIS INCLUDES 
  32. GERMAN PD DEALERS. If you wish to use this program for commercial 
  33. purposes, you need written permission. The ShellTerm program is 
  34. provided "AS IS" without warranty of any kind, and the author is not 
  35. responsible for any damage this software may or may not do.
  36.  
  37.  
  38. TABLE OF CONTENTS
  39. ~~~~~~~~~~~~~~~~~
  40. 1. What does it do?
  41.  
  42.    - Short description of what this program does and/or does not do.
  43.  
  44. 2. What do you need?
  45.  
  46.    - A list of software/hardware needed.
  47.  
  48. 3. Compatibility
  49.  
  50.    - A list of computers this program works on.
  51.  
  52. 4. Setting up
  53.  
  54.    - Instructions on how to set up ShellTerm
  55.  
  56. 5. How to run it
  57.  
  58.    - Instructions on starting the program and what arguments it takes.
  59.  
  60. 6. Using ShellTerm
  61.  
  62.    - A short description of all functions
  63.  
  64.    6.1    Main menu
  65.    6.2    Dialer menu
  66.    6.3    Preferences menu
  67.    6.4    Serial settings
  68.    6.5    Terminal settings
  69.  
  70. 7. The phonebook
  71.  
  72.    - Explanation of the autodialer and phonebook.
  73.  
  74. 8. Hints & tips
  75.  
  76.    - Hints & tips. Other programs to enhance using ShellTerm etc.
  77.  
  78. 9. Problems
  79.  
  80.    - Possible problems you may run into.
  81.  
  82. 10. Other interesting stuff
  83.  
  84. 11. Error messages
  85.  
  86. 12. Versions
  87.  
  88.    - A list of all versions. The newest first.
  89.  
  90. 13. Future versions
  91.  
  92. 14. Bugs
  93.  
  94.    - List of bugs found.
  95.  
  96. 15. ShareWare fee
  97.  
  98.    - More information on the ShareWare fee.
  99.  
  100. 16. Beta Testers
  101.  
  102.    - A list of beta testers.
  103.  
  104. 17. 'Registered' users
  105.  
  106.    - A list of users that have payed the ShareWare fee.
  107.  
  108. 18. Bug reports etc.
  109.  
  110.    - How to contact the author
  111.  
  112.  
  113. 1. WHAT DOES IT DO?
  114. ~~~~~~~~~~~~~~~~~~~
  115. This is a simple terminal program that runs in a CLI/Shell window. Its
  116. primary use is with dumb terminals hooked up to an AUX-handler. This is
  117. the reason ShellTerm doesn't open a window or screen. It uses standard
  118. input and output. I use it as a substitute for JrComm (Copyright John
  119. P. Radigan) when I'm using my dumb terminal (it's next to my bed... that
  120. explains most of the stupid mistakes in these docs :) and want to call
  121. a BBS without having to get out of bed and walk over to my Amiga.
  122.  
  123. 2. WHAT DO YOU NEED?
  124. ~~~~~~~~~~~~~~~~~~~~
  125. You'll need an Amiga computer (see compatibility list), with Kickstart
  126. 2.04 (version 37 or higher). Basically you'll also want a HAYES compatible
  127. modem or some other piece of equipment connected to the device you specify.
  128.  
  129. 3. COMPATIBILITY
  130. ~~~~~~~~~~~~~~~~
  131. ShellTerm will work on any Commodore Amiga, running on Kickstart
  132. 2.04 or higher. This includes the following: A500(+), A600, A1000, A1200,
  133. A2000, A2500/20, A2500/30, A3000 (16 MHz or 25 Mhz model), A4000/40,
  134. A4000/30. The program SHOULD work on any upgrades (based on the Amiga 
  135. Development Guidelines, see Amiga ROM Kernel Reference Manual (Release 2): 
  136. Includes and Autodocs, introduction). ShellTerm works with all internal 
  137. modems (I have a Supra 2400zi) and extra serial boards that support the 
  138. normal device commands (I also have the A2232 serial board, but I missed 
  139. a bug with it on versions under 1.16 :).
  140.  
  141. 4. SETTING UP
  142. ~~~~~~~~~~~~~
  143. Unpack the archive somewhere and copy the files wherever you wish, but the
  144. following is recommended:
  145.  
  146. Filename            Where to copy
  147. =====================================================================
  148. ShellTerm            C:
  149. WatchPort            C:
  150. Scripts/ST            S:
  151. Scripts/ShellTerm-StartUp    S:
  152. ShellTerm.DOC            Wherever (I use DOCS:)
  153. ShellTerm.DOC.info        Wherever (I use DOCS:)
  154. CONTENTS            Wherever
  155. CONTENTS.info            Wherever
  156. CHANGES                Wherever
  157. CHANGES.info            Wherever
  158.  
  159. If for some reason the flags of the files in the directory ShellTerm/Scripts
  160. are not '-s--rwed', set them with the command 'Protect ShellTerm/Scripts/#?
  161. SWERD'.
  162.  
  163. 5. HOW TO RUN IT
  164. ~~~~~~~~~~~~~~~~
  165. You can run the program from a CLI/SHELL/etc. but you can't hang an icon on
  166. it and start it from the Workbench. I decided to drop the Workbench startup
  167. code to make the program a little bit smaller.
  168.  
  169. To run the program, enter the following into your CLI/SHELL/etc.
  170.  
  171.     1> ShellTerm FROM [FILENAME] PORT [NAME]
  172.  
  173.     FROM specifies the prefs file to load and use.
  174.  
  175.     PORT specifies a name for the user port to open. See HINTS & 
  176.     TIPS 8.
  177.  
  178. You cannot, however, redirect input to the program, i.e. ShellTerm <NIL:
  179. won't work. RUNning is also out of the question and will give the same
  180. error text as redirecting.
  181.  
  182. Or then use the script in the scripts directory. It will take the following
  183. options:
  184.  
  185. FROM [FILENAME]        - Same as ShellTerm's
  186. SCREEN [SCREEN NAME]    - A name for the screen to open
  187.               (DEFAULT: ShellTerm Screen)
  188. DEPTH [SCREEN DEPTH]    - The depth of the screen to open
  189.               (DEFAULT: 1)
  190. WINDOW [WINDOW NAME]    - A name for the Shell to open
  191.               (DEFAULT: ShellTerm Window)
  192. PORT [NAME]        - Same as ShellTerm's
  193.  
  194. The ST script needs and uses a program called PSX, by Steve Tibbett, to
  195. open the public screen. You can change this to your favorite public screen
  196. manager if it allows you to specify the screen specifications from the
  197. command line.
  198.  
  199. 6. USING SHELLTERM
  200. ~~~~~~~~~~~~~~~~~~
  201. Once the program has been started, anything typed into the CLI/Shell will be
  202. sent to the selected device. If the device does not echo the characters, you
  203. will not see anything. Normally there is a modem at the end of the device
  204. and you will see whatever was typed. Try typing "AT <RETURN>". If it works,
  205. you'll receive an OK text from the modem. If however there was terminal
  206. hooked up, the characters should have appeared on its screen. If this didn't
  207. work, please check the device's parameters from the Preferences menu.
  208. Say the characters are messed up, try checking the serial speed.
  209.  Pressing CTRL-P will show you the menus. The CTRL-P sequence is not sent
  210. over to the device. You will be displayed with the options available. Press
  211. the key enclosed in parenthesis to select an item. A short description of all
  212. items follows.
  213.  
  214. 6.1 Main menu
  215. ~~~~~~~~~~~~~
  216.  
  217.   Show statistics    Shows how many bytes have been transferred to and
  218.             from the device.
  219.  
  220.   Clear statistics    Clears the "Bytes received/sent" counters.
  221.  
  222.   Send break        Sends a break signal to the device.
  223.  
  224.   Send CTRL-P        Sends CTRL-P to the device. It is not sent when
  225.             the menus are entered. CTRL-P is DLE, decimal #16,
  226.             hex $10, octal &020.
  227.  
  228.   Reset font        Changes the CLI/Shell font to plain (no bold,
  229.             underline, reverse etc.).
  230.  
  231.   Clear screen        Clears the screen and returns back to terminal
  232.             mode.
  233.  
  234.   Reset modem        Resets the modem with the Hayes command "ATZ".
  235.  
  236.   Hangup line        Hangs up line using the Hayes commands. Three
  237.             plus signs (+) are sent first, followed by a delay
  238.             of approx. 3 seconds, after which "ATH" is sent.
  239.  
  240.   Upload        Starts the program you've specified as the
  241.             uploader. Normally SZ.
  242.  
  243.   Download        Starts the program you've specified as t