{
                     {THE SCRIPT COMPILER - OVERVIEW
                     {==============================
{
{  Introduction
{  ============
{
       The LANtastic for TCP/IP Script Compiler enables you to write
       automated procedures, or "scripts," for LANtastic for TCP/IP
       terminal sessions.

       {Note...}     The Script Compiler may be run only from Windows(R).

       You can write scripts to automate most procedures that you would
       normally perform by typing in commands and responses at the
       keyboard.

       For example, you could write a script that will automatically
       connect you to a UNIX or VMS system or IBM mainframe, supply your
       username and password, check if you have any mail, and start up an
       application for you.  Or a script could connect you to a remote
       host, start up an application, and perform tasks there for you
       while you do something else.

       You could also use a script to execute menu command sequences that
       you use often (as long as choosing the menu command is done by 
       typing a certain letter or word, and not by selecting it with the
       mouse).

       In some corporate environments, the system or network
       administrators may be assigned the task of writing and distributing
       scripts to end users.  Then you can use these scripts to access
       remote applications without having to know where the applications
       reside or how to start them.

       Before you can run a script:

           o You must first write a script and then compile it.

           o It is recommended that you use the Script Compiler editor
             because you can write your script input file, then compile
             it from within the Script Compiler application.

           o You can also use a text editor such as VI on a UNIX or DOS
             system, EDT on a VMS system, XEDIT on a VM system, or the
             Windows Notepad utility.

{  Before You Begin
{  ================

       Before using the Script Compiler, you should be familiar with
       LANtastic for TCP/IP.  You should know how to connect to a remote
       host using the TELNET capability of LANtastic for TCP/IP.  You
       should also be familiar with Microsoft Windows.

       If you are familiar with BASIC or the DEC/VAX Digital Command
       Language (DCL), you will find that using the LANtastic for TCP/IP
       Script Compiler will be similar.

       This section contains instructions for the following tasks:

           o Use the Script Compiler menus.

           o Write a script input file by creating a new script or
             changing an existing one. A menu of Script Compiler commands
             makes it easy to enter your own variables and arguments into
             a command template, then insert the command line into your
             script file.

           o Compile your script input file. Menu selections are provided
             to enable you to store your script output files, or
             "executables," in non-default directories, as well as create
             new directories.  An Error Handler displays descriptive
             error messages for any syntax errors found while compiling.

           o Run scripts to perform automated log-in procedures, or run
             scripts to perform tasks automatically from within a terminal
             session.

{    Start the Script Compiler Application
{    -------------------------------------

           1. Open the "LANtastic for TCP/IP" window.

           2. Double-click on the "Script Compiler" icon. The "Script
              Compiler" window appears, with the menu bar at the top of
              the window.

              Refer to "The Script Compiler Menu Bar" below for
              information on the menu selections.

       For additional information on how to use the Script Compiler
       application, refer to the on-line Help. Select "Help" on the Script
       Compiler menu bar to display a list of help topics.

{  The Script Compiler Menu Bar
{  ============================

       You can access the functions that enable you to write and compile
       scripts by using the Script Compiler menu bar at the top of the
       Script Compiler window.  You can access the following menus from
       the menu bar:

           o File

           o Edit

           o Compile

           o Command

           o Window

           o Font

           o Help

       The Script Compiler menu selections and brief descriptions of each
       command are given below.  For more detailed information on how to
       use the commands, refer to the COMMAND REFERENCE section of this
       on-line Update Manual.

{    File menu
{    ---------

       Use "File" menu options to open, close, print and save files. You
       can also invoke the menu selections by using accelerator keys.
       These are listed in parentheses immediately following the menu
       selections.

{    Edit menu
{    ---------

       Menu Selection         Description
       --------------         -----------

       Cut (Shift + Del)      Removes selected text so that you can paste
                              it into another script editor window or
                              another application.

       Copy (Ctrl + Ins)      Makes a copy of text you selected so that
                              you can paste it elsewhere.

       Paste (Shift + Ins)    Places cut or copied text at the insertion
                              point in the script file.

       Clear (Del)            Deletes the selected text; if no text is
                              selected, the character to the right of the
                              cursor is deleted.  If you use "Clear" to
                              delete text, you cannot paste the text into
                              another script window or into the same
                              window.

{    Compile menu
{    ------------
  
       Menu Selection         Description
       --------------         -----------

       Compile (G)            Translates your script into an executable
                              file.

       Select Output
       Directory...           Allows you to specify the directory that
                              will contain the compiled script.

       Next Error (1)         When the compiler finds errors in the
                              script, it highlights the next error message
                              and the line in the script file that
                              contains that error.

       Previous Error (2)     When the compiler finds errors in the
                              script, it highlights the previous error
                              message and the line in the script file that
                              contains that error.

{    Command menu
{    ------------

       The "Command" menu provides a list of Script Compiler commands.
       When you select a command a dialog box appears, showing you the
       syntax of the command. You can enter your variables and values into
       the fields on the dialog box, then add the customized command line
       to your script input file.  Below is a table which provides brief
       descriptions of all the Script Compiler commands.

       For more detailed information on the script compiler commands,
       refer to the COMMAND REFERENCE section of this on-line Update
       Manual.

       Menu Selection         Description
       --------------         -----------

       APPEND                 Appends a string to a previously-defined
                              string variable.

       ASSIGN                 Assigns a value to a string or number
                              variable.

       CALL                   Calls another script and, optionally, passes
                              arguments to it.

       ECHO                   Displays contents of a string or integer
                              variable; also, echoes a string or integer
                              constant.

       EXIT                   Tells the script to end.

       FIND                   Checks to see if a string variable contains
                              a particular string.

       GETSTRING              Copies data coming in from the remote host
                              into a string variable.

       GOTO                   Transfers control (or jumps) to a statement
                              other than the next statement in the script.

       IF...THEN...
       ELSE...  ENDIF         Evaluates a conditional expression.

       INQUIRE                Accepts a string from the user at execution
                              time and stores it in a string variable.

       LABEL                  Marks the statement that follows it.  Used
                              by GOTO.  You can use up to a maximum of 20
                              labels in a script.

       LET                    Used to perform integer arithmetic, such as
                              addition, multiplication, division, and
                              subtraction.

       MOVECURSOR             Moves the cursor to a specified position.
                              Used in conjunction with READ and
                              READ_FROM_SCREEN.

       NUM                    Declares a number and optionally initializes
                              it at the same time.

       READ                   Searches the screen buffer for a specified
                              string.

       READ_FROM_SCREEN       Copies a string from the screen buffer into
                              a string variable.  Similar to GETSTRING.
                              Used with MOVECURSOR.

       SEND                   Sends a string variable or a string to the
                              remote host.

       SENDKEY                Sends a particular escape sequence or
                              control-key to the host; for example,
                              VT_PF1, TN_TAB, or CTRL_C.

       STRING                 Declares a string and, optionally,
                              initializes it at the same time.

       WAIT                   Waits for the specified time interval
                              (specified in minutes, seconds, and
                              hundredths of seconds).

       WAITFOR                Examines incoming data from the remote host
                              until it matches a user-specified string, or
                              a user-specified timeout value is reached.

       #                      Used to designate a comment line for program
                              documentation purposes only.  A line
                              beginning with "#" will be ignored by the
                              Script Compiler.

{    Window  menu
{    ------------

       Menu Selection         Description
       --------------         -----------

       Tile                   Resizes and displays all currently open
                              script input file windows side by side (and
                              above and below) each other so that all
                              windows are completely visible.

       Cascade                Places all currently displayed, open script
                              input file windows one behind the other, but
                              slightly offset, so that all title bars of
                              all windows are visible.

       Arrange Icons          Displays all condensed icons neatly inside
                              the main window.

       List of open
       script input files     Displays all open script input files
                              including their full pathnames.  You can
                              bring a file window to the top by selecting
                              it in this list.

{    Font menu
{    ---------

       Menu Selection         Description
       --------------         -----------

          Normal
          Bold                Contains a list of fonts, style attributes
          .                   and point sizes in which to display your
          .                   script input files.  Also has menu
          Helvetica           selections for stroke fonts and raster
          Courier             fonts and font sizes from 6 to 72 points
          .
          .
          6 pts through
          72 pts

{    Help Menu
{    ---------

       To display a list of help topics and descriptions on the Script
       Compiler, select "Help" from the Script Compiler menu bar.

{  Script Compiler Operations
{  ==========================

       This section lists things you can do with the Scripting Language.
       Refer to the COMMAND REFERENCE section of this on-line update
       manual for command and syntax descriptions.

{    Variables, Constants, System Variables and Key Sequences
{    --------------------------------------------------------

           o You can define and initialize string and integer variables
             for use in the script with the {string} and {num} commands.

           o You can define up to a maximum of 20 variables in a script.

           o You can use certain predefined system variables and key
             sequences with certain commands.  For example, the
             {SYS_USERNAME} system variable stores the username, and the
             {TN_PF18} key sequence represents the PF18 key on a TN3270
             keyboard.

{    Actions
{    -------

           o You can send a string or special key function to the remote
             host with the {send} and {sendkey} commands.

           o You can have your script wait until you receive a particular
             string from the remote host with the {waitfor} command.

           o You can use {getstring} or {read_from_screen} to store
             information sent by the remote host into a string variable.

           o You can read a string from the screen buffer into a variable
             with the {read_from_screen} command.

{    String Manipulation and Integer Arithmetic
{    ------------------------------------------

           o With the {let} and {assign} commands, you can assign, add,
             multiply, subtract and divide integer variables.

           o You can perform string concatenation with the {append...to}
             command.

           o You can find out if a particular string is contained inside
             a string variable with the {find...in} command.

           o The script compiler allows maximum and minimum integers of
             32767 and -32768.

{    Flow Control
{    ------------

           o You can transfer control unconditionally to another place in
             the current script with the {goto} and {label} commands.

           o You can evaluate a condition and transfer control to
             different places in the script based on the outcome of the
             condition with the {if...then...else...endif} command.

           o You can transfer control to another script with the {call}
             command.

{    Interactive Commands
{    --------------------

           o Echo the contents of a string or integer variable to the
             screen with the {echo} command.

           o Prompt the user to type in a string and store the string
             in a string variable with the {inquire} command.

{    Miscellaneous Commands
{    ----------------------

           o You can have your batch files pause for an amount of time
             specified with the {wait} command.

           o The {movecursor} command moves the cursor to a specified
             location on the screen.

           o Add comments by starting a line with the {#} symbol.

{    General Conditions
{    ------------------

           o The maximum length a token can be is 134 characters.

           o You can use blank lines anywhere in a script.
