home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR10 / GDSTERM.ZIP / GDSTERM.DOC < prev    next >
Text File  |  1993-04-20  |  17KB  |  324 lines

  1.  
  2.                      GDSTERM and TTYHOST Documentation
  3.                               (c) 1993 GDSOFT
  4.  
  5.                               April 20, 1993
  6.  
  7.  
  8. This  is  limited  documentation  for  GDSTERM.EXE  and TTYHOST.EXE. Please
  9. remember that both of these program are BETA, and many changes may still be
  10. made.
  11.  
  12. The terminal program is GDSTERM.EXE and  the host module is currently named
  13. TTYHOST.EXE. Both  program can be  executed from the  DOS prompt or  from a
  14. menu.
  15.  
  16. These two program provide for complete communications via modem between two
  17. computers.  They  both  support  downloads/uploads  using  XMODEM,  YMODEM,
  18. YMODEMG, and any batch file protocol of  your choice such as DSZ, HSLINK or
  19. TEXAS ZMODEM.
  20.  
  21. CONFIGURATION FILES
  22. -------------------
  23.  
  24. You will notice that these programs are  VERY small. One of the reasons, it
  25. that  these files  have been  compressed with  PKLITE by  PKWARE. What this
  26. means is that in  order to provide for such things as  baud rate, com port,
  27. and  other  varible  information,  these  programs  use configuration files
  28. instead of writing the information back to the EXE file. Before using them,
  29. you will need  to use a word processor or  editor, and edit the GDSTERM.CFG
  30. and TTYHOST.CFG  files. You should  set which com  port you are  using, the
  31. HIGHEST  baud rate  that your  modem will  work at, initialization strings,
  32. upload and download paths, and a list of number you want to include in your
  33. dialing  directory. The  best thing  to do  is refer  to the  CFG files for
  34. examples of what everthing does.
  35.  
  36.  
  37. RUNNING THE PROGRAMS
  38. --------------------
  39.  
  40. Running TTYHOST  is simply a matter  of executing the program  from the DOS
  41. prompt. After that,  there is no interaction required  from the user. There
  42. are configuration switches that can be turned OFF or ON. Make sure that you
  43. edit  TTYHOST.CFG and  set the  values to  your liking  before you  run the
  44. program.
  45.  
  46. EXAMPLE CONFIGURATION FILE :  (TTYHOST)
  47.  
  48. PORT=2                                       ;modem port
  49. BAUD=57600                                   ;start baud rate
  50. PASSWORD=GDSOFT                              ;login host password
  51. AUTOANSWER=YES                               ;modem answers NOW or needs 2 ring callback
  52. BATCHFILE=D:\MODEM\ULDL.BAT                  ;batch for external transfers. MUST be defined BEFORE Protocols
  53. LOGONFILE=D:\MODEM\HOSTSM.ANS                ;ANSI file for log on procedure ( DEFAULT = Built in screen)
  54. DOORFILE=\doors\doorrun.bat                  ;batch file name for DOORS
  55. HOSTNAME=GDSOFT HOST                         ;name of this HOST
  56. PROTOCOL1=~T~exas ZModem                     ;name of External PROTOCOL #1
  57. PROTOCOL2=Hyper~P~                           ;name of External PROTOCOL #2
  58. INIT=ATZ&B1&H1&N0L0B0M1Q0V1X4S0=0S11=60      ;modem setup string
  59.  
  60. Normally, TTYHOST will  answer the telephone on the  FIRST ring, and permit
  61. the caller  to log on. However,  notice the AUTOANSWER= switch.  If you set
  62. this to NO, then TTYHOST will do something special. First, it counts rings.
  63. If it receieves  two (2) and NO MORE  within 15 seconds, then it  starts an
  64. internal  60 second  timer loop.  For this  60 second  period ONLY, it will
  65. answer the phone on  the FIRST ring. After the 60 seconds,  it goes back to
  66. counting rings again.  This is useful if you only  have one phone line, and
  67. have an  answering machine and  DO NOT want  TTYHOST to answer  if there is
  68. MORE  than two  rings. Make  sure that  you set  your answering  machine to
  69. something  GREATER that  two rings.  To make  it simple,  here is the EXACT
  70. procedure to follow :
  71.  
  72. 1.  Call you number and let the phone ring TWICE ONLY !!!  Hang UP !!
  73. 2.  Wait  10 seconds and call  back again, TTYHOST will  answer.
  74.  
  75. Another  configuration  file  switch  that  might  need explaination is the
  76. LOGONFILE= switch. Normally, TTYHOST displays  it's internal log on screen.
  77. However, you might want  to create your own. This screen MUST  be an a file
  78. that  contains ANSI  escape sequences  that can  be displayed.  Try out the
  79. shareware  program THEDRAW  for a  great ANSI  editor that  can be  used to
  80. create  your  file.  You  can  name  it  anything  you  wish,  just set the
  81. LOGONFILE=FILENAME in the configuration file.
  82.  
  83. You can  terminate the program  and hang up  on the caller  at any time  by
  84. pressing the the ESC key.
  85.  
  86.  
  87. GDSTERM.EXE is  a full featured  communications program with  MANY built in
  88. features. I  won't try to  list all of  them, or explain  how each works in
  89. great detail,  as I will assume  that you are familiar  with some other com
  90. program that  has similiar capabilities.  Here are a  few of the  important
  91. features and commands :
  92.  
  93. HELP
  94. ----
  95.  
  96. The HOME key pops  up a help screen and lists all  of the commands that are
  97. available. Most of these are common  such as PGDN for downloading files and
  98. PGUP for uploading.
  99.  
  100.                 ┌─────────── GDSTERM : HELP ───────────┐
  101.                 │ Alt C       Clear Terminal Screen    │
  102.                 │ Alt D       Dial The Phone           │
  103.                 │ Alt I       Initialize Modem         │
  104.                 │ Alt H       Go OFFLine (Hangup)      │
  105.                 │ Alt L       Initiate Online CHAT     │
  106.                 │ Alt M       Manual Dial              │
  107.                 │ Alt N       Write Your Name          │
  108.                 │ Alt Q       Host Mode                │
  109.                 │ Alt R       Redial Last Number       │
  110.                 │ Alt S       Dos SHELL                │
  111.                 │ Alt =       DOORWAY Mode             │
  112.                 │ PgUp/Down   UPLOAD/DOWNLOAD Files    │
  113.                 │ Home        Display Help Screen      │
  114.                 │ CtrlHome    Display Status           │
  115.                 │ F1          Buffer Control           │
  116.                 │ F2..F5      Execute Commands         │
  117.                 │ F6          Toggle Capture File      │
  118.                 │ F7          Dial Directory           │
  119.                 │ F8          Change UPLOAD Path       │
  120.                 │ F9          Change DOWNLOAD Path     │
  121.                 │ F10         Exit Program             │
  122.                 └──────────────────────────────────────┘
  123.  
  124. FILE TRANSFERS
  125. --------------
  126.  
  127. GDSTERM supports XMODEM,  YMODEM, YMODEMG and ZMODEM using  DSZ.COM by OMEN
  128. Technology  and  HSLINK  by  Sam  Smith.  You  can  also add other external
  129. protocols  to GDSTERM  and TTYHOST   such as  SZMODEM.EXE or  TEXAS ZMODEM.
  130.  
  131. Included with the  files is a sample batch file  for doing this (ULDL.BAT).
  132. This batch file  is divided into TWO main areas.  One for DOWNLOAD, and one
  133. for UPLOAD. Each of the five possible  protocols has a section in each area
  134. named ONE,TWO,THREE etc. Simply add the necessary commands for any protocol
  135. to the section for protocol#1, protocol#2  etc. Study the ULDL.BAT file and
  136. I think you'll get  the idea. TTHOST and GDSTERM  outputs certain values to
  137. this  batch  file  such  as  port,  modem  speed,  file  names  and dowload
  138. directory.
  139.  
  140. Next, you MUST modify your .CFG file so either GDSTERM or TTYHOST will know
  141. which protocol  is in which  slot. You will  need a line  in your .CFG file
  142. that looks like this :
  143.  
  144. PROTOCOL1=~T~exas ZModem           ;name of External PROTOCOL #1
  145.  
  146. The Tilde(~)  character selects which the  MENU key that will  be displayed
  147. when you do DOWNLOADS or UPLOADS to select the protocol. Notice that in the
  148. example, Texas Zmodem is assigned to PROTOCOL1.  It's THAT EASY !!
  149.  
  150. If everything is setup properly, when  you select a given protocol from the
  151. DOWNLOAD/UPLOAD menu (pgdn/pgup), TTYHOST and  GDSTERM calls the batch file
  152. with the proper parameters and execution  occurs at the place that you have
  153. defined for that protocol.
  154.  
  155. YOU DO  NOT NEED TO  DEFINE a  PROTOCOLx=  for DSZ.COM or  HSLINK. They are
  156. ALREADY built  into BOTH TTYHOST and  GDSTERM, and these programs  with the
  157. proper baud rate etc are called AUTOMATICALLY.
  158.  
  159.  
  160. DIALING DIRECTORY
  161. -----------------
  162.  
  163. Access the dialing directory with ALT D or F7.
  164.  
  165.     ┌────────────────────── Dialing Directory List ──────────────────────┐
  166.     │ ┌────────────────────────────────────────────────────────────────┐ │
  167.     │ │ 01 Your Favorite BBS         555-1234 NO   57600 8 N 1 F CRT   │ │
  168.     │ │ 02 GDSOFT                    875-8133 NO   38400 8 N 1 F CRT   │ │
  169.     │ │ 03 Compuserve - 9600       1-271-0016 YES   9600 7 E 1 F CRT   │ │
  170.     │ │ 04 Compuserve (800)    1-800-331-7166 YES   9600 7 E 1 F CRT   │ │
  171.     │ │ 05 CompuServe - LOCAL        294-8629 NO    2400 7 E 1 F CRT   │ │
  172.     │ │ 06 Genie - 9600            1-424-4754 YES   9600 8 N 1 F ANSI  │ │
  173.     │ │ 07 Genie Network             295-1550 NO    2400 8 N 1 F ANSI  │ │
  174.     │ │ 08 EXEC-PC             1-414-789-4360 YES  57600 8 N 1 F ANSI  │ │
  175.     │ │ 09 TurboPower BBS      1-719-260-9726 YES  57600 8 N 1 F ANSI  │ │
  176.     │ │ 10 Canada REMOTE       1-416-629-7000 YES  57600 8 N 1 F ANSI  │ │
  177.     │ │ 11 Dave's BBS                293-6465 NO   57600 8 N 1 F ANSI  │ │
  178.     │ │ 12 SurReal BBS               262-9371 NO   57600 8 N 1 F ANSI  │ │
  179.     │ │ 13 After Five                262-1370 NO   57600 8 N 1 F ANSI  │ │
  180.     │ │ 14 Rusty & Edies       1-216-726-3637 YES  57600 8 N 1 F ANSI  │ │
  181.     │ │ 15 Radio Daze              1-256-2297 YES  57600 8 N 1 F ANSI  │ │
  182.     │ │ 16 Toolkit BBS             1-696-3415 YES  57600 8 N 1 F ANSI  │ │
  183.     │ │ 17 Sam's Tool Shop     1-818-891-1344 YES  57600 8 N 1 F ANSI  │ │
  184.     │ │ 18 Not So Perfect      1-312-237-8365 YES  57600 8 N 1 F ANSI  │ │
  185.     │ └────────────────────────────────────────────────────────────────┘ │
  186.     └────────────────────────────────────────────────────────────────────┘
  187.  
  188. You  can have  up to  50 entries   in each  directory, and  by selecting  a
  189. different  directory using  the command   line switch,  you can  access any
  190. number of  different directories. By default, GDSTERM accesses the directory
  191. named GDSTERM.DIR.
  192.  
  193. Manual dialing can be accomplished by pressing the 'M' key. You'll be shown
  194. a blank entry screen, and you can fill in the blanks. The data entered will
  195. not be saved.
  196.  
  197. Use the  PgUp , PgDn ,  ,   Keys to navigate up and down the list.
  198.  
  199. Press F1 to edit an entry. You  enter the name, phone number, long distance
  200. indicator, Baud Rate, Bits, and your AUTOLOG script for each entry. See the
  201. later section about AUTOLOG .
  202.  
  203.     ┌─────────────────────── Dial Directory Record ──────────────────────┐
  204.     │ ┌────────────────────────────────────────────────────────────────┐ │
  205.     │ │                                                                │ │
  206.     │ │               Name : GDSOFT Support BBS                        │ │
  207.     │ │             Number : 875-8133                                  │ │
  208.     │ │      Long Distance : NO    Dial String : ATB1DT                │ │
  209.     │ │          Baud Rate : 38400                                     │ │
  210.     │ │             Parity : None    Stop Bits : 1  Data Bits : 8      │ │
  211.     │ │             Duplex : FULL     Terminal : CRT                   │ │
  212.     │ │                                                                │ │
  213.     │ │   Command String 1 : ? |YOUR NAME                              │ │
  214.     │ │   Command String 2 : ? |YOUR PASSWORD                          │ │
  215.     │ │   Command String 3 :                                           │ │
  216.     │ │   Command String 4 :                                           │ │
  217.     │ │   Command String 5 :                                           │ │
  218.     │ │                                                                │ │
  219.     │ │     Memo : You can use this are for any information that you   │ │
  220.     │ │            want !!!                                            │ │
  221.     │ │                                                                │ │
  222.     │ │                                                                │ │
  223.     │ │                                                                │ │
  224.     │ └── Line: 3   Column: 1    22% ──────────────────────────────────┘ │
  225.     └────────────────────────────────────────────────────────────────────┘
  226.  
  227. After editing,  make sure to  SAVE the Directory  with the '  F2 ' key. You
  228. will be given  an opportunity at the point  to enter a PASSWORD .  Doing so
  229. will require ALL future users to know the password in order to use GDSTERM.
  230.  
  231. Be CAREFUL about the PASSWORD , if you forget it, your in BIGGGG TROUBLE .
  232.  
  233. Use the F3 key  to select a NEW dialing directory. Enter  the FULL path and
  234. file name.  If the file  requires a password,  you will be  prompted. Press
  235. ESCAPE on the  password screen, and you will again  be prompted for another
  236. directory file  name. Press ESCAPE  again, and the  program will end.  This
  237. feature give you  the ability to have multiple  directories on one machine,
  238. and each user can have their own directory.
  239.  
  240. Once items  have been entered,  simply press ENTER(┘)  , and GDSTERM  will
  241. dial the number and process the AUTOLOG sequence for you.
  242.  
  243. The dial  string is IMPORTANT  !!! It should  be AT LEAST  "AT". If you are
  244. calling a  V.42 modem, it  should be ATB1.  If you are  calling a modem the
  245. REQUIRES compression to be off such  as Compuserve 9600, it should be ATB0.
  246. If you  want to call  a MPN modem,  it could be  ATM5. Refer to  your modem
  247. manual for  more information about this.  The important thing is  that EACH
  248. LIST item  MUST be on  ONE line, and  contain the necessary  information in
  249. order to work !!! NO SPACES PLEASE between the commas !!
  250.  
  251.  
  252. AutoZMODEM Feature :
  253. --------------------
  254.  
  255. MOST  BBS  systems  around  the   country  support  the  very  popular  DSZ
  256. implementation  of ZMODEM,  and HSLINK  by Sam  Smith. If  you one of these
  257. protocols as your  primary transfer protocol on these  BBS systems, GDSTERM
  258. will recognize the ZMODEM or HSLINK  header that is transmitted during file
  259. DOWNLOADS , and  automatically begin the download for you.  You do not have
  260. to do ANYTHING except to tell the BBS  to send the file !!! GDSTERM will do
  261. the  rest.  You  might  want  to  use  F9  to  set  the directory where the
  262. downloaded files will be put. This  function may be disabled by setting the
  263. switch in the configuration file.
  264.  
  265.  
  266. AUTOLOG feature :
  267. -----------------
  268.  
  269. Many  communication programs  uses SCRIPT  files to  automate communication
  270. sessions and for automatic log-on  to BBS's. GDSTERM implements an approach
  271. to this SCRIPT mechanism at least for log-on purposes.
  272.  
  273. The  last  5  fields  of  the  Dialing  Directory  record  are for "command
  274. strings". After  dialing an entry, GDSTERM  will use these strings  to "LOG
  275. ON" to the BBS  that you call. The value BEFORE the  '|' is what GDSTERM is
  276. looking for from the other modem. Once  it sees this "WAIT STRING", it then
  277. transmits the string on the other side of the '|'.
  278.  
  279. Here is an example command string :
  280.  
  281.                Enter your name:? |  Gayle Davis
  282.                  ^WaitString     | ^Send String
  283.  
  284. Often, you'll want to wait for or  send control characters. This is how you
  285. would do that :
  286.  
  287.                              #10 |  #13
  288.                        WaitChar^ | ^Send Char
  289.  
  290. Of course what this is is the  decimal equivilant of ^J or a linefeed. Take
  291. special notice of the  '#' pound sign. This is a MUST  !! Once GDSTERM gets
  292. this  character, it  would transmit  a CR  which is  decimal character  13.
  293. Multiple wait/send characters can be sent like this :
  294.  
  295.                         #10#10   |  #3#13#13
  296.                        WaitChar^ |  ^Send Char
  297.  
  298. This would  cause GDSTERM to  wait for  TWO  linefeed and then  send Ctrl C
  299. (003) and two carriage returns.
  300.  
  301. This AUTOLOG  process can be interrupted  by pressing ESCAPE ,  and GDSTERM
  302. will set and  wait only so long before  it timesout in which case  you will
  303. have to attempt to  log on manually. This function may be  turned ON or OFF
  304. by setting the switch in the configuration file.
  305.  
  306.  
  307.  
  308. PROGRAMMABLE FUNCTION KEYS
  309. --------------------------
  310.  
  311. Function  keys F2  - F5  can be  programmed to  call ANY  program that  you
  312. choose. To do this, include a command in your config file like this :
  313.  
  314.                           F2=LIST.COM or F3=FM.EXE
  315.  
  316. Assuming the program exists, and can be found where you say it is, pressing
  317. the appropiate key  will execute it when GDSTERM is  running. This is handy
  318. for looking  at files with the  FILE MANAGER or doing  some other necessary
  319. work. GDSTERM WILL NOT  look for the file on your path,  so a complete path
  320. MUST be included for the file to run.
  321.  
  322.  
  323.  
  324.