home *** CD-ROM | disk | FTP | other *** search
/ norge.freeshell.org (192.94.73.8) / 192.94.73.8.tar / 192.94.73.8 / pub / computers / pcjr / misc / GTP.LZH / GTP.DOC next >
Text File  |  1987-02-12  |  13KB  |  273 lines
  1.                      GTP - by Jamie Mueller
  2.                       General Documentation
  3.                           Version 1.22
  4.  
  5.      GTP  commands  are divided into  several  groups:  Parameter 
  6. setting,    'Macro'   processing,    Buffer   manipulation,   and 
  7. Miscellaneous.  Only  two characters are needed for each  command 
  8. (the  characters  are  in parentheses after the  command  in  the 
  9. following).
  10.  
  11.      When  GTP  is  first booted up it will be  in  the  terminal 
  12. screen.  To  switch from terminal screen and command screen  (and 
  13. vice-versa) press Shift-Tab.
  14.  
  15. Parameter  setting commands:  The parameter setting commands  are 
  16. used  to  set up the communications port for the modem  with  the 
  17. desired speed, etc.
  18.  
  19. Baud(BA):  This command will set the baud rate. Any number may be 
  20.      specified between 50 and 9999.  The communications port will 
  21.      be set to that baud even if it is 'non-standard'. If no baud 
  22.      rate  is given,  GTP will ask for one.  The default settings 
  23.      are  loaded  in from the file GTP.PRM when GTP is  initially 
  24.      loaded.
  25.  
  26. Data(DA):  This  command  will  change the number  of  data  bits 
  27.      sent/received. Allowable numbers are 5,6,7, and 8.
  28.  
  29. Parity(PA):  This  command will set the parity.  Only  the  first 
  30.      letter of the setting is needed (e.g. E for even).
  31.  
  32. Stop Bits(ST):  This  command  will set the number of stop  bits. 
  33.      Either 1 or 2.
  34.  
  35. No(NO): This command will set the port number. Either 1 or 2.
  36.  
  37. Save(SA):  Saves the current settings in the specified file  with 
  38.      the  extension  of .PRM.  If no filename is given  then  the 
  39.      settings are saved in the file GTP.PRM. The settings include 
  40.      the  following:  The  communications port parameters  (baud, 
  41.      parity, etc.), all of the function key settings (F0-F9, Alt-
  42.      A-Alt-Z),  the screen colors (only applicable to the  PCjr), 
  43.      the tab settings, and the F1 request character.
  44.  
  45. Load(LO):  Loads  the  specified parameter file and sets all  the 
  46.      parameters from it.  Anytime a parameter file is loaded, its 
  47.      F0 key is Automatically sent.  (See Fn command). If you wish 
  48.      a  parameter file other than GTP.PRM to be loaded at  bootup 
  49.      supply a filename at invocation (e.g. GTP COMPUSRV).
  50.  
  51. Macro Processing command set up the function keys.  There is only 
  52. one 'macro' command:
  53.  
  54. Function  keys(FN):  Sets the desired function key to  the  value 
  55.      specified  (e.g.  "FN  1  Hello" will set F1 to  the  string 
  56.      "Hello"). Keys that can be set are F0 (F10 on the PC) to F9, 
  57.      and Alt-A through Alt-Z.  Whenever a function key is pressed 
  58.      its contents are sent through the keyboard as if those  keys 
  59.      were  being pressed.  A carat ("^") in the string  indicates 
  60.      some special options:
  61.  
  62.      Character following carat     Option              Example
  63.      -------------------------     ------              -------
  64.      A through Z   allows control characters to be       ^M
  65.                    entered into the string
  66.      a number (like 13)   allows any character to be     ^13
  67.                           entered into the string
  68.                    NOTE: The above two examples are identical.
  69.      >  Switches to the command screen                   ^>
  70.      <  Switches to the terminal screen                  ^<
  71.      =  Continues macro from another function key        ^=5
  72.           The example will continue sending characters from
  73.           the function key F5. (A letter would use the  Alt
  74.           keys.)
  75.      ?  Waits for the character following to be received ^?:
  76.           The example will wait for a colon (':') to be 
  77.           received.
  78.  
  79.      Another special function character is the tilde ('~'),  when 
  80.      put  in  the function key string,  it will cause a 2  second 
  81.      delay.  NOTE:  The  VCO feature makes extensive use  of  the 
  82.      tilde  character,  but this function makes sending the tilde 
  83.      virtually  impossible.  Solution (only if 7 Data bits is  in 
  84.      use) set a function key (e.g. Alt-T) to the character 254 (a 
  85.      graphics Dot). In a 7 bit system this character will be sent 
  86.      as the tilde (set the key like "FN T ^254").
  87.  
  88.           Function  keys  are limited to only 40  characters.  If 
  89.      this is not long enough use the ^= sequence to continue  the 
  90.      macro in another function key.
  91. Special Function Keys: The key F0 will automatically be sent when 
  92.      a) GTP is first executed and the file GTP.PRM is loaded, and
  93.      b)  whenever  a different parameter file is loaded  via  the 
  94.      load command.
  95.      The  key  F1 will automatically be sent when the F1  request 
  96.      character is received (default ^E).  The current F1  request 
  97.      character is displayed on the screen as (F1 -> xx ) where xx 
  98.      is  the the character (if it is a control character it  will 
  99.      appear as a carat ('^') followed by the letter, otherwise it 
  100.      will just appear as it is).  The F1 request character can be 
  101.      changed  by  entering  the command "FN - xxx" where  xxx  is 
  102.      either  a control character (denoted by ^ first or  using  a 
  103.      number  like  ^5) or a normal character (like "FN - :"  sets 
  104.      the F1 request to a colon).
  105.  
  106. Typically the parameter file GTP.PRM's function keys would be set 
  107.      as follows:
  108.      Key   Setting
  109.      F0    Initialize the modem
  110.      F1    ^>LO SYSA^M    (Loads the parameter file for SYSA)
  111.      F2    ^>LO SYSB^M    (Loads the parameter file for SYSB)
  112.       etc...
  113. and the  file  SYSA.PRM's function keys would be set  as  follows 
  114.      (with SYSB.PRM's having a similar structure)
  115.      Key   Setting
  116.      F0    ^<ATDT5555555^M  (Dials the number for SYSA)
  117.      F1    ^<John^m^?:Doe^m^?:password^M
  118.      F2    etc...
  119.  
  120. If  the following files are on the same disk as GTP.EXE then  the 
  121. following  sequence  of events would happen when the  user  typed 
  122. GTP[ENTER]:
  123.  
  124.      1)   GTP  is  loaded  and  executed,  initializing  all  its 
  125.           defaults.  GTP then loads the help file GTP.HLP for the 
  126.           help prompts.
  127.      2)   The   parameter   file  GTP.PRM  is  loaded   and   the 
  128.           communications port is set up.
  129.      3)   Function key F0 is sent to the modem.
  130.      4)   The user presses F1 (for ^>LO SYSA^M)
  131.      5)   The  parameter file SYSA.PRM is loaded into GTP and its 
  132.           F0 key is sent:
  133.           A)   The  ATDT5555555^M is sent to the  modem,  dialing 
  134.                the number.
  135.           B)   Assuming  the called system responds:  The  system 
  136.                answers and sends the following:
  137.                     Welcome to System A
  138.  
  139.                     Please enter your first name:^E
  140.                     Please enter your last  name:
  141.  
  142.                     Password:
  143.           C)   GTP  responding  to the F1 request character  (^E) 
  144.                starts  to send F1.  (john^m...) but it will  only 
  145.                send up to the ^?: because...
  146.           D)   The ^?: tells GTP to suspend sending the key until 
  147.                a colon (':') is received.
  148.           The net result is that only "John^M" is entered for the 
  149.           first name,  "doe^M" is entered for the last name,  and 
  150.           "password^M" is entered for the password.
  151.  
  152. NOTE: In  the  function key display area control  characters  are 
  153.      displayed  in  inverse  video,  ^> is displayed  as  the  >> 
  154.      character,  ^<  is  displayed as the  <<  character,  ^?  is 
  155.      displayed as the yen sign,  and ^= is displayed as character 
  156.      238. 
  157.  
  158. Buffer  Manipulation Commands allow the Ascii buffer to be  sent, 
  159.      received,  loaded, saved, and edited. NOTE: the Ascii buffer 
  160.      is only 32k big.
  161.  
  162. Buffer(BU):  The buffer command allows modifications to the Ascii 
  163.      buffer state. There are 5 sub-options:
  164.  
  165.      Option    Description                             Example
  166.      ------    -----------                             -------
  167.        R       Read a file into the buffer             BU R
  168.        W       Write the buffer to a file              BU W
  169.        S       Send the buffer                         BU S
  170.        O       Open the buffer to save incoming text   BU O
  171.        C       Close the buffer to incoming text       BU C
  172.           NOTE:  both Read and Write supply the default extension 
  173.           of .ASC. GTP will always ask for the filename.
  174.      The Send option will send the buffer out continuously, or it 
  175.      will wait for a character between lines (e.g.  BU S W>  will 
  176.      send the buffer waiting for a > between each line).
  177.  
  178. Edit(ED):  Edits whatever is currently in the Ascii buffer.  If a 
  179.      filename  is  given it is loaded into the Ascii  buffer  and 
  180.      edited (e.g.  "ED MES1"). The editor is a simple full screen 
  181.      editor with the following key-commands:
  182.  
  183.      Key       Command
  184.      ---       -------
  185.      Up-Arrow  Go up a line
  186.      Down Arrow Go down a line
  187.      PgUp      Go up a page
  188.      PgDn      Go down a page
  189.      Left      Move cursor left
  190.      Right     Move cursor Right
  191.      Home      Move cursor to column 1
  192.      End       Move cursor to the end of the current line
  193.      Ins       Turn insert mode on and off
  194.      Del       Delete character under cursor
  195.      Backspace Delete character before cursor
  196.      Control-Y Delete line
  197.      Tab       Tab  to  next position (Tabs are set with the  Tab 
  198.                command
  199.      ESC, or Shift  tab  exits  the editor  and  returns  to  the 
  200.                command mode.
  201.  
  202. Miscellaneous  commands allow the review of the past 15  screens, 
  203. the  tabs  to be set,  a file to be uploaded or  downloaded  with 
  204. xmodem, etc.
  205.  
  206. Review(RV):  Review  switches to the review screen and  lets  you 
  207.      page through the past 15 screens that have been received. If 
  208.      you  wish to save the screens enter "RV W" and GTP will  ask 
  209.      for  a filename (the default extension of .RV is  supplied). 
  210.      To  exit  from  the review mode press any  non-function  key 
  211.      (e.g. ESC, ENTER, spacebar, A-Z, 0-9, etc.).
  212.  
  213. Xmodem Upload(XU):  Sends the specified file to the remote system 
  214.      using   the  Xmodem  file  transfer   protocol.   (e.g.   XU 
  215.      FILES.ARC).  NOTE: The communications parameters MUST be set 
  216.      at 8 data bits.
  217.  
  218. Xmodem Download(XD):  Receives the specified file from the remote 
  219.      system  using the Xmodem file transfer  protocol.  (e.g.  XD 
  220.      FILES.ARC).  NOTE: The communications parameters MUST be set 
  221.      at 8 data bits.
  222.  
  223. Tabs(TA):  Sets the tabs for the editor, and Control I expansion. 
  224.      The tabs MUST be given in ascending order (e.g. Tabs 5 10 15 
  225.      20 25).  Entering just Tabs with no numbers will display the 
  226.      current settings.
  227.  
  228. Echo(EC):  Changes  the echo state.  The state can be any of  the 
  229.      following: None (no echo anywhere..full duplex), Local (only 
  230.      local  characters are echoed..half duplex),  Split (a  split 
  231.      screen  arrangement) and Remote (characters are also  echoed 
  232.      back to the remote system..host).  Only the first  character 
  233.      of each is required.  For the Split setting,  the bottom two 
  234.      lines  are  the  input buffer.  Nothing is  sent  until  the 
  235.      [RETURN]  key is pressed (also sending a RETURN at the  end) 
  236.      or  the  s[END] key is pressed (NOT sending a RETURN at  the 
  237.      end).  [ESC]  will clear the input buffer,  and  [Backspace] 
  238.      will erase the previous character.
  239.  
  240. Auto Line  Feed(AU):  Changes  the Automatic line feed state.  If 
  241.      the received lines seem to be printing on top of one another 
  242.      Enable  the  auto line feed.  (e.g.  AU E enables and  AU  D 
  243.      disables the line feed)
  244.  
  245. Ansi(AN):  Enables or Disables the Ansi driver within GTP. If the 
  246.      remote  system sends IBM compatable Ansi codes enable  Ansi. 
  247.      If it doesn't disable Ansi.
  248.  
  249. Timer(TI):  Changes  the  timer value.  The timer can  either  be 
  250.      Elapsed or Of day (e.g. Timer Elapsed, or Timer Of).
  251.  
  252. Help(HE):  This command will give you help on any of the commands 
  253.      that GTP uses.  Typing Help with no parameters will list all 
  254.      available commands.  Specifying a command after will display 
  255.      the help text for that command.  NOTE: The file GTP.HLP must 
  256.      have  been  available when GTP was booting up (in  the  same 
  257.      directory).
  258.  
  259. Colors(CO): Sets the foreground and background attributes for the 
  260.      display  (ONLY works on PCjr,  although may work on  systems 
  261.      with an EGA card).
  262.  
  263. Video Conferencing(VC):  Switches  to the Video conference  mode. 
  264.      You MUST specify an ICON library file the first time you use 
  265.      it (e.g. "VC PC-VCO.FLB"). This mode is similar to the Echo-
  266.      Split mode (the bottom two lines are the output buffer).
  267.  
  268. Other items about GTP:
  269.      The  current  line status is always being displayed  on  the 
  270. command  screen (Carrier Detect,  Ring Indicate,  Data Set Ready, 
  271. Clear to Send,  and Break Detect).  Shift-Tab or Home will switch 
  272. from terminal screen to command screen.
  273.