             Ozterm Version 6 User Guide TP1282 Issue 3

                (For OZTERM Version 6.20 or later)
                                   
                               CONTENTS

1.  INTRODUCTION
     1.1  GENERAL DESCRIPTION
     1.2  BRIEF OVERVIEW
     1.3  DOCUMENT LAYOUT

2.  GETTING STARTED
     2.1  HARDWARE REQUIRED
     2.2  FILES REQUIRED
     2.3  SOFTWARE INSTALLATION
     2.4  STARTING OZTERM
     2.5  CONNECTING TO TELEPHONE EXCHANGES
     2.6  INSTALLING THE EXTERNAL DEVICE DRIVER

3.  USER INTERFACE
     3.1  MENU SYSTEM
           3.1.1  Menu Contents
     3.2  USING PULL DOWN MENU
     3.3  WINDOWS
           3.3.1   Main screen.
           3.3.2   Command History Window
           3.3.3   Function Key Label Window:
           3.3.4   Monitor Second port window
           3.3.5   Module window
           3.3.6   Transmit file window (Alt I).
           3.3.7   Screen Layout
     3.4  TERMINAL COMMUNICATIONS
     3.5  PROMPTS
     3.6  KEYBOARD 
           3.6.1   Key Allocation (listed alphabetically)
           3.6.2   File Manager and View/Editor Keys
           3.6.3   Command History Keys
     3.7  STRING INPUT FIELDS
     3.8  ABORT or CANCEL

4.  FILE MENU
     4.1  GENERAL DESCRIPTION
     4.2  FILE MENU - (Alt F)
           4.2.1   View/Edit (Alt F, V or Alt E)
           4.2.2   DOS Gateway
           4.2.3   File Transfer
           4.2.4   eXit Program

5.  SETUP MENU
     5.1  GENERAL DESCRIPTION
     5.2  SET UP MENU - (Alt S)
           5.2.1   Function keys
           5.2.2   TeXt Events
           5.2.3   TiMe Events
           5.2.4   Borders
           5.2.5   BEll
           5.2.6   Overwrite (Alt O)
           5.2.7   Toggle Port Mode (Alt T)
           5.2.8   AOM Password
           5.2.9   sYs 12 password
           5.2.10  Screen Timeout
           5.2.11  Keyboard Timeout
           5.2.12  Printer
           5.2.13  Printer formfeed
           5.2.14  Edit Auto Dial List

6.  PORTS MENU
     6.1  GENERAL DESCRIPTION
     6.2  PORTS MENU - (Alt P)
           6.2.1   Select Ports/Mode/Speed
           6.2.2   Port Test
           6.2.3   Monitor 2nd Port
           6.2.4   Install Boards
     6.3  PORT MODES
     6.4  MULTIPLE OZTERM SESSIONS
           6.4.1   Introduction
           6.4.2   Example Multiple Session Telnet (Interrupt 14)

7.  LOGGING MENU
     7.1  GENERAL DESCRIPTION
     7.2  LOGGING MENU - (Alt L)
           7.2.1   Open Log File (Alt L, O)
           7.2.2   Close Log File (Alt L, C)
           7.2.3   View Log File (Alt L, V or Alt V)
           7.2.4   Printer on/off (Alt L, P or Ctrl F6)
           7.2.5   Status (Alt L, S)
     7.3  BACKGROUND LOGGING

8.  UTILITY MENU
     8.1  GENERAL DESCRIPTION
     8.2  UTILITIES MENU - (Alt U)
           8.2.1   B no analysis
           8.2.2   List corrections
           8.2.3   Hex Calculator (Alt C)
           8.2.4   Restart Monitor
           8.2.5   General Utilities  (Alt G)
           8.2.6   Write CMD History to File
           8.2.7   Copy File to CMD History

9.  ACTION MENU
     9.1  GENERAL
     9.2  ACTION MENU - (Alt A)
           9.2.1   Autodialling
           9.2.2   Logon (Alt A, L or Ctrl F2)
           9.2.3   Logoff (Alt A, O or Ctrl F3)
           9.2.4   Interrupt Print-out (Alt A, I or Ctrl F10)
           9.2.5   Hard Break (Alt A, H or Ctrl F9)
           9.2.6   Release Modem/NASI(Alt A R or Alt F9)
           9.2.7   Send ESC (Alt A, S or Alt K)

10. MODULES MENU
     10.1 GENERAL DESCRIPTION
     10.2 MODULES MENU - (Alt M)
           10.2.1  Command description (Alt M, C or  Alt B)
           10.2.2  Fault Codes (Alt M, F or Alt B)
           10.2.3  Print-out Description (Alt M, P or Alt B)
           10.2.4  Index of Commands (Alt M, I)
           10.2.5  Index of Print-outs (Alt M, X)
           10.2.6  Directory for B Module (Alt M, D)

11. TRANSMIT MENU
     11.1 GENERAL DESCRIPTION
           11.1.1  Selecting a Transmit File
           11.1.2  Execute The Transmit File
           11.1.3  Special Transmit File Notes
     11.2 TRANSMIT FILE DESCRIPTION
     11.3 TRANSMIT MENU - (Alt I)
           11.3.1  New Transmit File (Alt I, N)
           11.3.2  Close Transmit File (Alt I, C)
           11.3.3  Auto Execute (Alt I, A)
           11.3.4  Single step (Alt I, S, or Alt N)
           11.3.5  Off-Line Test (Alt I, O)
           11.3.6  Window Open (Alt I, W)
           11.3.7  Window Hide (Alt I, H)
           11.3.8  Goto Label (Alt I, G)
           11.3.9  Find Text (Alt I, F)
           11.3.10 Repeat Search (Alt I, R)
           11.3.11 Find Line Number (Alt I, L)
           11.3.12 Edit Transmit File (Alt I, E)
           11.3.13 waTch Variable (Alt I, T)
           11.3.14 Program Trace (Alt I, P)

12. SCREEN MENU
     12.1 GENERAL DESCRIPTION
           12.1.1  Printing text to the printer
           12.1.2  Exporting Text to a file.

13. HELP MENU
     13.1 GENERAL DESCRIPTION
     13.2 HELP MENU - (Alt H)
           13.2.1  Help Keys
           13.2.2  Help Document

14. QUITTING OZTERM

15. DOS Command Line Parameters and Switches

16. Operation on Local Area Networks

17. OZTERM FILES
     17.1 OZDVR.REF  PORT Board Reference File
           17.1.1  Communication Board Type
           17.1.2  Device Driver Flag
           17.1.3  Logical Number of Ports
           17.1.4  Terminal Emulation Modes
           17.1.5  Baud Rates
           17.1.6  Default Disk Log File names
           17.1.7  Disk Logging at Power-up
           17.1.8  Essnet
     17.2 AUTODIAL.OZI  AUTODIAL Reference File
     17.3 OZTERM.DFT  OZTERM Entry/Exit File
     17.4 OZTERM.STO  OZTERM Screen Timeout File
     17.5 OZ******.CAT  SUBSCRIBER Category Files
     17.6 OZTERM.IOP  Dangerous Command Files
     17.7 OZENCODE.COM  OZTERM Transmit File Encoder

18. TRANSMIT FILE SCRIPT LANGUAGE
     18.1 GENERAL DESCRIPTION
     18.2 SCRIPT LANGUAGE OVERVIEW
     18.3 SCRIPT LANGUAGE COMMAND DESCRIPTIONS
     18.4 SCRIPT LANGUAGE FUNCTION DESCRIPTIONS
     18.5 SCRIPT LANGUAGE COMMAND INDEX
     18.6 SCRIPT LANGUAGE FUNCTION INDEX.
     


                                   
                           1.  INTRODUCTION
                                   

1.1  GENERAL DESCRIPTION

     This  program  provides a fully featured terminal emulation  that
     will  communicate  with  AOM, AXE, ARE-11,  System-12,  System-12
     MPTMON,  ARF-C  and  other  telephone exchanges  in  the  Telstra
     Network.   It  has script file language for transmit  files,  log
     data to disk, and text file utilities.
     
     The  program  has a user interface that is consistent   with  the
     Standard Operating Environment  (SOE)  which has been adopted  by
     Telstra and many other organisations.  The program will run under
     MS Windows or DOS and has pull down menus.
     
     The  program  will  connect you to exchanges  over  a  number  of
     different  link  types  including  Dial  Up  Modems,  Local  Area
     Networks,  TCP/IP Sessions, Interrupt 14 Gateways  and  MDX  data
     communication switches.
     

1.2  BRIEF OVERVIEW

     OZTERM is a terminal communications program which provides :
     
     *  Communication with any one of the 16 ports, with modes for
        AOM, AXE-TW, AXE-IOG etc.  A session can be conducted on the
        currently selected port while print-outs are being logged from
        the current and the other ports.
     *  Up to 4500 lines of screen buffer (depending on memory
        available) with scrolling, string search, screen saving and re-
        loading etc.
     *  20 user defined Function keys are available.  ( F1 - F10 &
        shift F1 - shift F10).
     *  10 program defined function keys (Ctrl F1 - Ctrl F10).
     *  Text file facilities for viewing, editing, copying and
        printing files.
     *  B module access, B number analysis tracing, hexadecimal
        converter.
     *  Restart monitoring, with auto logging to unique file.
     *  Auto-dialling and Datagate log-on.
     *  Multiple port session operation over the Novell LAN using a
        remote asynchronous communications server or via a Telnet Int
        14 interface.
     *  Telephone exchange can be accessed via ESSNET.
     *  Advanced transmit file script language.
     *  Ability to select 2 ports (provided OZDVR is installed)
        concurrently.  One in the foreground and the second displayed
        in the Monitor Window.
     *  Text Triggered and Time Triggered events.
     *  File transfer using ASCII or Xmodem protocol.
     *  On Screen password security in the Setup Menu.
     *  Printer selection.
     *  Read and write command history stack facility.
     *  Transmit file Watch variable and Program trace debugging
        facilities.
   

1.3  DOCUMENT LAYOUT

          Section 2 and 3 of this document explain how to initially
          set up OZTERM and a basic description of all the Menu
          choices, files and Key functions.
          Sections 4 - 13 give a detailed explanation of the 10 pull
          down Menu choices.
          Section 14 - 18 explain the additional facilities offered by
          OZTERM.
          Appendices A - D contain additional information regarding
          the setup of your environment and the Standard script files.
                                   
 

 
                          2.  GETTING STARTED
                                  

2.1  HARDWARE REQUIRED

     Recommended system requirements are:
     
          IBM PC/AT or compatible.
          640K memory.
          IBM Monochrome, EGA or VGA graphics card.
          Hard Disk or file server.
          A floppy disk drive.
          MS DOS version 3.2 or later, or MS Windows Operating System.
     
     
     OZTERM  may  be  configured  to use a variety  of  communications
     hardware.    Up  to  16  ports  may  be  configured  within   the
     restriction of a maximum of 4 interrupt (IRQ) lines.  Some of the
     port types supported are :
     
          Standard IBM asynchronous COM1 - COM4 hardware.
          1  or  2  "HS-4" or COM4 four port serial cards.  This  card
          uses 2 interrupts for 4 ports.
          1 or 2 "ARNET Multi-port 8" eight port serial cards.    This
          card uses 1 interrupt for 8 ports.
          Multiple   session   NASI  interface  to   an   asynchronous
          communications server via a NOVELL LAN.
          TCP/IP sessions using the NASI port setup.
          Multiple session Telnet interface to a file server, eg EICON
          Gateway.
     
     
     Refer  to  the  Appendix D (OZTERM Multiport Board Configuration)
     showing   configuration  details  for  a  variety  of  multi-port
     hardware.
     
     
     Various  communication cards have different port  I/O  addresses.
     The standard IBM PC serial ports are configured as follows :-
     
   Physical Port  I/O Address   IRQ
        COM1        3F8h         4
        COM2        2F8h         3
        COM3        3E8h         4
        COM4        2E8h         3
     
     Where the Background Logging feature and/or the Monitor 2nd  Port
     feature is required, the external device driver must be added  to
     the  CONFIG.SYS  file  (See the section Installing  the  External
     Device Driver).
     
     
     Notes :
     
     1.   Other multi-port cards to those listed may also be used.
     2.   A combination of port configurations may be used provided no
          hardware conflicts occur.
     3.   Ozterm may be configured to use any IRQ between 1 and 7 for
          serial port hardware.
     4.   Ozterm may be configured to use any IO port base address for
          serial port hardware.
     5.   Ozterm provides a menu driven port configuration interface
          for common port configurations.
     6.   The OZDVR.REF file (refer Section 17) is a text file which
          may be edited to configure unusual port combinations.  The
          contents of this file MUST agree with the actual hardware
          configuration for the ports which Ozterm will use.
     7.   The NEC Powermate does not appear to "like" IRQ=2.
     
     

2.2  FILES REQUIRED

     File name      Usage
     
     In the Root Directory:
     CONFIG.SYS     Used  to install the Background device driver  (if
                    required).
     
     In the OZTERM Program Directory (eg F:\APPS\OZTERM):
     CMDS\*.CMD     Registered Script files.
     OZAPT06.CAT    AXE APT 06 Subscriber category file.
     OZAPT06C.CAT   AXE APT 06 with CCR Subscriber category file.
     OZAPT08.CAT    AXE APT 08 Subscriber category file.
     OZAPT08C.CAT   AXE APT 08 with CCR Subscriber category file.
     OZARE14.CAT    ARE-11 Revision 14 Subscriber category file.
     OZARE15.CAT    ARE-11 Revision 15 Subscriber category file.
     OZBNUM.UTL     AXE B Number Analysis Utility
     OZDVR.COM      Background Device driver
     OZGENRL.UTL    General Application Utility, eg Local Application
     OZLCOR.UTL     AXE List Corrections Utility
     OZTERM.EXE     Main program
     OZTERM.ICO     MS-Windows Icon file.
     OZTERM.MSG     Used in conjunction with OZTERM.EXE program.
     OZTERM.TXT     Help Text file.
     OZENCODE.COM   OZTERM Script file Encoder.
     
     In the users OZTERM Working Directory (eg H:\OZTERM):
     AUTODIAL.OZI   Autodial data save file
     LOCAL.DAT      Initialise Global Variables
     OZDVR.REF      Port configuration Reference file
     OZEVENTS.OZI   Time and Text events save file.
     OZPARAMS.OZI   General configuration save file, eg lB-module,
                    screen Time-out, function keys etc.
     OZSCREEN.SVE   Screen and command stack save file.
     OZTERM.DFT     Entry/Exit Script file that runs on entry and exit
                    of the program.
     OZTERM.STO     Screen  Time-out transmit file that runs  whenever
                    the screen times out.
     
     In the OZTERM B-Module Directories (eg F:\APPS\DOCS\29V00):
     OZTERM.IOP     IOP Dangerous commands file.


2.3  SOFTWARE INSTALLATION

     To INSTALL OZTERM
     
     Insert the OZTERM Program disk into a floppy disk drive, and make
     that drive the default drive.
     
          eg     A:
     
     At the DOS prompt type INSTALL d:path.  Where d: is the disk
     drive and path is the base directory that the program is to
     reside in.
     
          eg     INSTALL C:
     
     This will copy ALL the OZTERM program files to the drive and
     directory C:\OZTERM.  For additional information refer to
     Sections 6 and 17, and APPENDIX  D.
     
     Next insert the OZTERM Support files disk in the floppy disk
     drive and type in the same Install command with the same drive
     and path parameters.  For example:
     
          eg     INSTALL C:
     

2.4  STARTING OZTERM

     OZTERM saves the configuration information in the directory in
     which it was started.  This allows the OZTERM Program files to
     reside on a file server (if required) while allowing each
     operator to maintain their own configuration and save files.  It
     is recommended that a batch (xxx.BAT) and program information
     file (xxx.PIF) (if running from Windows) be set up to run OZTERM.
     There are several sample files included with the Support files
     disk for operating in a stand-alone PC or LAN environment.  This
     file should set the working directory to the operators OZTERM
     working directory, and then invoke the OZTERM program.  OZTERM
     does not have to be installed on the program search path.
     
     When starting OZTERM for the first time (ie. no save files exist
     in the working directory) the user is prompted for configuration
     information to set-up the hardware port allocation.  These can be
     altered at any time later by using the Ports Menu options.
     
     At the DOS  prompt type the following and press ENTER (assuming
     that OZTERM was installed in the \OZTERM directory, and that this
     directory is also to be the working directory):-
     
          CD \OZTERM
          OZTERM
     

2.5  CONNECTING TO TELEPHONE EXCHANGES

     For connection to telephone exchanges via Transmit files, refer
     to the text files OZSETUP.TXT, INSTALL1.TXT and INSTALL2.TXT.
     

2.6  INSTALLING THE EXTERNAL DEVICE DRIVER

     The  external device driver provides facilities to log data being
     received  on ports which are not currently being used by  OZTERM.
     This  driver can be configured to log data even after OZTERM  has
     been terminated.
     
     In  addition,  OZTERM has a facility to interact  with  one  port
     while simultaneously monitoring a second port on the screen.
     
     To  use  these  facilities, the external device  driver  must  be
     installed.  This is done by inserting the following lines in  the
     CONFIG.SYS file.
     
     FILES=20
     DEVICE=C:\OZTERM\OZDVR.COM R=C:\OZTERM\OZDVR.REF
     
     The line specifying the FILES=20 is the minimum value for this
     parameter.  Higher values may be specified.  It is essential that
     the device driver use the same reference file as that which
     OZTERM itself will use.  OZTERM will always use the reference
     file from the working directory (ie. the directory from which the
     operator invokes the OZTERM program).
     
     Note that the device driver may be loaded into high memory if you
     are using DOS V5.0 or later.  This is done by replacing the
     DEVICE statement with DEVICEHIGH in the CONFIG.SYS entry which
     installs the driver.  Note that the HIMEM.SYS driver must be
     loaded before the OZTERM driver if loading high.
     
     For more information regarding the configuration of the reference
     file (OZDVR.REF) please refer to Section 7.3.
                                   



                          3.  USER INTERFACE
                                   

3.1  MENU SYSTEM

     3.1.1  Menu Contents
     
          Access the menu system by pressing the "Home" key and using
          the cursor control keys to step across the screen to the
          required menu choice, or by pressing the "Alt" key plus the
          highlighted letter of the menu name (eg "Alt P" for the
          PORTS menu). Use the left and right arrows or "Home" to move
          between adjacent menus.
          
          
        3.1.1.1 FILES  -  (Alt F)
          
          Ŀ
          View/Edit      Alt/E  Access to the File Manager and
                                editor functions.
          DOS gateway           Access to a DOS shell.
          File Transfer         Access to the File transfer menu,
                                with ASCII file sending and
                                XMODEM send and receive.
          eXit program   Alt/X  Exit the program.
          Ĵ
          OZTERM 6.20(GAR)      Program Version information.
          14/09/95 15:01:48     Current PC Date and Time.
          1000 lines            Number of lines in the main
                                screen buffer.
          Memory=160k           Amount of conventional DOS memory
            available.
          
          
        3.1.1.2 SET-UP  -  (Alt S)
          
          Ŀ
          Function keys           Access to Function key
                                  programming screen.  Alt F10
                                  displays Function key Labels.
          teXt Events             Access to the Text Event
                                  programming screen.  When a
                                  print-out matching the required
                                  text is received an associated
                                  transmit file is activated.
          tiMe Events             Access to the Time Event
                                  programming screen.  At a
                                  scheduled (pre set) time an
                                  associated transmit file is
                                  activated.
          Borders       ON        Turn the Main Screen Vertical
                                  borders on/off.
          bEll          OFF       Turn the activity/alert sound off.
          Overwrite     OFF Alt/O Main Screen Overwrite on or off.
          Toggle port modes Alt/T Toggle between two emulation modes.
          AOM Password            Set AOM password.  Note only
                                  *'s are displayed in the
                                  window.
          sYs 12 password         Set System-12 password. Note
                                  only *'s are displayed in the
                                  window.
          Screen Timeout 05 Min   Screen saver Timeout in minutes
                                  (a value of 0 means no screen
                                  Timeout).  Note this runs the
                                  OZTERM.STO file if in the
                                  current directory.
          Keyboard Timeout 05 Sec Set keyboard Timeout in
                                  seconds.  The length of time
                                  that a pending Time Event will
                                  wait for no keyboard activity
                                  before running.  A value of 0
                                  means a Time Event will run
                                  immediately.
          pRinter          LPT1   Set printer port.
          prInter formfeed  ON    Turns printer formfeed on/off
                                  for the end of the print.
          Edit Auto Dial List     Edit AUTODIAL.OZI file.
          


        3.1.1.3 PORTS  -  (Alt P)
          
          Ŀ
          Select            Access to port select and temporary
          ports/mode/speed  change menu.
          port Test         Port test (Dumb Terminal) Mode
          Monitor 2nd port  Opens top window to display port
                            activity on a second port.
          Install boards    Permanent Port configuration change
            menus
          
          
        3.1.1.4 LOGGING  -  (Alt L)
          
          Ŀ
          Open  logfile           Open a disk log file on the 
                                  current port.
          Close logfile           Close a disk log file on the 
                                  current port.
          View logfile     Alt/V  Open Log file on current port 
                                  in View mode.
          Printer on/off Ctrl/F6  Toggle Printer logging on or 
                                  off on current port
          Status                  Status of the data logging 
            function on all ports.  May be 
                                    used to reset port hardware.
          
          
        3.1.1.5 UTILITY  -  (Alt U)
          
          Ŀ
          B no analysis             AXE B number analysis trace
          List corrections          Prints AXE Program
                                    corrections.
          Hex calculator     ALT/C  Signed Hexadecimal/Decimal
                                    calculator
          Restart monitor           Monitors the ports for AXE
                                    Restart Data.
          General Utilities  ALT/G  Runs Local application
                                    functions.
          Write CMD History to File Writes the Command history
                                    stack to a file defined by
                                    the operator.
          Copy File to CMD History  Reads a Selected file into
           the Command History stack.
          
          
        3.1.1.6 ACTION  -  (Alt A)
          
          Ŀ
          Auto-dialling              Opens the AUTODIAL.OZI file
                                     menu.
          Logon              Ctrl/F2 Executes the Logon function
                                     for the current Terminal
                                     Emulation selected.
          logOff             Ctrl/F3 Executes the Logof function
                                     for the current Terminal
                                     Emulation selected.
          Interrupt printout Ctrl/F1 Sends a printout interrupt 
                                     to the current port.
          Hard break      Ctrl/break Sends a Break to the current
                                     port.
          Release Modem/NASI  Alt/F9 Sends a DTR Break to the
                                     Current port.
          Send ESC             ALT/K Sends the ESC Control
           character on the current port.
          
          
        3.1.1.7 MODULES  -  (Alt B or Alt M to access)
          
          Ŀ
          Command description  Request Command description from
                               Module.
          Fault codes          Request Fault code description from
                               Module.
          Printout description Request Printout description from
                               Module.
          Index of commands    Request Index of Command from
                               Module.
          IndeX of printouts   Request Index of Printouts from
                               Module.
          Directory for B Mod. Select the Module Path for a Port.
          

        3.1.1.8 TRANSMIT files, for loading data changes, etc. - (Alt I)
          
          Ŀ
          New Transmit file   New Transmit file select menu.
          Close Transmit file Close the current transmit file.
          Auto execute        Run the selected transmit file.
          Single step         Step through the transmit file one line
                              at a time.
          Off-line test       Run the transmit file without any port
                              communications.
          Window open         Open the transmit file window.
          window Hide         Hide the transmit file window.
          Goto Label          Go to a Label within the transmit file.
          Find text           Search for text within the transmit
                              file.
          Repeat search       Repeat text search.
          find Line no.       Go to a particular line number in the
                              transmit file.
          Edit Transmit file  Edit the current transmit file.
          waTch Variable      Display a variables value on line one of
                              the Main screen.
          Program Trace       Write all transmit file steps to a text
           file.
          
          
        3.1.1.9 SCREEN - (Alt R can use Ctrl K or Ctrl Q in block mode)
          
          Ŀ 
          Block START          Mark the start of a text block.
          K mark END           Mark the end of a text block.
          Write block          Write the block of text to a file.
          Print block          Send the Block of text to the
                               printer.
          Hide block           Remove the start and end markers.
          Find text            Search forward for text on the main
                               screen.
          Repeat find          Repeat search.
          Last commands        Open Command history stack window.
          Q send          ^Q   Send Control Q to the current port.
          S send          ^S   Send Control S to the current port.
          Y delete        ^KY  Delete the block of text from the
          block                main screen.
          ^Block START    ^KB  Mark the start of a text block.
          ^Kmark END      ^KK  Mark the end of a text block.
          ^Write block    ^KW  Write the block of text to a file.
          ^Print block    ^KP  Send the Block of text to the
                               printer.
          ^Find text      ^QF  Search forward for text on the main
                               screen.
          ^Repeat find    ^L   Repeat search.
          ^Q send         ^Q   Send Control Q to the current port.
          ^S send         ^S   Send Control S to the current port.
          ^Y delete block ^KY  Delete the block of text from the
            main screen.
                             
                             
        3.1.1.10  HELP  -  (Alt H)
          
         Ŀ 
         Keys   Display of all the "Hot Keys".
         Doc.   Open OZTERM.TXT in View file mode.
         

3.2  USING PULL DOWN MENU

     To select a menu:

          Access the menu system by pressing "HOME" and using the
          cursor control keys to step to the required menu choice.  Or
          Press the ALT key and the Highlighted letter of the Menu
          option shown across the top of the screen. (eg "Alt P" for
          the PORTS menu).
     
     To move between menus:

          Use the left and right arrows or "HOME" to move between
          adjacent menus.
     
     To select an option:

          Press UP/DOWN Arrow keys to highlight the required option,
          then press ENTER to select the item.  Alternatively the
          highlighted letter in the Menu option can be pressed.
     
     To cancel a menu without choosing a command:

          Press ESC key


3.3  WINDOWS

     There are 6 basic windows used in OZTERM:
     
          The Main screen;
          Command history stack window;
          Function Key Label window;
          Monitor Second port window;
          Module window; and
          Transmit file window.
     
     To exit from any window except the Main screen, press the ESC
     key.
     
     
     3.3.1  Main screen.
     
          This displays all communication with the host exchange.  The
          Control key sequences used to edit the screen (eg Control K
          B to mark the start of a block of text) do not apply when in
          Full Duplex or Half Duplex modes as all codes are sent to
          the port as the keys are pressed.  Use the Screen Menu (Alt
          R) to access these functions when in Full Duplex or Half
          Duplex modes.
          
          Editing Main Window
          
               Mark top of block       Alt R, B or  Ctrl K, B
               Mark bottom of block    Alt R, K or  Ctrl K, K
               Write block to file     Alt R, W or  Ctrl K, W
               Print block             Alt R, P or  Ctrl K, P
               Hide Block              Alt R, H or  Ctrl K, H
               Search for text         Alt R, F or  Ctrl K, F
               Repeat search           Alt R, R or  Ctrl K, R
               Delete Block            Alt R, Y or  Ctrl K, Y
               

     3.3.2  Command History Window
     
          If the port is in a Exchange Terminal emulation mode, eg
          IOG11, each command sent to the host is added to the end of
          the command history stack (maximum of 64 commands, each line
          a maximum 255 characters long).  These commands can be re-
          entered through the  command history window.
          
             End Key      Toggles cursor between command history
                           window and the main screen.
             ESC Key      Closes the Command history window.
          
          With the cursor in the command history window:
               The Page Up and Page Down keys move through the Main
               screen.
               The Up, Down, Left and Right arrows scroll through the
               command history
               Shift Home and Shift End moves the cursor to the start
               and end of the line respectively.
               Commands may be edited in the command history while the
               Main screen is receiving information.
               The command may then be entered from the command
               history window.
          
          The commands in the Command History area may be accessed
          while using the main screen.  Commands recalled to the main
          screen may be edited before being dispatched to the host.
          
               Recall an earlier command  Shift Up arrow or Ctrl F4
               Recall a later command   Shift Down arrow or Ctrl F5
               
     
     3.3.3  Function Key Label Window:
     
          The Function Key Labels may be displayed in the bottom
          window by pressing Alt F10.  This will display whatever text
          is in the Label column for each Function key (Note F11 - F20
          is Shift F1 - F10).
          
     
     
     3.3.4  Monitor Second port window
     
          This window displays the data being received on a second
          port, other than the port currently selected in the
          foreground.
          
          The following keys are used with the Monitor Window:

               Alt F6     Toggle Printer on and off in the Monitor
                          window
               Alt F7     Page up in the Monitor window
               Alt F8     Page down in the Monitor window
               
     
     
     3.3.5  Module window
     
          This window displays the B module information that was
          requested either using Alt B or via the Module Menu (Alt M).
          
          Window Keys:

               Alt 2/1    Focus, ie move cursor to the Module window
                          or back to Main screen.
               Ctrl F7    Scroll up in the Module window
               Ctrl F8    Scroll down in the Module window
               Alt F7     Page up in the Module window
               Alt F8     Page down in the Module window
               Alt N      Toggles between Module Window display and
                          Full screen display.
               Enter      If full screen or Focus on Module window,
                          will open the Command or printout
                          description from the Index, or printout
                          description heading from a command
                          description.
               
          Focus:

               The cursor focus may be shifted to the B Module window
               by pressing Alt 2, or back to the Main screen by
               pressing Alt 1.  Closing the Module window will
               automatically move the cursor focus back to the Main
               screen.  When the cursor focus is on the Module window,
               the Up and Down arrows, and the Page Up, Page Down keys
               apply to the Module window instead of the Main screen.
               
          Full Screen Keys:

               When the Module window is full screen (ie Alt N) the
               Home and End, Up and Down Arrow, and Page Up, Page Down
               keys apply the Module screen.    The Text Search
               functions also work in this screen, that is:
               
               Alt F      Search forward for  text
               Alt R      Repeat previous search
               
     
     
     3.3.6  Transmit file window (Alt I).
     
          This window is used to manually control and monitor the
          execution of Transmit Script files.  It displays the current
          line number within the script file.  If a transmit file
          requires editing, the Transmit menu has an Edit option.
          When invoked via this menu, the editor opens the file and
          automatically positions the cursor at the current line in
          the script file.  Refer to Section 3.6.2 File Manager and
          View / Edit Keys for a description of the editing facilities
          available.
          
          This window may be hidden from view whilst the transmit file
          is running (see @HIDE Script Command), or overlayed with
          plain blue window which can be used to displayed Transmit
          file comments or other Script file functions such as DRAW,
          MENU and FORM (See Section 18 for more information).
          
          
     3.3.7  Screen Layout
     
   Line No.
       Ŀ
     1  Info Bar/ Hidden Menu/ Ctrl keys function/ waTch Variable
     2 Ĵ
                Monitor / Module / Transmit file window          
                                                                 
                  Display with Alt I / Alt B / Alt P             
                   Close with Alt I, H, or C or ESC              
                                                                 
     8 Ĵ
                                                                 
                                                                 
                                                                 
                              Main Screen                        
                                                                 
                                                                 
                                                                 
                                                                 
                                                                 
       Ĵ
    19        Command History / Function Key Label Window        
                                                                 
                    Display with End key / Alt F10               
                          Close with ESC key                     
                                                                 
    24 Ĵ
    25                        Status Line                        
       

      Note that only one of windows (Monitor, B Module, Transmit, or
      Command History, Function Key) may be open (displayed) at a
      time.
      
      The program has ANSI cursor addressing capabilities with 80
      column screen.  Note that information received from the host
      wider than this will be wrapped onto the following screen lines.
      If the same data received is logged to a file, the text will
      appear on a single line, if less than 255 characters long.
      
      Status Line - The status line applies to the current port and
      displays:
          
    Ŀ
    Field 1Field 2 Field 3 Field 4Field 5Field 6Field 7Field 8
    Ĵ
     Host   Speed EmulationDuplex  Mode  No log No ovr driver 
    
   
       Field 1 current port name on initial access to OZTERM or
               current or last Host logged to.
       Field 2 Port speed, or TRANSMIT file open indication.
       Field 3 current terminal emulation mode. (eg AOM, TW, IOG11,
               FD, etc)
       Field 4 Half/Full Duplex.
       Field 5 Block or Character mode
       Field 6 "No log" or the first eight characters of the currently
               selected disk log file.
       Field 7 Main screen and command history window insert or
               overwrite, no overwrite mode (Insert key and Alt O).
               Also displays PENDING indicator when a Time Event is
               due to run, or is currently running.
       Field 8 Direct or Device Driver connection and printer logging
               on. (Ctrl F6 or LOGGING MENU Alt L, P)
       
       Side Borders Can be turned on/off. (SET-UP MENU - ALT S
               Borders)


3.4  TERMINAL COMMUNICATIONS

     Each port has individual settings for line speed, number of bits,
     parity checking, terminal emulation mode, Log file name if
     applicable and port name defined in the reference file.  These
     may be temporarily over-ridden from the PORTS menu.
     
     Enter commands by either:
     
          Typing in the command and pressing Enter key.  Commands may
          be up to 255 characters long.
          Moving the cursor up the Main screen, editing a previous
          command and re-entering.
          Pressing the End key to access the Command History Stack
          Window, then selecting a previously entered command by
          moving the select bar and pressing Enter key to execute.
          In the Main screen, press Shift Up Arrow or Shift Down Arrow
          (Ctrl F4, Ctrl F5) to access the previous/next command from
          the command history stack.
          Running a Transmit File.
     
     

3.5  PROMPTS

     
     The program recognises various host prompts depending on the
     emulation mode.  While in AOM, TW, IOIM, MNOSS or IOG11 modes
     the following prompts are recognised:
     
          "<"     ":"     ": :"  "ADDR:"    "DO:"    "DO: :"
          "< "    ": "           "ADDR :"   "DO::"   "DO: <"
          
     While in OMI mode the prompts recognised are:
     
          ">:"    ":"     ">"    "?"    "<"    "$"    "#"
          
     While in SYS12 (System-12) mode the prompts recognised are:
     
          "<"     "="     ":<"
          
     While in S12FD (System-12 MPTMON) mode the prompts recognised
     are:
     
          ">"     ":"
          
          
3.6  KEYBOARD

     3.6.1  Key Allocation (listed alphabetically within function)
     
      General
      
      Arrows            move cursor up, down, left and right
      Backspace         Backspace delete
      Ctrl Backspace    send backspace to AOM (not usually  required)
      Ctrl Break        send BREAK to Coms Port (1 Second Break).
      Ctrl End          move cursor to end of screen page
      Ctrl Home         move cursor to top of screen page
      Ctrl Left Arrow   selects the previous terminal emulation mode
      Ctrl PgDn         move to end of screen buffer
      Ctrl PgUp         move to top of screen buffer
      Ctrl Right Arrow  selects the next terminal emulation mode
      Del               Delete character
      End               LAST COMMAND stack window access, also toggles
                        cursor position between the command stack window
                        and the Main screen.
      Enter             SEND command on current line (block mode) or send
                        CR only (character mode)
      ESC               Cancel or Abort current activity
      Home              show main MENU bar
      Ins               Insert/overwrite mode toggle
      PgUp              previous page of screen buffer
      PgDn              next page of screen buffer
      Shift DnArrow     selects the next command from Command history.
      Shift End         move cursor to end of line
      Shift Home        move cursor to start of line
      Shift UpArrow     selects the previous command from Command History
      
      
      System Defined Function Keys
      
      Alt F6       Printer on/off for 2nd monitor port
      Alt F7       page down 2nd monitor port
      Alt F8       page up 2nd monitor port
      Alt F9       Release DTR and modem, or release Novell connection.
      Alt F10      Display Function Keys
      
      Alt A        Action menu
      Alt B        B module help
      Alt C        Hex/Decimal converter
      Alt D        DOS gateway small (retains Main screen in memory)
      Alt E        View/Edit files (retains Main screen in memory)
      Alt F        Files  Menu / Search forward for text when  viewing
                   a  file / insert a Formfeed character when editing
                   a file
      Alt F, D     DOS  gateway  large  (releases Main  screen  memory
                   area)
      Alt F, V     View/Edit files (releases Main screen memory area)
      Alt H        Help Menu
      Alt I        Transmit Menu
      Alt K
      Alt L        Logging Menu
      Alt M        Module Menu
      Alt N        Next  line  in Transmit file in Single step /  full
                   screen for Module
      Alt O        Toggle Overwrite / No overwrite on Main screen
      Alt P        Ports Menu
      Alt R        Repeat Search
      Alt S        Set-up Menu
      Alt T        Toggles between two selected port  modes (usually
                   Full Duplex) and the selected exchange mode (Eg IOG11)
      Alt U        Utility Menu
      Alt V        VIEW current disk log file
      Alt X        Quit program
      Alt Y        Clear screen from cursor position
      
      Ctrl F2      LOG ON to current exchange
      Ctrl F3      LOG OFF from exchange
      Ctrl F4      Previous command from command history stack
      Ctrl F5      Next command from command history stack
      Ctrl F6      Printer on/off for selected port in the Main screen
      Ctrl F7      Upper window scroll up (Transmit file, B module etc)
      Ctrl F8      Upper window scroll down (Transmit file, B module etc)
      Ctrl F9      SEND command on current line / Soft Break in FD mode
      Ctrl F10     INTERRUPT character (AOM=@, TW=^D  else Break), ie
                   200 millisecond Break
      
      Ctrl D       INTERRUPT character, similar to Ctrl F10
      Ctrl K       Screen Edit menu block mode only (see Ctrl Q)
      Ctrl L       Repeat text search
      Ctrl P       Send  Control  P  to  line,  ie  command  mode  for
                   Austpac connections.
      Ctrl Q       Screen Edit Menu for block mode, in character  mode
                   XON is sent.
      Ctrl T       Delete word in block mode.
      Ctrl Y       Delete line from screen buffer in block mode.
      Ctrl Z       Insert an End of file marker when editing a file
      
      F1 - F10     Programmable soft keys  1 - 10
      Shift F1 - F10 Programmable soft keys 11 - 20
      
      
    3.6.2  File Manager and View/Editor Keys
     
      Directory
      
      Arrows       move select bar over directories or file names
      End          last file in Directory
      Enter        Directory:  select highlighted Directory
                   File:     select highlighted file if File manager
                   entered from New transmit window, Module select
                   window, Time Event or Text event Menus.
      ESC          return to entry Menu
      Home         move select bar to first file in Directory
      
      SHIFT/Char   move highlight bar to the first file in the
                   directory with a file name starting with the
                   letter pressed.
      F            Set file mask
      V            VIEW selected file
      H            View selected file in Hexadecimal format
      E            EDIT selected file
      N            Create a new file to edit
      P            PRINT selected file
      M            Make Directory
      D            Delete File / Directory
      R            Rename a file
      C            Copy a file
      L            LOG new Directory path
      X            Execute a DOS program
      ESC          return to Main screen
      
      
      View
      
      Arrows            4 way scrolling over text file
      Ctrl Left Arrow   move 20 columns to the  left
      Ctrl Right Arrow  move 20 columns to the right
      Ctrl PgUp         move to top of file
      Ctrl PgDn         move to end of file
      PgUp              previous page
      PgDn              next page
      
      
      Edit
      
      Arrows            move cursor
      Ctrl Left Arrow   one word left
      Ctrl Right Arrow  one word right
      Ctrl PgUp         move to top of file
      Ctrl PgDn         move to end of file
      PgUp              previous page
      PgDn              next page
      
      Insert           toggle insert/overwrite editing mode
      Home             start of the line
      End              end of the line
      Ctrl Home        top screen page
      Ctrl End         end screen page
      Ctrl Y           delete the line the cursor is on
      Ctrl T           delete one word to the right of the cursor
      Ctrl K, B or F7  mark start of block
      Ctrl K, K or F8  mark end of block
      Ctrl K, C        copy the marked block to the current cursor
                       position
      Ctrl K, V        move the marked block to the current cursor
                       position
      Ctrl K, D        exit the editor.
      Ctrl K, R        read in a whole file
      Ctrl K, W        write the marked block to file
      Ctrl Q, F        search forward for text
      Ctrl Q, A        search forward for text, and replace with text
      Ctrl L           repeat last text search
      Ctrl F           insert a form feed character at the current cursor
                       position
      ESC              abort current function, or Editor Menu
                       R         insert the contents of another file at
                                 the current cursor position
                       W or F2   Save the currently open file to disk
                       H         display the Editor Help screen
                       S         Save the current with a different file
                                 name
                       Q         Quit the editor (Note: will prompt the
                                 user to save the file if any changes
                                 have been made)
      F1               Editor Help
      F2               save current file to disk
      
      
    3.6.3  Command History Keys
     
      Press  End to display the Command History Stack window,  and  to
      toggle  the  cursor position between the command history  window
      and  the  Main  screen.  The top border of the  Command  history
      window  (ie  Line  18  on  the screen) displays  the  number  of
      commands  in the History (maximum 64) and which one  the  select
      bar is currently on.
      
      In the Command History window:
      
      Up Arrow     move last command select bar up
      Down Arrow   move last command select bar down
      Ctrl F4      move last command select bar up & put command on
                   screen
      Ctrl F5      move last command select bar down & put command on
                   screen
      Ctrl PgUp    move main screen to top of Main screen
      Ctrl PgDn    move main screen to end of Main screen
      PgUp         previous page of Main screen
      PgDn         next page of Main screen
      Ctrl Y       delete command from the history stack
      End          toggle  cursor  position between  Main  screen  and
                   Command History window.
      Enter        execute the command the cursor is on.
      ESC          closes command history window
      
      In  the  Main Screen, the commands in the Command Stack  can  be
      accessed by using the following keys:
      
      Shift UpArrow or Ctrl F4    selects the previous command
      Shift DnArrow or Ctrl F5    selects the next command
      ESC                         closes command history window
      

3.7  STRING INPUT FIELDS

     String input fields such as file names can be edited using the
     Left and Right Arrows, Backspace, Home, End, Ins, Del and  Ctrl Y
     (clear) keys.  Data entry is terminated by pressing the Enter key
     when complete, or moving to another field.
     

3.8  ABORT or CANCEL

     The ESC key is the general abort or cancel key.
     
                                   

                   
                             4.  FILE MENU
                                   

4.1  GENERAL DESCRIPTION

     This section describes the manipulation of files, file transfer
     and access to DOS commands.  Information about B Module files and
     directories is available in Section 10, Modules. Information
     about the other OZTERM files is available in Section 17, OZTERM
     FILES.
     

4.2  FILE MENU - (Alt F)

     4.2.1  View/Edit (Alt F, V or Alt E)
     
          The View /Edit selection in the Files Menu will save the
          Main screen to disk, freeing up conventional memory, and
          open the File manager screen.  This frees up some
          conventional memory, allowing bigger files to be edited.  If
          the "Hot Key" selection ALT E is pressed OZTERM will bypass
          the save screen step and go straight to the File Manager.
          
          The File Manager allows users to move through directories
          and select other disk drives.  To select a particular
          directory use the disk Logging menu option, or the Up/Down
          Arrow keys and then Enter when the required directory is
          highlighted.  To step back one directory select the ".."
          option and then Enter.  The "." option will take you back to
          the Root directory on that particular disk drive.
          
          Keyboard allocations for the View/Edit menu are contained in
          Section 3.6.2 File Manager and View/Edit Keys.
          

                      Example File Manager Screen
Line No
    Ŀ
 1  Files/Directories                  Key functions                 
 2  .                                                                
 3  ..                                 Disk Size = 528,171,008 Bytes 
 4  CMDS                               Disk Free = 398,304 Bytes     
 5  TEXT                                                             
 6  AUSTPAC .C   21/06/94 16:24    403 PgUp PgDn HOME END move       
 7  DEXCHNGE.C   11/07/94 16:26    959                               
 8  DGQLD   .C   31/05/95 16:55    917 SHIFT/Char to Highlite File   
 9  DIAL    .C   21/06/94 16:25    305 Filespec    *.*               
 10 DXL     .C   21/06/94 16:25    870 View File                     
 11 DXM     .C    5/05/95 14:56    410 Hex View File                 
 12 DXNRB   .C   21/09/94  8:23   1059 Edit File                     
 13 DXRB    .C   21/09/94  8:23    980 New                           
 14 ETDS    .C   21/06/94 16:26    295 Print                         
 15 INT14   .C   21/06/94 16:26    399 Make   Directory              
 16 LOCAL   .C   24/07/95  8:26   3493 Delete Directory / File       
 17 LOCAL   .LAN 24/07/95  8:27   3508 Rename File                   
 18 MDXSW   .C    7/02/95  8:23    442 Copy                          
 19 OMI     .C   26/08/94 11:27    494 Log New Directory             
 20 OZDEV   .BAT 24/06/93  8:38     34 Xecute DOS program            
 21 OZDRT   .BAT  3/12/93 13:38     35 ESC quit                      
 22 OZDVR   .COM  4/12/92  0:00  55133                               
 23 OZLAN   .BAT  1/11/94 16:31    964                               
 24 OZTEL   .BAT 31/05/95 13:27    157                               
 25 C:\OZTERM\*.*                      Memory=154k  05/08/95 11:41:38
    

          The previous example shows the File Manager split screen.
          
          The left hand side displays all the sub-directories and
          files in the currently selected directory.  All the sub-
          directories are listed first followed by the files sorted in
          ascending alphabetical order.  To select a sub-directory
          move the highlight bar to the required directory using the
          cursor keys, and press enter.  To go back one directory
          select the "..", and go to the root directory select".".  To
          select a file move the highlight bar to the required file
          using the SHIFT/Character function or the cursor keys.  Then
          press the key for the required function, eg E to Edit.
          
          The Right hand side displays the following functions:
          
          Disk Size =          The total disk size on the currently
                               selected drive.
          
          Disk Free =          The amount of free disk space available
                               to the user.
          
          PgUp PgDn HOME END   Cursor key functions that will move the
                               highlight bar.
          
          SHIFT/Char to Highlite File 
                               If SHIFT and an alpha character
                               is pressed, eg Shift O, the highlight
                               bar is moved to the first file in the
                               current directory starting with that
                               letter.  In the example screen above
                               the highlight bar would be moved to the
                               OMI.C file.
          
          Filespec             Restrict the files displayed to those
                               conforming with a wildcard
                               specification.
          
          View File            Will open the file the highlight bar is
                               currently on in View only Mode.  With
                               the file open in this mode ALT F allows
                               you to search forward for text, ALT R
                               will repeat the  search forward.  This
                               feature allows large files to be
                               viewed.
          
          Hex View file        View the selected file in HEX mode.
                               This will display the selected file in
                               two areas on the screen.  In the centre
                               is displayed all the ASCII code in the
                               file in Hexadecimal.  Only 16 ASCII
                               characters are displayed per line.  On
                               the right hand side is the normally
                               displayed character corresponding to
                               each ASCII code.  The left hand column
                               indicates the number of the character
                               at the start of each display line, in
                               Hexadecimal.
          
          Edit File            Will open the selected file in the
                               OZTERM Editor.
          
          New                  Allow the user to open a new file in
                               the editor.
          
          Print                Print the selected file to the
                               currently selected file.  If Printer
                               Formfeed is set to ON in the Setup
                               Menu, a formfeed will be sent to the
                               printer at the end of the file.  (see
                               Setup Menu and @SELPRINT for printer
                               selection and formfeed).
          
          Make Directory       Create a new sub-directory in the
                               current directory.
          
          Delete Directory / File
                               Delete the selected file or
                               directory.  Note will only delete a
                               directory if that directory is empty.
          
          Rename File          Rename the selected file.
          
          Copy                 Copy the selected file to a new file or
                               directory.  Note will overwrite if
                               copied an existing file.
          
          Log new directory    Log to a new directory in the current
                               drive or a new drive.  If the Drive of
                               directory is empty (eg a formatted
                               floppy disk with no files) the file
                               display will show the message "No
                               Files".
          
          Xecute DOS program   Opens a window in which any DOS command
                               may be specified.  When enter is
                               pressed, OZTERM will go to a DOS shell
                               and perform the task, eg COPY *.* A:/V
                               will copy all the files in the current
                               directory to the A: drive.
          
          ESC quit             If ESC is pressed OZTERM will return to
                               the Main screen.
          
          Line 25 of the File Manager screen displays the currently
          selected drive and directory; the amount of conventional
          memory currently available; and the current date and time.
          
          
     4.2.2  DOS Gateway
     
          This option in the Files Menu opens a DOS shell from within
          OZTERM..  DOS commands may be entered as usual.  Return to
          OZTERM is made by entering  EXIT  on an empty line at the
          DOS prompt.
          
          You can shell out to DOS at any stage by selecting the DOS
          gateway from the FILE menu, or by using the "Hot Key" Alt D.
          Note if the Alt F, D option is used the screen buffer is
          written to disk, releasing that memory space.  If the Alt D
          option is used, the screen buffer is retained in memory,
          reducing the amount of conventional memory available in the
          DOS shell.
          
          The extra memory gained by selecting the DOS Gateway from
          the Files Menu is not available if a transmit file is open.
          
          
     4.2.3  File Transfer
     
          This menu selection allows you to send or receive ASCII or
          binary files.  The three options in the file transfer menu
          are:
          
          Ascii file      allows the user to transfer a file in
          transmit        ASCII format.
          Send    xmodem  allows the user to transfer a file
          file            using XMODEM protocol.
          Receive xmodem  allows the user to receive a file using
          file            XMODEM protocol.
          
          
          It is important the  port configuration matches the host.
          For example, when accessing Keylink the settings would be
          nil parity, 8 data bits and character Full Duplex mode.
          
          File transfer may be aborted by pressing the ESC key.
          
          To send an ASCII file select the port required (see PORTS
          menu), press Alt F, F, A to select the Ascii file transmit
          option.  The name of the file to be sent may be typed in, or
          selected using the File Manager by pressing F1.  When the
          correct file has been selected press enter and the ASCII
          file transfer will commence.  A message is displayed to
          indicate when file transfer is completed.
          
          Ŀ
          Transmit ASCII file - enter filename
                                              
          C:\OZTERM\TEXT\BBINFO.TXT           
                                              
                                              
          Press F1 for directory              
          

          
          To upload a file to Keylink , enter the command 'upload
          binary (file name)'.  When the message to prepare for file
          uploading is received, press Alt F, F, S to open the Send
          XMODEM screen.  When a send file name has been specified
          (note F1 may be used to select the file from the File
          Manager), press enter and the XMODEM transfer will commence.
          
          Ŀ
          XMODEM    Send binary file - enter filename
                                                     
          C:\OZTERM\BBINFO.TXT                       
                                                     
          Packet Status   : Sending block            
          Block  Check    : Checksum                 
          Blocks Sent     :    4                     
          Errors Received :    0                     
          Bytes  Sent     : 768                      
          File   Size     : 21257                    
                                                     
          Press F1 for directory                     
          
          

          To download a Keylink file, enter the command 'download
          binary (file No.)'.  When the message to prepare for file
          downloading is received, press Alt F, F, R to open the
          receive XMODEM screen.  When a receive file name has been
          specified, press enter and the XMODEM transfer will
          commence.

          Ŀ
          XMODEM Receive binary file - enter filename
                                                     
          C:\OZTERM\TEXT\BBINFO.TXT                  
                                                     
          Packet Status   : Receiving block          
          Block  Check    : Checksum                 
          Blocks Received :    8                     
          Errors Received :    0                     
          Bytes  Received : 1024                     
          File   Size     : 1024                     
          
          

     4.2.4  eXit Program
     
          When the exit program is selected, ie Alt F, X or Alt X the
          following actions will take place:
          
            The OZTERM.DFT file is run from the Label EXIT, which will
            run other script files, etc, until an @STOP is
            encountered;
            Closes any Log files that are open;
            Saves configuration files;
            Saves the screen buffer contents;
            Saves the Time and Text Events; and
            Exits from the OZTERM program.
          

                                   
                            5.  SETUP MENU
                                   

5.1  GENERAL DESCRIPTION

     When OZTERM is used for the first time it will prompt you to
     configure the OZTERM Port reference file OZDVR.REF.
     
     Each session of OZTERM can be configured for up to 16 Ports.
     
     OZTERM can be configured to contain data about a large number of
     links.
     A link is a communication path between the OZTERM program and a
     distant host. It may include a dial up modem, Datagates, LAN's or
     MDX data switches.
     
     The SET-UP menu contains options that change the way OZTERM
     operates.
     

5.2  SET UP MENU - (Alt S)

     5.2.1  Function keys
     
          OZTERM reserves 20 function keys (F1-F10 or Shift F1-F10 )
          for operator or application specific configuration.  For a
          list of the System Defined Function keys, refer to Section
          3.  There are three fields to set up for each function key.
          The Tab key is used to move between the fields, and the up
          and down arrows to move between Function Key settings
          
          5.2.1.1Action
          
               This  field determines the action which will occur when
               the function key is pressed.  The options are:
               
               A    Auto-transmit which sends the 'Macro' immediately
                    to the Host.
               
               L    Local display.  This displays the 'Macro' in the
                    Main screen and allows the operator to edit the
                    command before sending.  This option also provides
                    a facility to position the cursor by including an
                    '_' (underscore) character in the 'Macro'.  For
                    example, the 'Macro' could be :
               
                    SUSCP:SNB=230_     ,LIST;
               
                    When the function key for this macro is pressed, the
                    cursor is positioned ready for the remainder of
                    the SNB to be entered by the operator.
               
               T    Automatically run a  Transmit Script file
                    specified by the 'Macro'.
               
               
          5.2.1.2 Label
          
               This  field is used to enter a six character label  for
               this function key.  Alt F10 displays the label names in
               a window at the bottom of the screen.
               
          
          5.2.1.3 Macro
          
               This  field contains the command or transmit file name.
               If  a  file  name is to be specified, the name  may  be
               typed  in,  or  selected  using  the  File  Manager  by
               pressing F1.
               
               
     5.2.2  TeXt Events
     
          This utility allows a transmit file to be run automatically
          if a particular print-out (Text) is received by OZTERM from
          the host.  When the text set in the "Slogan" field for a
          Text Event is received, the  Transmit file is placed in a
          Pending queue, and the PENDING indicator is displayed in the
          Status line.  If a Transmit file is already open, the Text
          Event will wait for that Transmit file to close before
          running.
          There are three fields to set up when configuring a Text
          Event.  The Tab and up and down arrow keys are used to move
          between the fields.
          
          
          5.2.2.1 Act
          
               This field is set to "Y" or "N" to indicate if the
               event is active or not.
               
               
          5.2.2.2 Text Event Slogan
          
               Text which will trigger the transmit file listed in
               field 3.  Only one slogan allowed per Text Event.
                    
                    
          5.2.2.3 Transmit File Name
          
               Transmit file which will run when the Text Event Slogan
               is received.  Type in the Transmit file name, or press
               F1 to use the File Manager to select the file.
          
          To clear a Text Event move the cursor to the Active field
          for that event, press Ctrl X and the event details will be
          erased for that particular event.
          A Text Event will not run while any other transmit file is
          open.
          An asterisk ("*") next to the Active field for an  event
          indicates that it is inhibited until a priority event has
          executed.  See @EVSETPRI for more information on priority
          events.
          
          
     5.2.3  TiMe Events
     
          This utility allows a transmit file to be run automatically
          at a set date and time.  When the start date and time is
          reached for a Time Event the Transmit file is placed in a
          Pending queue, and the PENDING indicator is displayed in the
          Status line.
          If a Transmit file is already open, the Time Event will wait
          for the Transmit file to close before running.
          If no Transmit file is open, the Pending Time Event will
          wait for the time period set in Keyboard Timeout the Setup
          Menu.  If there has been no keyboard or host activity for
          the specified time, the Time Event will run the Transmit
          file.
          Note that if the Keyboard Timeout value is set to 0, the
          Transmit file will run straight away, regardless of keyboard
          or host activity.
          When the Transmit file has finished, a new start date and
          time is calculated for the Time Event, according to the
          values in the Interval fields.  If the Interval fields are
          not set the Transmit file will close, and the Time Event
          record erased from the Time Event Menu.
          
          The Tab and up and down arrow keys are used to move between
          the fields and events.
          
          If the "+" key is pressed in any field except the Transmit
          Filename field, that Time Event will advance the Date or
          Time fields by an amount equal to the Units set in the
          Interval fields.  If Interval fields are blank or zero
          ("0'), a "+" will advance the date by units of one day,
          
          If the "-" key is pressed in any field except the Transmit
          Filename field, that Time Event will regress the Date or
          Time fields by an amount equal to the Units set in the
          Interval fields.  If Interval fields are blank or zero
          ("0'), a "-" will regress the date by units of one day,
          
          "Ctrl X" will delete the record of an event if the cursor is
          in the "Act" field.
          
          An asterisk ("*") in the Time Event Menu next to a Time
          Event indicates that it is inhibited until a priority event
          has executed.  The Time or Text Event which doesn't have an
          "*" next to it is the Event with priority.  See @EVSETPRI
          for more information on priority events.
          
          There are seven fields on the Time Event set up window:
          
          5.2.3.1 Act
          
               This field is set to "Y" or "N" to indicate if the
               event is active or not.
          
          5.2.3.2 Bootup Re-Sch
          
               This field allows the operator to determine what will
               happen to time events if OZTERM was not running at the
               specified start time. The options are:
               
               A    Automatic re-schedule.  The event will
                    Automatically occur at the specified time period.
                    If OZTERM was not running when an Automatic event
                    should have started, the event will be silently re-
                    scheduled without running the next time OZTERM is
                    started.
               
               M    Manual re-schedule.  This is the default setting.
                    If there are events with Manual re-schedule set in
                    the Time Event menu that should have occurred
                    while OZTERM was not running, the following will
                    occur:
                    
                      When OZTERM is next started the operator is
                      prompted to re-schedule the event if they wish.
                      If the operator chooses not to re-schedule the
                      event(s), they will be placed in the Pending
                      state and executed.
                      If the option to re-schedule is taken, the  Time
                      Event Menu displayed and the operator may modify
                      the events.
                      If neither option is selected by the operator,
                      the Re-scheduling choice will time-out after 5
                      minutes and the Manual events will be executed.
                      This allows the program to recover from power
                      failures without manual intervention.
          5.2.3.3 Date
          
               This field is used to set the date that the time event
               will start.  The field has the format DDMMYY, where:
               
               DD   is two digits indicating the day of the month;
               MM   is two digits indicating the month; and
               YY   is two digits indicating the last two digits of
                    the year.
               
               If the field is blank and the TAB or Enter key is
               pressed while the field is selected, the current date
               is written into it.
               
               
          5.2.3.4 Time
          
               This field is used to set the time of day that the time
               event will start.  The field has the format HHmm,
               where:
               
               HH   is two digits indicating the hour; and
               mm   is two digits indicating the minutes.
               
               If the field is blank and the TAB or Enter key is
               pressed while the field is selected, the current time
               is written into it.
               
               
          5.2.3.5 Interval
          
               These two fields (Number and Unit) are used to
               calculate the new start date and time once a time event
               has run.
               If these fields are left blank, the transmit file will
               run once at the specified start time.  When this time
               event has run, it will be removed from the time event
               menu.
               
               
               5.2.3.5.1 Number
          
                    This field specifies the number (0-99) of time
                    units (see the Unit field) used to calculate the
                    new start date and time for each Time Event.  Note
                    that a value of 0 means that the transmit file
                    will be restarted straight after it has finished.
                    
                    
               5.2.3.5.1 Unit
               
                    This field specifies the time unit  interval used
                    to calculate the new start date and time of the
                    time event, once i has run.  This field is
                    mandatory if a value has been entered in the
                    Interval Number field.
                    
                    This field will not be selected if the Number
                    field of the interval is blank.
                    
                    There are four valid time units, these are:
                    
                         W    Weeks
                         D    Days
                         H    Hours
                         M    Minutes

          5.2.3.6 Transmit File Name
          
               This field is used to specify the transmit file which
               will run when the specified start date and time is
               reached.  Type in the file name or use the OZTERM file
               manager to select the script file to run by  pressing
               F1.
               
          
     5.2.4  Borders
     
          This menu selection displays the current state of the main
          screen side borders.  Selecting this item will toggle the
          state of the borders between YES and NO.  This determines
          whether the side borders are displayed or not.
     
     
     5.2.5  BEll
     
          This menu selection displays the current state of the
          audible warning when a bell character (Ctrl G) is received.
          Selecting this item will toggle the state of the audible
          bell warnings between YES and NO.
     
     
     5.2.6  Overwrite (Alt O)
     
          This menu selection displays the current state of the main
          screen editing and host data  reception.  Selecting this
          item will toggle the state of the main screen between
          overwrite and No overwrite mode.
          
          When the Overwrite selection is on, and a command is entered
          at the top of the screen the resultant print-out will
          overwrite the text immediately below the command.  With
          overwrite off the print-out will commence at the bottom of
          the existing text, no matter where the command is entered
          
          Note this will not affect the order in which data is written
          to a disk log file, ie the text will appear in the log file
          in the order in which it occurs
          
          
     5.2.7  Toggle Port Mode (Alt T)
     
          Toggle between two port modes.  When OZTERM starts, the
          alternate mode is set to Full Duplex mode (FD).  This
          facility can be used to toggle between any two modes.  For
          example, to toggle between TW and IOG11 modes, first change
          to one of the to TW mode.  When it is required to change to
          IOG11 mode, first select the Port Toggle option from this
          menu (or use the Alt T hot key), then change the mode to
          IOG11.  This facility can now be used to toggle between
          these two (ie TW and IOG11) modes.
          
          
     5.2.8  AOM Password
     
          Select this option and you can enter your AOM password for
          automatic logging on to the AOM.  When not used the AOM
          password can be entered manually at the AOM prompt.  The
          text in this field cannot be viewed, ie displays
          '**********' in the password field.
     
     
     5.2.9  sYs 12 password
     
          Select this option to enter  your System 12 password.  The
          text in this field cannot be viewed, ie displays
          '**********' in the password field.
          
     
     5.2.10 Screen Timeout
     
          This option allows you to select your screen time-out time
          in minutes.   Acceptable values are 0 to 99.  A value of 0
          indicates no Timeout.  Screen Timeout will occur when there
          has been no:

            keyboard activity;
            host activity;
            Transmit file running;
            Text Event running; or
            Time Event running.
          
          If all these criteria have been met for the time interval
          set in the Setup Menu, screen Timeout occurs.  At this time
          the file OZTERM.STO is run if it exists in the OZTERM
          Working directory (see Section 4.3).  When this file has
          finished running, the Screen will go blank, except for a
          moving message displaying the program name and version, and
          the current PC date and time.
          This value may also be set using the Script command
          @SCREENTIMEOUT(num), see Section 18 for more information.
     
          WARNING   If a Script file is open but not running (ie
                    halted or paused) when the screen times out,
                    Ozterm will close the file and run OZTERM.STO.
                    This only occurs if OZTERM.STO resides in the
                    users Working directory.
     
     
     5.2.11 Keyboard Timeout
     
          This is used to set the amount of time in seconds that a
          Time Event will wait for no keyboard or host activity before
          running the Transmit file.  This means a Time Event will not
          run whilst a printout is being received, or the keyboard is
          being used.  The limits are from 0 to 99 seconds.
          This value may also be set using the Script command
          @KEYTIMEOUT(num), see Section 18 for more information.
          
          WARNING   A value of 0 means a Time Event will run
                    immediately the start time is reached, regardless
                    of keyboard or host activity.
     
     
     5.2.12 Printer
     
          This option allows you to select which  parallel printer
          port is used within  OZTERM (ie LPT1, LPT2, or LPT3).  This
          uses the current PC environment printer re-direction
          settings (ie shared LAN printers, etc)
          
          
     5.2.13 Printer formfeed
     
          This menu selection allows you to toggle the printer form
          feed ON or OFF at the end of the file being printed.
     
     
     5.2.14 Edit Auto Dial List
     
          This option allows you to edit the file AUTODIAL.OZI.  The
          file is automatically created if it does not exist.  The
          structure of this file is described in section 17.2.  More
          than 100 destinations may be entered into the 'autodial'
          list.
          When the file to edit has been selected a full screen is
          displayed with a list of all the host names currently in the
          AUTODIAL.OZI file.
          To select one of the existing entries, move the highlight
          bar to the required name.  The enter can be pressed to open
          the selection for editing, or the entry may be deleted by
          pressing the delete key.
          To insert an new entry, move the highlight bar to the
          appropriate position in the list, and press the insert key.
          The following screen will be displayed when the editing
          function has been opened:
          
          Ŀ
              Edit           Insert exchange name for this port 
          auto-dialling data                                    
                                                                
                                                                
          Ĵ
                                                                 
                                                                 
           Xge  Exchange   Xge    Datagate     Hayes             
           no.   name      mode     used    dialling string      
             7  SAMP      AOM        Q      ATDT0xxxxxxxx        
                                                                 
                 Speed     Bits    Login          Password       
                 1200       7      login          name#auth      
                                                                 
                                                                 
                                                                 
                                                                 
                                                                 
                                                                 
           TAB change fields  PgUp PgDn change exchange  ESC done
          
          
          There are eight fields which the operator may set:
          
          Exchange name    Maximum 8 characters.  This is name
                           displayed in the "Select auto-dial exchange
                           to edit" screen and the "Select auto-dial
                           exchange" menu in the Action Menu (see
                           section 9).  this also the destination name
                           specified in the script command
                           @AUTODIAL(dest) (see section 18).
          
          Xge mode         This is the mode the port will be left in
                           when the port is connected to the host.
          
          Datagate used    This allows for the following types of
                           connection:
                               SA  type datagate
                               QLD type datagate
                               No datagate
                               Keylink
                               Transmit File
          
          Hayes dialling string This can be either the dialling string
                           including the phone number of the Datagate
                           or modem, or the transmit file name if the
                           option has been selected in "Datagate
                           used".
          
          Speed            The Baud rate required to communicate with
                           the host on this port.
          
          Bits             The number of communication bits used for
                           this session.
          
          Login            The string to be sent when login is
                           requested.
          
          Password         The string to sent when Password is
                           requested.
                                   


                            6.  PORTS MENU
                              

6.1  GENERAL DESCRIPTION

     OZTERM  provides  the  capability to  use  standard  serial  port
     hardware,  a  variety  of multi-port serial boards,  and  network
     connected ports (eg EICON Gateway,  NAC Server, TCP/IP sessions).
     Each  port  (or virtual port) may be configured independently  to
     any  of the supported modes.  The mode on the active port may  be
     changed interactively.
     

6.2  PORTS MENU - (Alt P)

     6.2.1  Select Ports/Mode/Speed
     
          This option is for temporary changes to port configuration
          only. Permanent changes are made using the Install Boards
          option in the Ports menu.  The options available for each
          field are displayed as the field is selected.  The Up and
          Down arrow keys are used to make a selection in the field,
          and the Left or Shift Tab, and Right or Tab keys are used to
          move between the fields.  The ESC or Enter key completes the
          port configuration.  The options provided are:
          
          6.2.1.1 Port
          
               This field is used to select the active port.  The
               active port may also be selected using the Script
               command @PORTNO.
          
          
          6.2.1.2 Mode
          
               This field is used to configure the port emulation
               mode.  The available modes are: AOM, TW, IOG11, MNOSS,
               FD, HD, SYS12, IOIM, Block Full Duplex, OMI and SYS12
               FD.  The mode may also be set from a script file using
               the @MODE command.
               
               
          6.2.1.3 Speed
          
               This field is used to set the baud rate to match the
               communications hardware.  Speeds supported are 110,
               150, 300, 600, 1200, 2400, 4800, 9600, 19200, and 38400
               bits per second.  The speed may also be set by the
               script command @BAUD.
               
               
          6.2.1.4 Data Bits / Parity
          
               This field provides the choice of 7 bits even parity,
               or 8 bits no parity.  This selection may also be set by
               the @BAUD script command.
               
               
          6.2.1.5 Essnet
          
               This field is provided to facilitate operation on the
               Victorian data network.  When enabled, ie Via ESSNET,
               the high (8th) bit is stripped from all characters
               received.
               
          6.2.1.6 IRQ / Addr
          
               This field is read-only.  It displays the Interrupt
               Number (IRQ) and IO address for the serial ports, or
               the type of emulation for Network connected ports, eg
               NASI or Telnet.
          
          
     6.2.2  Port Test
     
          Allows test of selected port in "Dumb" Terminal Mode,
          checking for hardware hand-shaking etc.  The top window of
          this screen displays the state of the leads, TX and RX
          character counts, the number off-line errors, and port Speed
          and parity.  Note these lead states only apply to RS232
          Ports (Serial).
          
          The lower window of this screen displays the interpreted
          ASCII code as it is received from the host.
          
          The bottom line (inverse, or Red line) of this window
          displays the actual ASCII code in Hexadecimal as it is
          received from the host.
          
     
     6.2.3  Monitor 2nd Port
     
          This feature allows the operator to select a port to monitor
          host activity.  The communications activity is displayed in
          the top window on the Main screen.  The active port in still
          displayed in the bottom half of the main screen.
          
          Alt F7 and Alt F8 may be used to scroll the top window
          through the data.
          
          Alt F6 is used to toggle the printer on or off the Monitored
          port.
          
     
     6.2.4  Install Boards
     
          This option will allow permanent changes to the port
          configuration.  The program will automatically terminate
          when the changes have been accepted.  The  changes will take
          effect the next time the program is started.
          
          Please note that if your IO configuration is not listed in
          the "Standard" board configurations available, you may have
          to manually set up your OZDVR.REF file.  Refer to Appendix D
          for the configuration details to set up a number of multi-
          port cards which work with OZTERM.
          
          
          The operator is presented with a list of the current port
          settings and the Install Menu, which has the following
          options:
                   Ŀ
                    Install Menu       
                                       
                    Select board       
                    config.            
                    Select No. of ports
                    Edit Board config. 
                    Edit Port data     
                    ESC quit           
                   

          6.2.4.1 Select board config.
          
          This options opens the menu displayed below.  The operator
          may select one of seven preset communications
          configurations.  The eighth option allows the operator to
          specify individual port configuration combinations.  Note
          that OZTERM Version 6.20 allows multiple ports to be set for
          the Network connection interfaces, ie NASI and Telnet,
          similar to the Multi-port serial cards,.  Typical values
          will be a maximum of three ports for NASI connections and a
          maximum five ports for Telnet connections.
          
       Ŀ   
          Select board configuration   Total
                                            
       1  std. COM1 & COM2             2     Standard two serial coms
                                             ports.
       2  1 * HS4 4 port board         4     One 4 port HS4 type serial
                                             card.
       3  2 * HS4 4 port boards        8     Two 4 port HS4 type serial
                                             cards.
       4  1 * ARNET 8 port board       8     One 8 port ARNET type
                                             serial card.
       5  2 * ARNET 8 port boards      16    Two 8 port ARNET type
                                             serial cards.
       6  1 * NASI(lan) & COM1 & COM2  3     NASI connection plus two
                                             serial ports.
       7  1 * TELNET (Int 14)          1     Interrupt 14 Network
                                             connection.
       8  User defined configuration         User defined board
                                             configurations.
          ESC cancel                         Press ESC to exit this
        menu.
          
          
          A maximum four boards may be configured, all of which may
          have multiple ports, with a maximum total of 16 ports.  For
          example the operator may want to use the existing COM1 and
          COM2 serial ports, and have access to three NASI and five
          Telnet Network connections via the LAN card.  Using option
          "8" from the menu the operator could set up the boards in
          the "Edit board configuration" screen as follows.  Note the
          TAB, Shift TAB keys move across the fields for a Board, the
          Page Up, Page Down keys are used to select a particular
          Board, and ESC is pressed when finished with this screen.
          
          Ŀ
          Board Port     Latch         No.   Board  Background 
          No.   Address  Address  IRQ  Ports Type   Logging    
                                                               
          1     0000     0000     0    3     3      N          
          2     0000     0000     0    5     4      N          
          3     03F8     0000     4    1     0      N          
          4     02F8     0000     3    1     0      N          
          PgUp PgDn change board TAB change fields ESC done    
          
          
          In the Example above a total of ten ports have been
          specified:
          
             Board 1 has been configured for 3 NASI ports;
             Board 2 has been configured for 5 Telnet sessions
             (Interrupt 14);
             Board 3 has been configured to use COM1; and
             Board 4 has been configured to use COM2.
          
          This means that ports 1-3 will be configured for NASI
          connections, ports 4-8 will be configured for Telnet
          sessions, port 9 is COM1 and port 10 is COM2.
          
          
          6.2.4.2 Select No. of ports
          
          This menu option allows the operator to set the number of
          ports available in this session of OZTERM, eg:
          
          Ŀ
          Enter total number of ports to install  10 
                                                     
          
          
          6.2.4.3 Edit Board config.
          
          This menu option allows the operator to edit an existing
          board setup in the "Edit board configuration" screen.
          
          
          6.2.4.4 Edit Port data
          
          This menu option opens the "Edit port data" screen as shown
          below:
          
          Ŀ
          Port Port   Port  Disk  Essnet  Disk logging               
          no.  name   mode  Log           filename                   
          1    NASI   FD    1     N       C:\OZTERM\LOG\N_1_0825.LOG 
                                                                     
              Speed  Parity  Bits  Board  IRQ Address                
              9600   even    7     1      NASI                       
                                                                     
                                                                     
              COM5                                                   
                                                                     
                                                                     
                                                                     
              TAB change fields  PgUp  PgDn change port  ESC done    
          
          
          The following fields are read only and are used to indicate
          which port you are currently editing.  the "Edit board
          configuration" screen must be used to change any of these
          settings:
          
          Port no.    The OZTERM port number;
          
          Board       The board number, ie 1 - 4;
          
          IRQ Address Indicates the serial port address and Latch
                      address, or type of Network connection in use;
                      and
          
          COM5        Indicates the port name used internally in
                      OZTERM as a port reference, ie doesn't
                      correspond to the Port Number.
          
          
          The following fields may be set by the operator in this
          screen.  Note the TAB, Shift TAB keys move across the fields
          for a Port, the Page Up, Page Down keys are used to select a
          particular Port, and ESC is pressed when finished with this
          screen.
          
          Port Name   This field may be set to any meaningful name of
                      up to eight characters.  This name is displayed
                      when the port is first selected and will be
                      overwritten by the host name when a connection
                      is completed.
          
          Port mode   This field is used to set the initial port mode.
                      This mode may be temporarily changed via the
                      Ports Menu or by using the Script command @MODE.
                      Available settings are:
                                AOM          Block
                                TW           Block
                                IOG11        Block
                                MNOSS        Block
                                Full duplex  Char
                                Half duplex  Char
                                SYS12        Block
                                IOIM         Block
                                Full duplex  Block
                                OMI>         Block
                                SYS12 FD     Char
          
          Disk log    Is used to specify whether the port
                      automatically opens the log file set in the
                      "Disk logging filename" field when OZTERM is
                      started.  This field is also used by the
                      background logging device driver OZDVR.COM to
                      determine which ports are to have logging enable
                      in the background.  Available options are:

                              0   No auto disk logging at bootup; and
                              1   Disk logging ON at boot up.
          
          Essnet      This field is provided to facilitate operation
                      on the Victorian data network.  When enabled the
                      high (8th) bit is stripped from all characters
                      received.  Available values are:

                                N   No Essnet
                                E   Essnet connection
          
          Disk         The operator uses this field to specify
          logging      the log file to be opened when OZTERM is
          filename     started if "Disk log" is set to 1 (or to
                       be opened for background logging).
                       Maximum of 40 characters, and the path
                       MUST exist.
          
          
          Speed       Used to select the initial port speed.
                      Available settings are:
                                   110 bps
                                   150 bps
                                   300 bps
                                   600 bps
                                  1200 bps
                                  2400 bps
                                  4800 bps
                                  9600 bps
                                 19.2K bps
                                 38.4K bps
                                          
          Parity      Initial port parity setting.  Available settings
                      are:
                           Nil   No parity, ie "none" in @BAUD command
                           Odd   Odd parity
                           Even  Even parity
          
          Bits        Number of data bits.  Available settings are:
                                7 data bits
                                8 data bits
          
          
          6.2.4.5 ESC quit
          
          When the operator is satisfied with the board and port
          settings, ESC is pressed to exit the Install Menu.  The
          operator is then asked if they want to save the changes to
          their reference file (see Section 17).  If "N" is selected
          the changes aren't saved.  If "Y" is selected the existing
          OZDVR.REF file will be overwritten with the new settings and
          saved in the OZTERM working directory.  The operator is then
          prompted with a message reminding them to load the
          background driver OZDVR.COM if Background Logging is
          required (see Section 7.3).  Press return and the program
          closes.  The next time OZTERM is started the new initial
          port reference details will be loaded.
          

6.3  PORT MODES

     The port terminal emulation mode can be selected by any of the
     following methods:
     
          Select the Ports Menu (Alt P) then the "Select
          ports/mode/speed" option.  TAB to the Mode field and select
          the Terminal emulation required using the up and down arrows
          and enter, or pressing the highlighted letter.
     
          Whilst in the Main screen Ctrl Left Arrow scrolls "left",
          and Ctrl Right Arrow scrolls "right", through the terminal
          emulation modes.
     
          Alt T will toggle between the current port mode and an
          alternate port mode.
     
          The @MODE command (refer Section 18) can be used to change
          the mode.
     
          The Autodialling facility (refer Section 5.2.14).
     
     The terminal emulation mode can be set to one of the following:
   
 Hex No.
   1   AOM    Use for AOM and AXE via the AOM connections.
   2   TW     Use for "normal" baud rate TW ports.
   3   IOG11  Use for AT ports, eg XIOS, RURAL or IOG-11
   4   MNOSS  Use for access to AT Ports via OSS or APG40.
   5   FD     Character Mode Full Duplex.  Used for Austpac, MDX,
              Telnet, NASI etc.
   6   HD     Character Mode Half Duplex.  Used for hosts which do
              not echo, eg Sorters.
   7   SYS12  Use for normal System-12 access.
   8   IOIM   Used for slow baud rate TW ports, eg directly
              connected to RSS's.
   9   BFD    Block mode Full Duplex.  Used for APN-167 communications.
   A   OMI    Used for DMS, SDP, CDMA, Cisco Router terminal emulation.
   B   S12FD  Used for MPTMON communications with System-12.
     
     Modes 1 to 4, and 7 to A are Block Mode, Full Duplex.  Modes 5, 6
     and B are Character mode.


6.4  MULTIPLE OZTERM SESSIONS

     OZTERM Version 6.20 has been modified to allow multiple sessions
     to be used in an MS-Windows environment.  The number of sessions
     that can be opened and successful used depends on the PC being
     used.  For instance up to five sessions may be used with
     reasonable response timing on a 486 DX66 PC.
     
     
     6.4.1  Introduction
     
     When using Multiple OZTERM sessions it is necessary to adhere to
     the following rules:
     
       Each OZTERM session must be run from its own working directory.
       This means each session will have its own OZDVR.REF file and
       Save files, eg OZEVENTS.OZI, OZSCREEN.SVE, etc.
     
       The same port must not be selected in two different sessions.
       For example if the operator has two sessions available for
       Telnet communications via an EICON Gateway, the first port must
       not be selected in the second session if that port is in use by
       the first session.  The standard operating environment would be
       to use Telnet port one with the first session, Telnet port 2
       with the second OZTERM Session, and so on.
     
       For the best results, other "time consuming" applications
       should not be open in Windows, eg MS-Mail, MS-Access, MS-
       Remind, etc.
     
     
     
     6.4.2  Example Multiple Session Telnet (Interrupt 14)
     
     
     Following is an example for setting up a PC to run four Telnet
     sessions using XPAD or ITI14.
     
       Load the OZTERM program and support files in a suitable PC or
       LAN OZTERM directory.
     
       Load the XPAD or ITI14 program and support files in a suitable
       PC or LAN XPAD directory, eg C:\COMMS\XPAD or C:\COMMS.
     
       If you are using ITI14 go to the next step.  Edit the
       ECXPAD.INI to indicate the four virtual communication ports
       will be used with XPAD.  For example, the following lines
       should be set at the bottom of the ECXPAD.INI file:
     
               ;* define 4 com ports
               [COM1]
               [COM2]
               [COM3]
               [COM4]
     
       Ensure that NABIOS is being loaded in your AUTOEXEC.BAT or LAN
       Login script files with at least 4 sessions available, eg:
     
          LH NABIOS 5A SPX RDR /4
     
       Create four appropriate OZTERM Working directories on the PC or
       LAN Home directory, eg C:\OZ_1, H:\COMMS\OZ_1, etc.
     
       Create four Batch files which load the appropriate programs and
       select the correct working directories.
     
       The example below will use a common ECXPAD.INI file in the XPAD
       directory and run OZTERM from a common directory.  The Working
       directory for the example is "C:\OZ_1":
     
              C:
              cd \OZ_1
              castoff
              PATH=C:\COMMS\XPAD;%PATH%
              SET ECXPAD=C:\COMMS\XPAD
              ecxpad start
              c:\ozterm\ozterm.exe b=201 x=C:\OZTERM\CMDS\CONNECT.CMD
              ecxpad stop
              caston
              cd \
     
       The example below is for ITI14 using virtual COM port 2, ie the
       first Telnet port.  The batch file will run ITI14, KILLITI and
       OZTERM from a common directory.  The Working directory for the
       example is "C:\OZ_2":
     
              C:
              cd \OZ_2
              castoff
              c:\comms\iti14 5a COM2
              c:\ozterm\ozterm.exe b=201 x=C:\OZTERM\CMDS\CONNECT.CMD
              c:\comms\killiti
              caston
              cd \
     
       Create four Windows PIF files which run the associated Batch
       files, eg OZ_1.PIF will call OZ_1.BAT, OZ_2.PIF will call
       OZ_2.BAT, etc.  For example:
     
           [SEE OZTERM USER GUIDE TP1282]
     
     The suggested "Advanced" options are:
     
           [SEE OZTERM USER GUIDE TP1282]
     
       Create the four new Program Items in an appropriate Windows
       Group.
     
       Select each of the new Icons in turn and press "I" to install
       boards if the OZDVR.REF file hasn't already been created.
       Configure the Boards and Ports for four Telnet sessions (refer
       Section 6.2).
     
       Re-open the four OZTERM sessions in turn and select the first
       Telnet port in the first session, the second Telnet port in the
       second session, etc.  This ensures that each session is started
       on the correct port to prevent clashing.
     
       To use a common SEL_???.TXT file with the standard Connect
       Script files you may do the following:
       
       1.Select and copy a suitable SEL_???.TXT file from the main
          OZTERM\TEXT directory to the main OZTERM\CMDS directory.
       
       2.Edit your SEL_???.TXT file adding the appropriate Mode,
          Device, AUSTPAC addresses, and setting Sorter Flags to "X"
          and "P", but leaving "?" in the "Prt" and "COMbaud" columns.
          For example:
       
       
!xge-name      Lncd     APT CCR Bmd Prt COMbaud      ModeDev  Connect-string       Sorter!
!--------------Metro-----|--|--|----|---|------------|---|----|--------------------Flag!
Sample Exch    SAMP      ?  ?  ?    ?   ?            IOG NEM  SAMP                 ? ?
       
       
       3. Copy the sample LOCAL.C file to the four new Working
          directories.
       
       4. Edit the LOCAL.C file ensuring the correct Working and
          Logging paths are selected, eg "C:" and "\OZ_1" etc.  Set
          the Default port settings according to the session being
          configured.  For example, assuming the Telnet ports have
          been set up as the first four ports on the PC, for the first
          session in C:\OZ_1 directory:
       
       
            ! Data Comms line conditions defaults for SEL_???.TXT
            @SET _dfltbaud = "9600,8,NONE"
            @SET _dfltmode = "FD"
            @SET _dfltport = "1"
       
       
          The second session will have _dfltport set to 2, etc.  This
          means that the same destination may be selected from any of
          the sessions, but the connection will be made only via the
          port associated with that session.
       
       5. A copy of the INT14.DAT file may be required in each working
          directory if the operator is running on the C: drive, and a
          search path hasn't been set to the OZTERM program directory
          using the DPATH program.  If operating in the LAN
          environment, and the OZTERM program directory is set as one
          of the search paths, one copy of INT14.DAT may used in the
          Central OZTERM program directory.
       
       6. To run all four sessions simultaneously, select each Icon in
          turn.  Start the required job in each session, ensuring no
          clashes will occur, ie trying to perform the same function
          in the same host (Exchange).
       
       7. To ensure Windows allocates equal "time slices" to each
          OZTERM session, run all the sessions in the background.
          That is, leave the four sessions Windowed on the screen and
          select the Program Manager Icon.
     
          
                                   
                           7.  LOGGING MENU
                                   

7.1  GENERAL DESCRIPTION

     To set up logging to a disk file or logging to the printer select
     the "LOGGING Menu".  Any disk log file opened or Printer Logging
     selected applies only to the active port.  Where the background
     logging feature is required, the external device driver must be
     used (Refer section 2.2 and 7.3).
     
     These Background logging conditions remain active  even if OZTERM
     is terminated and restarted.  Although, nothing is logged when
     the PC is not running.


7.2  LOGGING MENU - (Alt L)

     7.2.1  Open Log File (Alt L, O)
     
          Select this option and a drop down menu will prompt you for
          the disk log file name for the current port.  If the Log
          file already exists the operator is given the option to
          append or overwrite the exiting file.  Field 6 on the status
          line at the bottom of the screen will indicate the first
          eight characters of the if disk log name.
          
          
     7.2.2  Close Log File (Alt L, C)
     
          Select this option and the log file for the current port
          will be closed.
          
          
     7.2.3  View Log File (Alt L, V or Alt V)
     
          Allows viewing of the log file for the active port with or
          without closing the log file.  Select the port first, from
          the "PORTS Menu", then Alt V  or  via this menu.
          
          
     7.2.4  Printer on/off (Alt L, P or Ctrl F6)
     
          Selecting this option turns the printer on or off.  Field 8
          at the bottom of the screen displays PRINT if the printer
          option is active.  Any data which is then received will
          automatically be sent to the selected printer.
          
          
     7.2.5  Status (Alt L, S)
     
          Shows the status of the log files for each port in relation
          to buffer status, etc.  Flush buffers will write the
          contents of the screen buffer to the log file.  Reset ports
          will reset any errors, and ESC will return to the Main
          screen.
          
          

7.3  BACKGROUND LOGGING


     Background Logging allows the storage to disk of all information
     coming in on particular ports, whether or not OZTERM is running
     (but not while the PC is not running).  It can be set up to
     survive a re-power or re-boot of the PC (by adding to the
     AUTOEXEC.BAT file).  Even if the PC has only one communications
     port background logging can be useful, in that the PC can be used
     to do things other than OZTERM related while still logging from a
     port.
     
     To Set Up Background Logging (substitute path and file names to
     match the local set-up) :
     
     1.   Edit the CONFIG.SYS file to add the following
     
               FILES=20
               DEVICE=\OZTERM\OZDVR.COM R=\OZTERM\OZDVR.REF
     
     2.   To survive power failures and PC re-boots edit the
          AUTOEXEC.BAT file to include the following
               CD \OZTERM
               REM bootlog.cmd is an OZTERM transmit file with only
               @QUIT in it.
               OZTERM x=cmds\bootlog.cmd
               CD \
     
     3.   Start OZTERM and select PORTS menu (ALT P), choose Install
          boards from the PORTS menu.
     
     4.   In the Install menu select Edit Board config.
     
     5.   For the appropriate port, TAB across to the background
          logging field and change N to Y.
     
     6.   Press ESC to quit the Edit Board config menu.
     
     7.   Select Edit Port Data menu from the Install menu.
     
     8.   Select the appropriate port and TAB to the Disk Log field.
          Press "D"  to select "Disk logging on at boot up" option
          (this changes the 0 to a 1 in the field.  A zero in this
          field will turn logging off when OZTERM is started.
     
     9.   TAB to Disk logging filename field and nominate the
          directory and file name you wish to log to in the background
          (eg. C:\OZTERM\BACKGND.LOG).
     
     10.  Press ESC to quit Edit Port Data menu.
     
     11.  Press ESC to quit Install Board menu.
     
     12.  Select Y to save the new OZDVR.REF file.  NOTE:  OZTERM will
          remind you to edit the CONFIG.SYS file and install the
          device driver as in 1 above.  Press enter and OZTERM will
          terminate.
     
     13.  If you have edited your CONFIG.SYS or the AUTOEXEC.BAT file
          re-boot your PC.
     
     
     Please note that with these settings the foreground log in use
     when OZTERM is running will be the same as the background log
     file.  Therefore if the Log file is closed and another selected
     in the foreground logging, the background logging will cease on
     that port until the PC is re-booted and the Driver and reference
     file is reloaded.


                                   
                           8.  UTILITY MENU
                                   

8.1  GENERAL DESCRIPTION

     
     OZTERM Utilities are extra features that have been added to
     OZTERM to assist the operator with normal operations.
     

8.2  UTILITIES MENU - (Alt U)

     8.2.1  B no analysis
     
          This application will trace a B-Number through the AXE B
          number analysis, Routing Analysis, and displays the first
          choice route.  The application assumes that the PC is
          already connected to the host that is to be interrogated.
          
          When this application is run a Script file OZBNUM.UTL is
          invoked.  The operator is required to enter an initial B-
          Origin (default is 0) and a B-Number or partial B-Number to
          trace.  The operator may also to check the data in the B-
          Number Non-operating Area by adding the parameter "NOP" in
          the "Operating Area" box.
          
          TAB or Shift TAB between the boxes and enter the required
          data.  When data entry is complete, press enter and the
          Script file will  commence tracing the B-Number through the
          host data.
          
          If a choice of End-of-selections, Route Cases or Route names
          exists the Script file will always select the first in the
          list.
          
          
     8.2.2  List corrections
     
          This application searches up the screen for the last
          appearance of the print-out heading "PROGRAM CORRECTIONS".
          If the print-out is found a transmit file OZLCOR.UTL is
          invoked.  The appropriate PCODP, PCOSP, PCEUP and PCESP
          commands are then entered for each  correction.
          
          
     8.2.3  Hex Calculator (Alt C)
     
          A pop up calculator  to perform hexadecimal to decimal
          conversions.  The calculator handles up to 32 bit
          Hexadecimal numbers.  The 32nd bit is used for the sign, ie
          if bit 32 is marked to 1 the sign is negative.  Data may be
          entered in the hexadecimal or decimal fields for conversion.
          The Base value may also be changed (default Base 32) to get
          the Modulus and Remainder values.
          
          
     8.2.4  Restart Monitor
     
          This function will allow a PC running OZTERM to monitor all
          ports which have restart data directed at it.  The program
          will create a log file and store any restart data it
          receives, in a unique file.
          
          
     8.2.5  General Utilities  (Alt G)
     
          This function calls the Script file OZGENERL.UTL which may
          be set to any local application.
          
          
     8.2.6  Write CMD History to File
     
          This function writes the command history stack to a file
          specified by the user (default file name is CMDHIST.TXT).
          
          
     8.2.7  Copy File to CMD History
     
          This function copies a user specified file to the command
          history stack (default file name is CMDHIST.TXT).
     
     

                                   
                            9.  ACTION MENU
                                   

9.1  GENERAL

     The Action Menu provides access to the Autodial Site Menu and
     various Control codes which may be required to Logon, Logoff,
     release, etc on some links.
     
     A link is a communication path between the OZTERM program and a
     distant host.  It may include a dial up modem, Datagates, LAN's
     or MDX data switches.  Some links require specific control codes
     to effect a connection or disconnection depending on the type of
     medium used (ie Datagate, NASI, Telnet, etc).
     
     OZTERM can support different types of links.  The data for the
     direct link used for each  destination can be  held in the
     autodial file (eg AUTODIAL.OZI) or in the SEL_???.TXT files (see
     SEL_WA.TXT as an example).  These files contain all the
     information required to establish the link.
     
     The autodial option gives menu access to various sites.  Using
     the autodial selection allows the user to connect to a distant
     exchange through Datagates, Essnet direct links, etc.  Then
     OZTERM changes to the correct terminal mode, when the connection
     is established.  This data needs to be created by the user via
     the SETUP Menu (Alt S, D).  Refer to section 17.1 for the data
     entry.
     

9.2  ACTION MENU - (Alt A)

     9.2.1  Autodialling
     
          Select the Auto-dial option from the Action menu.  A menu of
          the available links will be displayed from your AUTODIAL.OZI
          file.  Move the highlight bar to select the link required
          and press enter.  The host connection will be attempted
          using the Login's, etc set in the AUTODIAL.OZI file.
          
          
     9.2.2  Logon (Alt A, L or Ctrl F2)
     
          Once  the  link to the host is established you can  start  a
          session by selecting the LOGON option.  Commands can then be
          sent to the host.
          
          
     9.2.3  Logoff (Alt A, O or Ctrl F3)
     
          Will logoff from the Host using the appropriate command
          according to the current port emulation, eg sending a Ctrl D
          to the exchange if in TW mode, or LOGOF; if in AOM mode.
          
          
     9.2.4  Interrupt Print-out (Alt A, I or Ctrl F10)
     
          Interrupts print-out being received from the host by sending
          a Ctrl D to the exchange if in TW or IOG11 mode, or @ if in
          AOM mode.
          
          
     9.2.5  Hard Break (Alt A, H or Ctrl F9)
     
          Sends a 200 millisecond line loop break.


     9.2.6  Release Modem/NASI(Alt A R or Alt F9)
     
          Will release the modem connection, ie breaks the DTR lead,
          or releases as NASI connection and returns the port to the
          NASI prompt.
          
          
     9.2.7  Send ESC (Alt A, S or Alt K)
     
          Sends an ESC character to the current port.
          

                                   
                           10. MODULES MENU
                                   

10.1 GENERAL DESCRIPTION

     OZTERM supports AXE B Module Command, Print-out and Fault Code
     descriptions.
     
     The AXE B module can be displayed in split screen or full screen.
     The "B" Module information can be accessed by two methods:
     
          Position the cursor on the command, fault code or print-out
          description and press Alt B.  The program automatically
          detects whether it is a command, Fault Code or print-out
          description.  Where a command description or Fault Code is
          required the prompt must be present.
     
          Using the Module Menu, refer section 10.2.
     
     The electronic B Module version plus the alphabetical list of the
     commands or the alphabetical list of the printout descriptions
     can be obtained by the following method:
     
        While in one of the AXE terminal emulation modes, enter:
     
          <INDEX Alt B for the B-Module command version and list of
             commands; or
          
          INDEX Alt B  for the B-Module printout description version
             and list.
     
        Using the Module Menu, refer section 10.2.
     
     Once in the description when the module is open only in the top
     window;
     
          Ctrl F7   scrolls the text up one line at a time.
          Alt F7    pages up the text a page at a time.
          Ctrl F8   scrolls the text down one line at a time.
          Alt F8    pages down the text one page at a time.
          Alt N     toggles between small window and full screen.
     

10.2 MODULES MENU - (Alt M)

     When using the CONNECT.CMD or CONNEXCH.CMD Standard transmit
     files, the relevant B module is selected automatically providing
     the correct information is in the exchange configuration file
     (refer SEL_WA.TXT as an example).
     
     When using the CONNEXCH.CMD transmit file to select your exchange
     when connected to the AOM, the B module directory path is set by
     the information in the AOM_???.TXT file which is used by
     CONNEXCH.CMD.  This transmit file is automatically loaded to the
     F8 function key.  When it is necessary to edit this AOM_???.TXT
     file, refer to the INSTALL1.TXT file.
     
     The B-Module directory may also be selected using:
     
          the @BMODDIR Script command; or
     
          manually by typing in the path in the Module directory menu,
          or using the F1 key and navigating to the appropriate
          directory using the file manager.
     
     
     10.2.1  Command description (Alt M, C or Alt B)
     
          When you select the COMMAND description option on the Module
          menu a dialogue box is presented.  You can type in the
          command you require and press Enter and the command
          description is retrieved if available.  If the command
          hasn't been found in the index an error message is
          displayed, then the B-Module Command index is opened with
          the highlight bar on the nearest match.
          

     10.2.2 Fault Codes (Alt M, F or Alt B)
     
          Press Alt M, F after a Fault Code has been received, or
          position the cursor on the fault code printed on screen and
          select the Fault code option from the Module menu (Alt M, F
          or Alt B).  OZTERM will then attempt to find the Fault Code
          for the Command immediately preceding the Fault Code.
          
     
     10.2.3 Print-out Description (Alt M, P or Alt B)
     
          Place the cursor on the Print-out description header and
          select the Print-out Description option.  When you select
          this menu option you can search for the current print-out or
          type in another print-out description title.  If the Print
          out description hasn't been found in the index an error
          message is displayed, then the B-Module Print out index is
          opened with the highlight bar on the nearest match.
          
     
     10.2.4 Index of Commands (Alt M, I)
     
          Select this menu option and type in as many letters of the
          command as known and press Enter.  The B-Module Command
          index is opened with the highlight bar on the nearest match.
          
     
     10.2.5 Index of Print-outs (Alt M, X)
     
          Will list all the print-out descriptions available.  Select
          this menu option and type in as many letters of the Print
          out heading as known and press Enter.  The B-Module Print
          out index is opened with the highlight bar on the nearest
          match.
          
     
     10.2.6 Directory for B Module (Alt M, D)
     
          With this selection you can edit the path to the B Module
          files.  Alternatively you may select the directory path by
          pressing F1 and navigating to the appropriate directory
          using the File Manager.  This path may also be selected
          using the @BMODDIR Script command.
          

                                   
                           11. TRANSMIT MENU
                                   

11.1 GENERAL DESCRIPTION

     Transmit or Script files are an integral function of OZTERM.
     They may contain just Host Commands, or use the Script commands
     provided in the OZTERM environment.  This section explains the
     manual control, monitoring and execution of script files.
     
     
     11.1.1 Selecting a Transmit File
     
          To select the required file , use the following procedure:
          
               Select the Transmit menu (Alt I)
               Select the New transmit file option (Press N)
               Select a file from the existing list, or create a new
               file, or press F1 to select one using the OZTERM file
               manager.
               Ensure correct file name is displayed and press Enter
               key, and the file will be opened in the OZTERM Transmit
               file environment.
          
     
     11.1.2 Execute The Transmit File
     
          You may enter each command manually (with or without
          editing) by selecting the single step option or you may send
          all the commands automatically by selecting the Auto-execute
          option from the transmit menu.  When a file is being sent in
          the automatic mode you can press ESC to stop transmission at
          any time.
          
     
     11.1.3 Special Transmit File Notes
     
          The message "SESSION HAS BEEN LOGGED OFF" is treated as
          executed during AOM type transmit files.
          
          When a command receives a response which is interpreted as
          an error, eg AXE command is NOT ACCEPTED, the transmit file
          is halted and the following message appears on line 25 of
          the screen:
          
    "Command Failed .... Continue   Retry   B Module   Esc to Abort."
          
          The operator may then choose to:
          
            Continue with the remainder of the file;
            Retry the command that failed;
            automatically open the B-Module for ARE-11 and AXE to
            refer to the Command description; or
            Press ESC to halt the file.
          
          When an AXE command encounters FUNCTION BUSY the resulting
          action is determined by the setting specified by the
          @FUNBUSY script command.  The default action is to
          continually re-try the command.
          

11.2 TRANSMIT FILE DESCRIPTION

     The script file commands and functions are fully described in
     section 18.  Transmit files can be invoked using five methods:
     
          Setting function keys by inserting "T" in the
          Local/Auto/Transmit field of the function key programming;
     
          From the Transmit file menu;
     
          Using a text or time event;
     
          When starting or exiting OZTERM in the OZTERM.DFT file; or
     
       Using the DOS switch X= when starting OZTERM.
     
     
     The OZTERM script language enables you to:
     
          begin file loading at a specified time and date;
     
          open and close logging files;
     
          select hosts and links;
     
          check the responses from the host;
     
          display information to the operator;
     
          get information from the operator;
     
          build commands dependant upon information from the host;
     
          perform data manipulation;
     
          transmit files using ASCII or X-Modem format;
     
          and much more.
     
     

11.3 TRANSMIT MENU - (Alt I)

     11.3.1 New Transmit File (Alt I, N)
     
          This menu choice allows you to create a new transmit file or
          select a file from the existing list, or select a file using
          the File Manager.
          
          To create a new transmit file select the New Transmit file
          menu choice which will display a list of previously used
          files.  With the up or down arrow keys select a vacant file
          position and enter the transmit file name, or step to any of
          the existing files and overwrite the path and file name.
          Press key F2 to edit the file.   You will be prompted with
          edit file "xxxxx.xxx".  Press enter and a new screen will
          appear for you to start writing your transmit file.  Key F1
          will display the edit keys available.  When you have written
          the transmit file press ESC, then save and exit.
          
     11.3.2 Close Transmit File (Alt I, C)
     
          Closes a transmit file which is open.
          
     
     11.3.3 Auto Execute (Alt I, A)
     
          This menu option will automatically run the file currently
          selected in the File Transmitter.
          
     
     11.3.4 Single step (Alt I, S, or Alt N)
     
          Executes just the line of the transmit file which the
          highlight bar has currently selected in the top window.
          When this line is successfully executed the Script file will
          step on to the next line.
          
          
     11.3.5 Off-Line Test (Alt I, O)
     
          Executes the transmit file, but does not send any of the
          commands to the host.
          
     
     11.3.6 Window Open (Alt I, W)
     
          Will display the current open transmit file in the top
          window.  The following keys may be used to with the Transmit
          file window:
          
               Ctrl F7   scrolls the Script file up one line at a time.
               Alt F7    pages up the Script file a "page" at a time.
               Ctrl F8   scrolls the Script file down one line at a time.
               Alt F8    pages down the Script File one "page" at a time.
               Alt N     Executes just the line the highlight bar is
               currently on.
               
     
     11.3.7 Window Hide (Alt I, H)
     
          Will close the transmit file window, or the command history
          window.
          
     
     11.3.8 Goto Label (Alt I, G)
     
          Allows user to specify a "label" to jump to in the currently
          open transmit file.  If the label isn't found in the
          transmit file, the select bar (ie the highlight bar) will
          stop on the last line of the file.
          
     
     11.3.9 Find Text (Alt I, F)
     
          Searches forward for the specified text in the currently
          open transmit file.  If the text is found the highlight bar
          will be moved to the line containing the first occurrence of
          the text in the transmit file..
          
     
     11.3.10 Repeat Search (Alt I, R)
     
          Repeats the search for the same text as requested in the
          previous menu option in the currently open script file.
          
     
     11.3.11 Find Line Number (Alt I, L)
     
          Allows the operator to jump to  a particular  line number of
          the currently open transmit file.
          
     
     11.3.12 Edit Transmit File (Alt I, E)
     
          Opens the currently selected transmit file in the OZTERM
          editor, and automatically goes to the line in the file which
          the Transmit file highlight bar was on.
          
     
     11.3.13 waTch Variable (Alt I, T)
     
          Allows the operator to specify a variable to "watch" whilst
          a Transmit file is open.  The current value of the variable
          is displayed on line one of the Main screen
          
     
     11.3.14 Program Trace (Alt I, P)
     
          This function writes each step of a transmit file run to a
          text file.  The operator may specify any file name for the
          results of a transmit file run to be written to.  This
          function may also be invoked using the Script command @TRACE
          (see Section 18).
          
          The text file records the following information:
          
          
               The Script file name currently being run.  Any file
               changes, ie if another file is included, are also
               recorded;
          
               The line number in the script file being processed;
          
               Whether the command on the file line was successful or
               not (ie OK or FAIL);
          
               Whether the Error Flag is set, ie EF
          
               The actual command sequence being performed, and the
               logical result if applicable.  Note that some Script
               command lines which contain several command functions
               will appear on consecutive Trace file lines (eg @IF
               something THEN something) one for each function.
          
          In the example file below line 00015 is repeated three
          times, one for each function, ie one for the result of the
          VAREXIST function, the next for the logical result to the
          @IF command, and the third line for the GOTO command as the
          result of the @IF is positive.
          
          
            ***** OK      FILENAME = C:\OZTERM\CMDS\F9CONNCT.CMD
            00009 OK      CONCAT( | RESULT = C:\OZTERM
            00009 OK      @SET | {OZPATH} = C:\OZTERM
            00010 OK      CONCAT( | RESULT = C:\OZTERM\CMDS\
            00010 OK      @SET | {DIR0} = C:\OZTERM\CMDS\
            00011 OK      @SET | {DIRECT} = YES
            00012 OK      @INCLUDE
            00012 OK      CONCAT( | RESULT =
            C:\OZTERM\CMDS\DISCONNT.CMD
            
            ***** OK      FILENAME = C:\OZTERM\CMDS\DISCONNT.CMD
            00001 OK      @TITLE
            00002 OK      @SET | {VERSN} = 2.3
            00003 OK      @GOTO START
            00013 OK      @LABEL START
            00014 OK      @SET | {T_AUTO} =
            00015 OK      VAREXIST( | RESULT = 0
            00015 OK      @IF | IF_RESULT = 1
            00015 OK      @GOTO START_2
            00019 OK      @LABEL START_2
          
          
          The operator may select any file to record the Trace, the
          default is OZTRACE.LST.  Note that if the file selected
          already exists the subsequent Trace results are appended to
          the existing file contents.
          
             
                                   
                            12. SCREEN MENU
                                   

12.1 GENERAL DESCRIPTION

     The text in the Main screen may be manipulated using the Screen
     Menu (Alt R).

          Block START          Mark the start of a text block.
          K mark END           Mark the end of a text block.
          Write block          Write the block of text to a file.
          Print block          Send the Block of text to the
                               printer.
          Hide block           Remove the start and end markers.
          Find text            Search forward for text on the main
                               screen.
          Repeat find          Repeat search.
          Last commands        Open Command history stack window.
          Q send          ^Q   Send Control Q to the current port.
          S send          ^S   Send Control S to the current port.
          Y delete        ^KY  Delete the block of text from the
                               main screen.
          ^Block START    ^KB  Mark the start of a text block.
          ^Kmark END      ^KK  Mark the end of a text block.
          ^Write block    ^KW  Write the block of text to a file.
          ^Print block    ^KP  Send the Block of text to the
                               printer.
          ^Find text      ^QF  Search forward for text on the main
                               screen.
          ^Repeat find    ^L   Repeat search.
          ^Q send         ^Q   Send Control Q to the current port.
          ^S send         ^S   Send Control S to the current port.
          ^Y delete block ^KY  Delete the block of text from the
                               main screen.
     
     
     12.1.1 Printing text to the printer
     
          There are two methods for sending screen text to the
          printer.
     
          1.   Text from the host can be sent to the printer as it is
               being received.  Use the Printer On/Off option from the
               LOGGING menu, or Ctrl F6 to switch printer logging on
               or off for the current port.
          
          2.   Text that has already been received on a port or text
               from any window on the screen can be sent to the
               printer using the following steps.
               
               
                    Mark top of text using Ctrl K, B or Alt R, B
               
                    Mark bottom of text using Ctrl K, K or Alt R, K
               
                    Print marked the text using Ctrl K, P or Alt R, P
               
                    Remove the marking using Ctrl K, H or Alt R, H
               
     
     12.1.2 Exporting Text to a file.
     
          Text that has been received from a port may be exported to a
          text file by:
          
                    Mark the top of text using Ctrl K, B or Alt R, B
               
                    Mark the bottom of  the text using Ctrl K, K or
                    Alt R, K
               
                    Write the marked block using Ctrl K, W or Alt R, W
               
                    Select a file name to write the text to and enter.
               
                    Remove the marks Ctrl K, H or Alt R, H
          
                                   

                             13. HELP MENU
                                   

13.1 GENERAL DESCRIPTION

     On line help information about OZTERM can be displayed with this
     option.
     

13.2 HELP MENU - (Alt H)

     13.2.1 Help Keys
     
          Displays most of the keyboard "hot" keys.
          
     
     13.2.2 Help Document
     
          This facility provides an on-line version of the Ozterm
          Users Guide in the Ozterm Viewer.  This document is produced
          as OZTERM.TXT.
          


                                   
                          14. QUITTING OZTERM
                                   
Before quitting OZTERM, you must first disconnect cleanly from any
Device.  Usually the F10 key will be programmed to perform this
function.

When you select the Quit option from the FILE Menu or Alt X, or if
using the @QUIT Script command from a transmit file, OZTERM will
commence the exit procedure.  This consists of:

     Closing any windows such as the B-Module window;

     All logging will be terminated, except for background logging (if
     the  device driver is loaded via the CONFIG.SYS.  See the section
     on background logging);

     If the OZTERM.DFT file exists in the users Working directory, the
     functions  under the "@Label Exit" will be performed.  This  file
     may be set up to perform the F10 Disconnection sequence to ensure
     all Links are disconnected prior to the program closing;

     The  current  settings, etc are saved to the various OZTERM  save
     files,  eg  Text  and Time Events are saved to  the  OZEVENTS.OZI
     file, etc; and

     The program closes and is removed from DOS memory.


If the F10 key has not been programmed to perform the Quit function,
it is necessary to press the Ctrl F3 key.



                                   
             15. DOS Command Line Parameters and Switches
                                   

     Parameters for the OZTERM.EXE program (all are optional):


     "S"   Values :  Controls the screen display mode.  Default  value
     is "1".
     "S=0" :disables fast key rate
     "S=1" :fast screen access (IBM AT's, EGA's, VGA's)
     "S=3"  :slow  screen  updating  with  screen  blanking  to  avoid
          "sparkling". (IBM XT's with the older type CGA card)
     
          eg:  OZTERM S=0
     
     
     "C"  Values  :Controls  the colour of the  program.   Default  is
     "C=Y".
     "C=Y" :colour throughout the program.
     "C=N" :colour disabled, ie for Laptops, etc.
     
          eg:  OZTERM C=N
     
     
     "B" Values :"B=201" - "B=4500".
          Sets the maximum number of screen BUFFER LINES (default is
          1000).  This may be used to increase the amount of memory
          available for the DOS session.
          eg:  OZTERM B=500
     
     
     "A=" auto-dialling list file name (default = "AUTODIAL.OZI")
          eg:  OZTERM A=MYADIAL.TXT
     
     
     "X=" transmit file name to automatically execute when the program
          is run (Note: a file specified here will run after the
          OZTERM.DFT file has finished)
          
          eg:  OZTERM X=CONNECT.CMD
     
     
     Command line parameters may be combined as required.
     eg:       OZTERM      A=C:\OZTERM\MYADIAL.TXT      B=500      C=N
     X=C:\OZTERM\CMDS\CONNECT.CMD
     
                                   


                 16. Operation on Local Area Networks
                                   

     On a local area network such as a Novell LAN the "Program" files
     may be stored in one directory such as F:\APPS\COMMS\OZTERM and
     the "User"  parameter files, screen save and work files are
     stored in the users working directory eg. H:\USERS\FREDW.
     
     The host database and transmit files may also be  stored in a
     common directory on the LAN such as F:\APPS\COMMS\OZTERM\CMDS.
     All the transmit files that read in the data files need to have
     the path variables altered so that the data files can be found.
     These variables are located in LOCAL.DAT which is stored in the
     users working directory.  Refer to the installation instructions
     for details on setting up LOCAL.DAT to suit your local
     installation.  LAN mapping also needs to be catered for in the
     OZTERM.BAT file.  For additional information refer to APPENDIX  D
     (ie the OZSETUP.TXT, INSTALL1.TXT and INSTALL2.TXT files).
     
     If an "Async Server" is used with the LAN then start up OZTERM
     using a batch file such as OZLAN.BAT (see example below) instead
     of typing OZTERM at the DOS command line.
     
     eg.  OZLAN.BAT
     
     
     F:
     cd \apps\comms\ozterm
     taskid
     nasi /d
     ozterm B=500 x=cmds\connect.cmd
     unload
     taskid /u

     
                                   
                           17. OZTERM FILES
                                   

17.1 OZDVR.REF  PORT Board Reference File

     The structure of the reference file "OZDVR.REF" is shown below.

 |----------------- Base address
 |    |------------ Arnet latch address or 2nd port address
 |    |   |-------- IRQ
 |    |   | |------ No. Ports/Board
 |    |   | | |---- Board Type
 |    |   | | | |-- Device Driver
03F8 0000 4 1 0 N  <= Board 1 {Logical port 1 or ports 1 & 2 or ports 1 to 8}
02F8 0000 3 1 0 N  <= Board 2 {Logical port 2 or ports 3 & 4 or ports 9 to 16}
0000 0000 0 0 0 N  <= Board 3 {Logical port 3}
0000 0000 0 0 0 N  <= Board 4 {Logical port 4}
1 (** 0 No. HEX ** total number of ports.  Logical Ports 1 to 16 setup follow:-)
WLTM     COM5     5 0 7 0 1 8 C:\OZTERM\aom.log
PERX     COM6     2 1 4 2 1 7 C:\OZTERM\LOG\port2.log
port3    COM7     2 0 4 2 1 7 C:\OZTERM\
port4    COM8     2 0 4 2 1 7 C:\OZTERM\
port5    COM9     2 0 4 2 1 7 C:\OZTERM\
port6    COM10    2 0 4 2 1 7 C:\OZTERM\
port7    COM11    2 0 4 2 1 7 C:\OZTERM\
port8    COM12    2 0 4 2 1 7 C:\OZTERM\
port9    COM13    2 0 4 2 1 7 C:\OZTERM\
port10   COM14    2 0 4 2 1 7 C:\OZTERM\
port11   COM15    2 0 4 2 1 7 C:\OZTERM\
port12   COM16    2 0 4 2 1 7 C:\OZTERM\
port13   COM17    2 0 4 2 1 7 C:\OZTERM\
port14   COM18    2 0 4 2 1 7 C:\OZTERM\
port15   COM19    2 0 4 2 1 7 C:\OZTERM\
port16   COM20    2E0 4 2 1 7 C:\OZTERM\
^        ^        ^^^ ^ ^ ^ ^ ^
|        |        ||| | | | | |-- default logging filename (20 characters)
|        |        ||| | | | |---- word length 7 or 8
|        |        ||| | | |------ stop bits 1 or 2
|        |        ||| | |-------- parity 0 nil, 1 odd, 2 even
|        |        ||| |---------- baud (0-9: 110, 150, 300, 600, 1200, 2400,
|        |        |||                      4800, 9600, 19k2, 38k4)
|        |        |||------------- disk logging at power up (1 = yes 0 = no)
|        |        ||-------------- E = ESSNET connection
|        |        |--------------- mode (1 = AOM    2 = TW
|        |                               3 = IOG11  4 = MNOSS
|        |                               5 = CH FD  6 = CH HD
|        |                               7 = SYS12  8 = IOIM  )
|        |------------------------ DOS  port name (1 to 8 chars-DON'T CHANGE!)
|--------------------------------- LNCD port name {Logical Ports 1 to 16}


For physical port details, refer to section 2.1 or port setup menu.


NOTES:

     For non-installed boards (lines 1-4), set all addresses and
     values to 0's.

     Driver names (Col 10, lines 6-21) are COM5 to COM 20 - DO NOT
     CHANGE  THESE!


    17.1 OZDVR.REF  PORT Board Reference File Structure (Continued)

     17.1.1 Communication Board Type
     
     
        0 = normal COM port board
        1 = Arnet Multi-port 8 board, or COM4 Allaw series 4 port card
        2 = Shared interrupt board such as HS-4 four port board
        3 = NASI interface over NOVELL async. server, or Telnet session.
        4 = Telnet interface to an EICON Gateway.


     17.1.2 Device Driver Flag
     
          "N" for the internal program device driver.
          "Y" for external device driver in CONFIG.SYS


     17.1.3 Logical Number of Ports
     
          This field is zero numbered hex eg "0" for one port, "F" for
          sixteen ports.  Set this to the minimum to conserve memory.


     17.1.4 Terminal Emulation Modes
     
          Mode 1 = AOM
          Mode 2 = TW
          Mode 3 = IOG11
          Mode 4 = MNOSS
          Mode 5 = FD
          Mode 6 = HD
          Mode 7 = SYS12
          Mode 8 = IOIM
          Mode 9 = BFD
          Mode A = OMI
          Mode B = S12FD


     17.1.5 Baud Rates
     
          1=150 bps, 2=300, 3=600, 4=1200, 5=2400, 6=4800, 7=9600,
          8=19200, 9=38400


     17.1.6 Default Disk Log File names
     
          Must include full drive/path/file name.


     17.1.7 Disk Logging at Power-up
     
         Flag set to 1 enables disk logging when OZTERM is first
         started, default is 0, ie no logging at start of OZTERM.


     17.1.8 Essnet
     
          Flag indicates whether or not the port is connected to the
          ESSNET network.


17.2 AUTODIAL.OZI  AUTODIAL Reference File


     The default file name is AUTODIAL.OZI.

!--------------------------------------------!
!        AUTODIAL - CONFIGURATION FILE       !
!--------------------------------------------!

MAX_AD_PTR=0002
LNCD,1=vllx    The Location Code for the destination.
MODE,1=5       Terminal mode for the destination (ref. )
TELENO,1=      The telephone number of the destination modem if Normal
               dialling.
SPEED,1=4      The port speed (baud rate) to use when connected to the
               destination (ref ).
DATANO,1=7     The number of data bits to use when connected to the
               destination (ref ).
MODEM,1=H      Modem (H = Hayes Dialling, N = Normal Dialling, T =
               Transmit File).
DGATE,1=N      The type of Datagate Connected (S = SA Type, Q = Qld
               Type, N = No Datagate, K = Keylink, T = Transmit File).
DG_PWORD,1=    The Datagate password.
HAYES,1=ATDT   Hayes Dialling String (eg. ATDT#######).
QLOGIN,1=      Contains Login if Qld Datagate selected
QPASS,1=       Contains Password if Qld Datagate selected
QOPTION,1=1
FILENAME,1=E   The file name called if the Filename option is used.

LNCD,2=
MODE,2=5
TELENO,2=
SPEED,2=4
DATANO,2=7
MODEM,2=H
DGATE,2=Q
DG_PWORD,2=
HAYES,2=ATDT
QLOGIN,2=
QPASS,2=
QOPTION,2=1
FILENAME,2=

!------------End Of File Parameters----------!
     
     The first entry (MAX_AD_PTR) in this file is the number of
     AUTODIAL destinations (addresses) which are defined. Following
     this entry are the details of each destination address for which
     the following information is recorded.
     
     

17.3 OZTERM.DFT  OZTERM Entry/Exit File

     The file OZTERM.DFT has been created to run every time OZTERM is
     started, and when exiting the program.  This file runs before any
     file nominated with the "X=" parameter used when invoking OZTERM,
     eg  OZTERM X=C:\OZTERM\CMDS\CONNECT.CMD.  The file is also run
     when exiting the OZTERM program, ie either Alt X, or Alt F, X,
     and completes the functions in the file before the program is
     closed.
     
     OZTERM.DFT uses two Fixed labels to determine which part of the
     file to run, ie the ENTRY label for starting OZTERM, and the EXIT
     label when closing down the program.  For example:
     
          @LABEL ENTRY
            @COMMENT('OZTERM FIRING UP')
            @SCREENTIMEOUT(5)
          @STOP
          
          @LABEL EXIT
            @INCLUDE('CMDS\DISCONNT.CMD')
            @COMMENT('OZTERM CLOSING DOWN')
          @STOP
     
     In the example above the file will display the comment OZTERM
     FIRING UP on the Main screen, and set the screen time out for 5
     minutes whenever OZTERM is started.
     
     When the OZTERM is exited the script file CMDS\DISCONNT.CMD is
     run to ensure no ports have been left connected, and displays the
     comment OZTERM CLOSING DOWN on the Main screen.
     


17.4 OZTERM.STO  OZTERM Screen Timeout File

     The file OZTERM.STO has been created to run every time the Screen
     Times out in OZTERM.  This is a Script file which can be used to
     call other Script files, eg  CMDS\DISCONNT.CMD, to run whenever
     there has been no activity on the Port for the specified time
     interval set in Screen Timeout (see Set-Up Menu).  For example:
     
            @INCLUDE('CMDS\DISCONNT.CMD')
            @COMMENT('Screen Has Timed Out')
          @STOP
     
     In the example above the file CMDS\DISCONNT.CMD will be run, the
     comment Screen Has Timed Out will be displayed on the Main
     screen, and then stop.
     


17.5 OZ******.CAT  SUBSCRIBER Category Files

     The transmit file CONNECT.CMD will automatically select the
     Subscriber Category file as indicated in the exchange
     configuration file (eg.  SEL_WA.TXT).  This transmit file
     automatically loads F9CONNT.CMD to F9 when used.  All
     destinations other than the AOM must use the transmit file to
     ensure the correct Subscriber Category file is selected.  The
     following files have been provided:
     
        OZAPT12C.CAT /A4 APT12 data, CCR available.
        

17.6 OZTERM.IOP  Dangerous Command Files

     The OZTERM.IOP files contain a dangerous command listing.  There
     is an IOP file for each application system located within the
     appropriate B module directory.  If a dangerous command relating
     to any application system is sent to an Exchange, a  window opens
     displaying a message stating why the command is dangerous and
     will ask if you wish to enter the command.
     
     The OZTERM.IOP file is automatically loaded by OZTERM when the
     operator selects a Port which has a B Module directory selected.
     the operator changes the B Module directory either by Menu
     selection or via Transmit Script command @BMODDIR the new
     OZTERM.IOP file is automatically loaded into memory.
     

17.7 OZENCODE.COM  OZTERM Transmit File Encoder

     The OZENCODE.COM file is a DOS program that has been provided to
     enable the users to encode transmit files (eg the NASM System
     Event files).  This means the files cannot be readily altered by
     anyone except the author with the source file.  OZTERM will
     automatically interpret the encryption and convert the file back
     to flat text whilst running the file in the Transmit file Menu.
     
     To encode a file the program requires both a source and a target
     file must be specified.  For example, to encode the file
     SCRIPT.TXT and produce the file SCRIPT.CMD do the following:
     
     At the DOS prompt type the following and enter:
     

     OZENCODE SCRIPT.TXT SCRIPT.CMD

     
     This will produce the encoded file SCRIPT.CMD, which when run in
     the Transmit File Menu will operate in exactly the same manner as
     the SCRIPT.TXT file.
     
                                   

                   18. TRANSMIT FILE SCRIPT LANGUAGE
                                   

18.1 GENERAL DESCRIPTION

     The  script  language  is an internal programming  language  that
     allows "intelligent" transmit files to be executed.  The user can
     write  customised menu driven interactive transmit file  programs
     to  perform AXE, System-12, etc tasks without  having  to
     manually type in any host commands.  The language uses variables,
     arrays,  expressions, conditional jumps, subroutines  and  simple
     arithmetic, as well as Bitwise operators and Boolean algebra.
     
     Transmit files are converted to upper-case at execution time,
     except for string constants.  Transmit file lines can be up to
     255 characters long.
     
     This section of the manual is divided into the following
     subsections:
     
          18.1 This description.
          
          18.2 Script language variables and constants.
          
          18.3 Script language command descriptions.
          
          18.4 Script language function descriptions.
          
          18.5 Script language list sorted into Common Functionality.
          
          18.6 Script language command index.
          
          18.7 Script language function index
          
          18.8 Comparison of OZTERM V5.1 to OZTERM V6
     
     

18.2 SCRIPT LANGUAGE OVERVIEW

     variable
 
          A variable whose value is assigned by commands @INPUT, @SET,
          @READ etc.
          Variable values (contents) maximum 255 chars
          Variable names maximum 10 characters long, and are not case
          sensitive.
          Unlimited (except by memory) number of variables are
          allowed.
          Eg  @SET VAR1 = 1234
          
          
     "string constant"
 
          String constants must be enclosed in single ('   ') or
          double ("    ") quotes.

          Eg   @SET VAR2 = 'John CITIZEN'
          
     
     #number
 
          For defining decimal non printing ASCII characters,

          Eg   @SEND(LINE,#13,#10)  Where #13 is Carriage Return and #10
                                    is Line Feed.
          
     $number
 
          For defining hexadecimal non printing ASCII characters,

          Eg   @SET CR = $0D        Where $0D is Carriage Return.
          
     
     ARITHMETIC OPERATORS allowed are + - * /   .
 
          Expressions may be enclosed in ( ) pairs and include
          functions.

          Eg   @SET VAR3 = ((3*3) + (4*4) - 1) / 2
          
     
     BOOLEAN OPERATORS allowed are AND, OR, XOR, and NOT.
 
          Expressions may be enclosed in ( ) combinations and include
          functions.

          Eg   @IF NOT((POS("Variable",data)) AND (X = 3)) THEN GOTO
                                                               Label
          
     
     BITWISE OPERATORS allowed are & , | and ^.
 
          Expressions may be enclosed in ( ) combinations and include
          functions, where:
          
          &    is a Bitwise AND operator, eg  @IF (3 & 3) THEN ....
          |     is a Bitwise OR operator, eg  @IF (0 | 1) THEN ...
          ^    is a Bitwise XOR operator, eg @IF (0 ^ 1) THEN ...
          
          Eg   @IF ((Var1 & 3) AND (Var2 | Var3)) THEN GOSUB Sub_rtne
          
     
     NUMERIC RANGE
 
          The decimal number range handled by OZTERM and the script
          language is from      -2,147,483,648 to +2,147,483,647.
          The "signed" hexadecimal number range handled by OZTERM and
          the script language is from 80000000 to 7FFFFFFF.
          
     
     LABEL
 
          A label can be up to 10 characters excluding White Space,
          ')', ','., and any operators, eg "+"
          Labels are not case sensitive.
          
     
     Variable Substitution
 
          Variables may be substituted into script file host commands,
          or text strings at run time by enclosing the variable name
          in a pair of { }.  Variable substitutions occur before the
          script command is executed.

          Eg. @SET SNB = 9876543
               @COMMENT("Dial {SNB} to test the circuit")
          
     
     Host Commands
 
          Host commands are not interpreted by the script file
          processor except for variable substitutions.  Host commands
          are sent to the host using the currently set terminal mode.

          Eg. @SET SNB = 9876543
               SUSCP:SNB={SNB},LIST   ! Get the category ;
          
     
     Functions
 
          Script language functions may be included in expressions and
          may  be  nested.  Functions related to Text or  Time  Events
          relate specifically to the transmit file that they occur in.
     
     Arrays

          The script language implements single dimension arrays using
          a base name and an index.  Array indices need not be
          numeric.  Variables used as array indices with or without
          the [ ] brackets must be enclosed in { }.  OZTERM treats
          each array element as a new variable.  This means that space
          is not wasted by sparsely filled arrays (eg. if an array "A"
          used only elements 1 and 25, no space would be wasted for
          the elements A[2] to A[24]).  Note that this means that the
          full expansion of an array (eg. ARRAY[{LRD}]) including the
          [ and ] must not exceed the length limit for variable names.
          
          OZTERM does not directly support multi-dimensional arrays.
          They can however be 'simulated' by separating the indices
          with a character not included as a part of any index such as
          an '_'.  Again, the overall expansion of an array must not
          exceed the length limit for variable names.
          
          Where array names do not conflict with other variable names,
          there is no need to use the [ and ] brackets.
          
          Eg   @SET VAR = ARRAY[12]
               @SET INDEX = 5
               @SET HOST = EXCH[{INDEX}]
               @SET X = 3
               @SET Y = 5
               @SET TABLE{X}_{Y} = X * Y
               @SET XY = ARY[{X}_{Y}]
          
     Syntax

          Every script statement must conform to a legal syntax as
          specified by the SYNTAX section of each command and
          function.  This syntax section uses the following notation :
          
          [ xxx ] The parameter between the square brackets is
                  optional.  The square brackets are not typed in the
                  script statement.
          
          { xxx } The parameter between the curly braces is optional,
                  but can be repeated as often as required by the
                  statement.  The curly braces are not typed in the
                  script statement.
               
          In addition, the following list details the meaning of the
          abbreviations used for the syntactic elements of each
          command and function :
          
          ArithOp      '+', '-', '*', or '/'
          BooleanOp    'AND', 'OR', 'NOT', or 'XOR'
          BitwiseOp    '&', '|', or '^'
          DefinedVariable
                       Up to 10 characters
                       identifying a previously defined variable as
                       specified by a VariableExpr.
          Expr         ScriptExpr { ArithOp ScriptExpr }
          LabelExpr    Up to 10 characters excluding WhiteSpace, ')',
                       and ','.
          ScriptExpr   [ + or - ] SimpleExpr
          SimpleExpr   ScriptFunction, or  ( Expr ), or  Number, or
                       String
          VariableExpr Up to 10 characters identifying a variable
                       which may or may not already exist.  The
                       identifier cannot include ArithOp's,
                       WhiteSpace, '<', '=', '>', ')', or ','.





18.3 SCRIPT LANGUAGE COMMAND DESCRIPTIONS

!                                                               !

          SYNOPSIS
     
          !
          
          
          SYNTAX
     
          !
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          When an "!" is the first character on a line, then the whole
          line is treated as a comment.  If elsewhere on the line
          indicates the text following is a remark.
          
          
          EXAMPLE
     
          
          
     @LABEL START
     
     ! Open a window
     @HIDE
     @WINDOW
     @CLRSCR
     
     ! Wait for a key to be pressed
     @INKEY()
     
     ALSTP! Get Alarm Status;
     @WINDEND





18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

!$$$$!                                                     !$$$$!

          SYNOPSIS
     
          !$$$$!
          
          
          SYNTAX
     
          !$$$$!
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          This indicates end of sub-file.  When executed the transmit
          file is halted but not closed.  If the file is an included
          file, the Transmitter will return to the host file, ie the
          file from which it was included.
          
          
          EXAMPLE
     
          
          
     @LABEL START
     
     @HIDE
     @WINDOW
     @CLRSCR
     @DRAW(BOX,19,4,55,6,INV,CUP,20,5,' This Function not yet
     Implemented ')
     @DRAW(HIGH,CUP,24,8,"Hit Any Key to Continue ....")
     @INKEY()
     @WINDEND
     
     !$$$$!




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@@                                                             @@

          SYNOPSIS
     
          @@
          
          
          SYNTAX
     
          @@
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          @@ is used to indicate that the rest of the line is a
          comment.  This comment may start anywhere on the line.  Note
          that if the line starts with these characters, the whole
          line is not displayed in the Transmit window.
          
          
          EXAMPLE
     
          
          
     @LABEL START
     
     @@ Open a window
     @HIDE
     @WINDOW
     @CLRSCR
     
     @INKEY()    @@  Wait for a key to be pressed
     
     @WINDEND    @@  Close the window




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@AOMPWORD                                               @AOMPWORD

          SYNOPSIS
     
          @AOMPWORD(password)
          
          
          SYNTAX
     
          @AOMPWORD(Expr)
          
          
          PARAMETERS
     
          password  - As required for AOM access.
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Automatically Sets your AOM Password in the Setup Menu for
          the @LOGON command.  This command does not set the error
          flag.
          
          EXAMPLE
     
          
          
     @@---- REQUEST AOM PASSWORD ---------@@
     @LABEL SETAOMPASS
       @INPUT(aompass,'Enter AOM Password')
       @AOMPWORD(aompass)
       @RETURN
      



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@AUTODIAL                                               @AUTODIAL

          SYNOPSIS
     
          @AUTODIAL(dest)
          
          
          SYNTAX
     
          @AUTODIAL(Expr)
          
          
          PARAMETERS
     
          dest The destination (Exchange name as specified in the
               AUTODIAL.OZI  file) that is required to be connected
               to.  This must appear in the "AUTODIAL.OZI" file.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          This connects OZTERM to the destination specified and
          changes the mode and speed to what is in the AUTODIAL
          destination data.  See Section 5.2, 9.2 and 17.2 for further
          detail.
          The error flag is set if the file is not found or the
          connection failed.
          
       EXAMPLE
     
          
          
     @AUTODIAL("ADEO")
          



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@BAUD                                                       @BAUD

          SYNOPSIS
     
          @BAUD(speed,bits,parity)
          
          
          SYNTAX
     
          @BAUD(Expr [, Expr, ParityExpr ] )
          
          where ParityExpr NONE, EVEN, or ODD
          
          
       PARAMETERS
     
          speed     can have the values 110, 150, 300, 600, 1200,
                  2400, 4800, 9600, 19200 or 38400.
          bits      optional.  Can have the values 7 or 8.
          parity    optional.  If specified then bits must also be
                  specified.  Can have the key values none, even or
                  odd, or can be an expression which evaluates to one
                  of these values.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Sets the current foreground Port Communications parameters.
          This command does not set the error flag.
          
       EXAMPLE
     
          
          
     @BAUD(9600,8,NONE)
     
     or
     
     @SET BTYPE = "1200,7,even"
     @BAUD({BTYPE})
     
     or
     
     @BAUD(2400)




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@BMODDIR                                                 @BMODDIR

          SYNOPSIS
     
          @BMODDIR(Path)
          
          
          SYNTAX
     
          @BMODDIR(Expr)
          
          
          PARAMETERS
     
          Path     The DOS path for the B module directory.  Can be a
                    variable substitution or a direct path name.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Sets the path for the B module directory.
          This command does not set the error flag.
          
          
       EXAMPLE
     
          
          
     @BMODDIR("C:\BMOD\66P27")
     
     or
     
     @SET DIR="C:\BMOD\29V00"
     @BMODDIR(DIR)




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@BREAK                                                     @BREAK

          SYNOPSIS
     
          @BREAK
          
          
          SYNTAX
     
          @BREAK
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          This will send a break condition to the line for a minimum
          of 150 milliseconds.
          This command does not set the error flag.
          
          
          EXAMPLE
     
          
          
     @TITLE "disconnect from ESSNET"
     @SET count = 0
     @WINDOW
     @LABEL RETRY
      @COMMENT('disconnecting  from ESSNET...')
      @DELAYSEC(1)
      @BREAK
      @DELAYSEC(1)
      @SEND(#9)
      @CHECK(OFF)
      @WAITFOR('HOTLINE',5)
      @CHECK(ON)
      @SET count = count + 1
      @IF count = 3 THEN GOTO END
     @IFERROR then GOTO RETRY
     @LABEL END
     @STOP
     


18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@CAT                                                         @CAT

          SYNOPSIS
     
          @CAT(classnum,catstring [, valid_flag [, customer_type [,
               normal_access [, alternate_access ] ] ] ] )
          
          
          SYNTAX
     
          @CAT(Expr, VariableExpr [, VariableExpr [, VariableExpr [,
               VariableExpr [, VariableExpr ] ] ] ] )
          
          
          PARAMETERS
     
          classnum       A numeric variable which has the particular
                         subscriber's category number (1-999) as
                         defined in D107.  The categories are obtain
                         from the file OZAPT08.CAT set up by the
                         @CATFILE command (see section 4 for further
                         information).
          
          catstring      A string variable which will have the various
                         categories written to it as a result of the
                         @CAT command, eg. BAT1&CBE11&ISE3&SSI-
                         1&TCL12.
          
          valid_flag     optional.  Set to V for a valid category, N
                         for an invalid category.
          
          customer_type  optional but if required, all previous
                         parameters are also required.  A brief
                         description of the customer type, eg, NORMAL
                         SUB, VFPB
          
          normal_access  optional but if required, all previous
                         parameters are also required.  A description
                         of the normal access permitted for this
                         category, eg. IDD-RBP, STD-CCR,STO,LOCAL,V.
          
          alternate_access optional but if required, all previous
                         parameters are also required.  A description
                         of the alternate access permitted for this
                         category, eg. LOCAL.
          
          
       RETURN VALUE
     
          The subscriber categories associated with the relevant
          category number.  Stored in the string variable "catstring".
          eg. SSI-1, TCL-11, BAT-1.  Optionally provides additional
          information describing the facilities provided by the
          specified category.
          The error flag is set if the category number is not found.


       DESCRIPTION
     
          Assigns subscriber category information to variable
          "catstring" for subscriber category number given in the
          variable "classnum".  Optionally, this command can provide a
          validity check for the requested category, a brief
          description of the service type provided, the normal access
          permitted, and the alternate access permitted.
          
          The data is retrieved from the file specified by the
          @CATFILE Script Command.  The catstring parameter, and
          valid_flag returned depends on the current terminal mode.
          The 'catfile' supports AXE category parameters.
          Error flag is set if the variable cannot be created or if
          the category is not in the file.
          
       EXAMPLE
     
          
     @DRAW(LOW,CUP,40,5,"Enter either CLASS or CATEGORY")
     @FORM(6,4,7,SNB,6,7,3,SCLASS,6,9,50,SCL,24,3,1,SCH,24,5,1,LTE,24,
     7,2,TOCG)
     @IF SNB = "" THEN RETURN
     @IF TOCG < 1 THEN GOTO START
     @IF TOCG > 99 THEN GOTO START
     @IF SCLASS = "" THEN GOTO NOCLASS
     @IF SCLASS < 1 THEN GOTO START
     @IF SCLASS > 999 THEN GOTO START
     @CAT(SCLASS,SCL)
     
     @SET MORE = CONCAT('OCG-',TOCG)
     
     @IF SCH <> '' THEN SET MORE = CONCAT(MORE,'&SCH-',SCH)
     @IF LTE <> '' THEN SET MORE = CONCAT(MORE,'&LTE-',LTE)
     @IF SCL <> '' THEN SET SCL = CONCAT('&',SCL)
     
     @SET SCL = CONCAT(MORE,SCL)
     
     @DRAW(CUP,10,9,HIGH,SCL,INV,CUP,6,10,'Changing subs category...')
     SUSCC:SNB={SNB}, SCL={SCL};
     SUSCP:SNB={SNB};
     
     or
     
     @CATFILE('OZAPT12C.CAT')
     @MODE(IOG)
     @SET cat = 100
     @CAT(cat,params,valid,type,norm,alt)
     @COMMENT('Cat {cat} -> ',params)
     @COMMENT('             ',valid,'  ',type,'  ',norm,'  ',alt)




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@CATFILE                                                 @CATFILE

          SYNOPSIS
     
          @CATFILE(file_name)
          
          
          SYNTAX
     
          @CATFILE(Expr)
          
          
          PARAMETERS
     
          file_name A File name for @CAT command to find the
                    Subscriber Category information.  Can be a
                    variable substitution or direct file name.
          
          
                    RETURN VALUE
     
          None
          
          
                    DESCRIPTION
     
          Sets File Name for Subscriber Category File.  The file name
          mus NOT include a drive or path specification.  The category
          data file must be installed in the same directory as the
          OZTERM program (OZTERM.EXE).
          This command does not set the error flag.
          
                    EXAMPLE
     
          
          
     @CATFILE("OZAPT08.CAT")
     
     or
     
     @SET FILE="OZAPT08.CAT"
     @CATFILE(FILE)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@CHDIR                                                     @CHDIR

          SYNOPSIS
     
          @CHDIR(variable/parameter)
          
          
          SYNTAX
     
          @CHDIR(Expr)
          
          
          PARAMETERS
     
          variable  A string variable holding the directory name or
                         drive.
          parameter The actual name of the directory or drive.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          This will change the program operating DOS directory to the
          stated directory or drive.
          The error flag is set if the directory does not exist, or if
          the drive is not mapped, or if access is denied.
          
          Use @IFERROR  to test result.
          
          
       EXAMPLE
     
          
          
     @CHDIR("\ROUTINES")
     
     or
     
     @SET DIRNEW = "\ROUTINES"
     @CHDIR(DIRNEW)
     @IFERROR THEN GOTO XERROR
     
     or
     
     @SET DRIVE = "G:"
     @CHDIR(DRIVE)
     @IFERROR THEN GOTO XERROR
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@CHECK                                                     @CHECK

          SYNOPSIS
     
          @CHECK(ON/OFF)
          
          
          SYNTAX
     
          @CHECK(OnOffExpr)
          
          
          PARAMETERS
     
          ON     Turns command reply checking on.
          OFF  Turns command reply checking off.  @IFERROR often used
               to check for errors.
          
          
       RETURN VALUE
     
          With command checking ON, and an error is encountered,
          OZTERM returns a banner asking the operator if they wish to
          Continue with the transmit file, Retry the command, ESC to
          halt the file or go to the B-module help.
          
          
       DESCRIPTION
     
          Enables/Disables command reply checking.
          @CHECK(OFF) clears the error flag. The default value is set
          to ON
          
          This command does not set the error flag.
          
       EXAMPLE
     
          
          
     @COMMENT("STEP 11 * Checking file FD0A1 is defined..")
     INMCT:SPG=0;
     @CHECK(OFF)
     INFIP:FILE=FD0A1;
     @CHECK(ON)
     @IFERROR THEN GOTO STEP11A        @@if not found
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@CLOSE                                                     @CLOSE

          SYNOPSIS
     
          @CLOSE
          
          
          SYNTAX
     
          @CLOSE
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Closes the disk log file that is currently open.
          This command does not set the error flag.
          
          
          EXAMPLE
     
          
          
     @SET SUBFILE = "SUBS.LOG"
     @LOG(SUBFILE)
     @CLOSE
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@CLRSCR                                                   @CLRSCR

          SYNOPSIS
     
          @CLRSCR
          
          
          SYNTAX
     
          @CLRSCR
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Clears the complete top screen if the window is open.  If
          the window isn't open, the Main screen is cleared.
          This command does not set the error flag.
          
          
          EXAMPLE
     
          
          
  @CLRSCR
  @COMMENT("         * Load 07RCB")
  @INKEY(CHOICE,"Do you wish to load 07RCB now [Y/N] ?")
  @IF CHOICE <> "Y" then GOTO 07RCBEND
  @COMMENT("*Insert disk with ^07RCB* into the ^-PC's- *A: drive and
  press ^Y")
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@CNTRLD                                                   @CNTRLD

          SYNOPSIS
     
          @CNTRLD [ ( WAIT ) ]
          
          
          SYNTAX
     
          @CNTRLD [ ( WAIT ) ]
          
          
          PARAMETERS
     
          WAIT Optional, waits for up to 4 seconds for a quiet line.
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Send the Control Character EOT (Control D) to the port, and
          waits for "quiet" line if optional WAIT parameter is used.
          Note that the WAIT parameter is NOT a variable or a number.
          It must appear as shown.
          This command does not set the error flag.
          
          
          EXAMPLE
     
          
          
     @LABEL RELTES1
     DIVAP:BNR=5, BAN=22, VLN=H0;
     @IF SCAN("00FF") <> 0 THEN GOTO RELTES2
     @DELAY(1)
     @GOTO RELTES1
     @LABEL RELTES2
     @CNTRLD(WAIT)    @@waits four seconds for a quiet line
     @WAITFOR("START")
     


18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@COMMENT                                                 @COMMENT

          SYNOPSIS
     
          @COMMENT [ ( [ par {, par} ] ) ]
          
          
          SYNTAX
     
          @COMMENT [ ( [ Expr {, Expr } ] ) ]
          
          
          PARAMETERS
     
          par  optional, may be one or more variables or string
               constants each separated by a comma.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Displays the text on the Main screen, or in the window if
          previously opened with the @WINDOW command.  If a log file
          is open the comment is also logged to file.  @COMMENT() and
          @COMMENT both generate a new line.
          
          ^    displays text in bright display Bright White
          *   displays text in dim display  Cyan
          
          This command does not set the error flag.
          
          
       EXAMPLE
     
          
          
  @INKEY(CHOICE,"Do you wish to load 07RCB now [Y/N] ?")
  @IF CHOICE <> "Y" then GOTO 07RCBEND
  @COMMENT("*Insert disk with ^07RCB* into the ^-PC's- *A: drive and
  press ^Y")
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@DEC                                                         @DEC

          SYNOPSIS
     
          @DEC(var[, count])
          
          
          SYNTAX
     
          @DEC(DefinedVariable[, Expr])
          
          
          PARAMETERS
     
          var a numeric value.
          count optional, used to set the amount to decrement by,
          default is 1.
          
          
       RETURN VALUE
     
          var - 1, or var - count if "count" is set
          
          
       DESCRIPTION
     
          Decrements NUMERIC variable "var" by the value specified by
          count.  If count is not specified, the variable is
          decremented by 1.
          If the number is less than -2,147,483,648 then it wraps
          around to 2,147,483,647.
          The "var" must be numeric, and "count" must be a positive
          numeric value.
          This command does not set the error flag.
          
          
       EXAMPLE
     
          
          
     @SET y = 28
     @DEC(Y)
     @IF Y <> 24 then GOTO MENSEL5
     
     @SET y = 28
     @DEC(Y,5)
     @IF Y > 0 then GOTO LOOP5
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@DEL5MSEC                                               @DEL5MSEC

          SYNOPSIS
     
          @DEL5MSEC(5ms_Intervals)
          
          
          SYNTAX
     
          @DEL5MSEC(Expr)
          
          
          PARAMETERS
     
          5ms_Intervals  Numeric value for the length of time in 5
                      milli-second increments.  Can be a variable,
                      string constant or literal value.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Pauses the transmit file for the specified number of
          "5ms_Intervals".
          This command does not set the error flag.
          
          
       EXAMPLE
     
          
          
     @DEL5MSEC(NUM)
     @DEL5MSEC("20")  @@ Delay for 1/10 of a second.
     @DEL5MSEC(100) @@ Delay for 1/2 a second.
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@DELAY                                                     @DELAY

          SYNOPSIS
     
          @DELAY(mins)
          
          
          SYNTAX
     
          @DELAY(Expr)
          
          
          PARAMETERS
     
          mins   Numeric value for the length of time in minutes.  Can
                 be a variable, string constant or literal value.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Pauses the transmit file for "mins" number of minutes.
          Minimum value = 0
          Maximum value = 546.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @DELAY(NUM_MINS)
     @DELAY("2")
     @DELAY(2)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@DELAYSEC                                               @DELAYSEC

          SYNOPSIS
     
          @DELAYSEC(secs)
          
          
          SYNTAX
     
          @DELAYSEC(Expr)
          
          
          PARAMETERS
     
          secs      Numeric value for the length of time in seconds.
                    Can be a variable, string constant or literal
                    value.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Pause the transmit file for "secs" number of seconds.  If
          "secs" is greater than 5 then a timer is shown on screen
          indicating when the file will start again.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @DELAYSEC(NUM_SECS)
     @DELAYSEC("31")
     @DELAYSEC(31)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@DRAW                                                       @DRAW

          SYNOPSIS
     
          @DRAW(par{,par})
          
          SYNTAX
     
          @DRAW(DrawExpr {, DrawExpr})
          
               where DrawExpr BOX, Expr, Expr, Expr, Expr
                              CUP, Expr, Expr
                              HIGH
                              INV
                              LOW
                              Expr
               
       PARAMETERS
     
          par can take on any of the following values:
          
    CUP,X,Y                  CUrsor Position at X (Column
                             position), Y (Line number), with X
                             and Y numeric values.
    LOW                      low screen attribute for following
                             text (ie. Cyan on Blue)
    HIGH                     high screen attribute for following
                             text (ie. Yellow on Blue)
    INV                      inverse screen attribute for
                             following text (ie. White on Red)
    BOX,LeftX,UpperY,RightX  draws a box at given location, where
    ,LowerY                  LeftX,UpperY gives the coordinates
                             of the top left hand corner and
                             RightX, LowerY gives the bottom
                             right hand corner of the box.
    Text                     Text to be displayed.
          
       RETURN VALUE
     
          None
          
       DESCRIPTION
     
          Allows elaborate screen output.  Any of the parameters can
          be used individually or together in a single @DRAW command.
          This command does not set the error flag
          
       EXAMPLE
     
     @HIDE
     @WINDOW
     @DRAW(box,1,2,80,24,cup,20,2,inv," Select Exchange ")
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@DTRBREAK                                               @DTRBREAK

          SYNOPSIS
     
          @DTRBREAK
          
          
          SYNTAX
     
          @DTRBREAK
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Release modem/network connection by open circuit the DTR
          lead for 1 second.
          This command does not set the error flag
          
          
          EXAMPLE
     
          
          
     @TITLE Disconnect from LAN NASI Server.
     @WINDOW
     @COMMENT('Disconnecting  LAN...')
     LOGOF;
     @DELAYSEC(2)
     @DTRBREAK
     @DELAYSEC(2)
     @STOP
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@EDITFILE                                               @EDITFILE

          SYNOPSIS
     
          @EDITFILE(File[,Line])
          
          
          SYNTAX
     
          @EDITFILE(Expr[,Expr])
          
          
          PARAMETERS
          
         File File name of the file to be edited.  May be a variable
               or the actual name of the file.
          Line Optional line number value.  May be a variable or a
          numeric value.
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Used to open a file in the OZTERM editor from a Script file.
          If the optional line number is specified the cursor goes to
          the line number specified.  Note an error message is
          generated if there isn't enough memory available.
          
       EXAMPLE
     
          
          
     @INPUT(File,'Input filename to be edited')
     @INPUT(line,'Input line number to go to')
     @EDITFILE(File,line)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@ELSE                                                       @ELSE

          SYNOPSIS
     
          @ELSE IF
          
          
          SYNTAX
     
          @ELSE IF {condition} THEN {statement}
          @ELSE {statement}
          
          
          PARAMETERS
          
          None
          
          
          RETURN VALUE
     
          None
          
          DESCRIPTION
     
          Used in conjunction with @IF and @IFERROR to allow
          consecutive testing.  When a condition has been met, the
          actions are performed according to the statement.  When the
          statement is completed, the script jumps to the end of the
          @ELSE commands so no further testing is done.  The ELSE can
          also be set with no conditions, so that if none of the
          previous conditions are met, this statement will occur.
          This command does not set the error flag
          
          EXAMPLE
     
     @SET C = 3
     @IF C = 1 THEN COMMENT('C = 1')
     @ELSE IF C = 2 THEN COMMENT('c = 2')
     @ELSE IF C = 3 THEN COMMENT('c = 3')  @@will perform this
     comment...
     @ELSE COMMENT('C <> 1')
     @COMMENT('End of Else statements')    @@...then jump to this line
          
          or
          
     @CHECK(off)
     @OPENREAD(LNCD_CHK)
     @CHECK(on)
     @IFERROR THEN GOTO XERROR
     @ELSE IF C = 2 THEN COMMENT(c = 2)
     @ELSE IF C = 3 THEN COMMENT(c = 3)
     @ELSE.....




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@ENDFOR                                                   @ENDFOR

          SYNOPSIS
     
          @ENDFOR
          
          
          SYNTAX
     
          @ENDFOR
          
          
          PARAMETERS
     
          None
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Allows the script to exit from a FOR/NEXT loop before the
          final value is reached set in the @FOR Loop statement.
          
          
       EXAMPLE
     
          
          
     
     @FOR X = 10 DOWNTO 1
       @IF X = 5 THEN GOTO EARLYEXIT
     @NEXT X
     
     @LABEL EARLYEXIT
       @ENDFOR
       @COMMENT("Finished For Loop")
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@ERASE                                                     @ERASE

          SYNOPSIS
     
          @ERASE(file_name)
          
          
          SYNTAX
     
          @ERASE(Expr)
          
          
          PARAMETERS
     
          file_name can be a variable substitution or a direct file
          name
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Erases the file "file_name".  Required prior to @LOG if
          intending to overwrite log file.  Use to prevent appending
          to a file with @WRITE.
          Error flag is set if file exists & cannot be removed
          
       EXAMPLE
     
          
          
     @SET LOGFILE = CONCAT(DIR,EMG,CNA,".pco")
     @ERASE(LOGFILE)
     
          or
     
     @ERASE("*.pco")
     @DRAW(INV,CUP,20,2,"PCORP, log file = ",LOGFILE)
     @LOG(LOGFILE)
     @IFERROR THEN GOTO LOGERROR
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@ESCKEY                                                   @ESCKEY

          SYNOPSIS
     
          @ESCKEY(ON/OFF)
          
          
          SYNTAX
     
          @ESCKEY(OnOffExpr)
          
          
          PARAMETERS
          
          ON    Enables the ESC key interrupt function.
          OFF   Disables the ESC key interrupt function.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Disables the escape key when ESCKEY(OFF).  This prevents the
          operator from using the ESC key to interrupt a transmit
          file.  The ESC key is enabled with ESCKEY(ON).  The default
          when OZTERM is started is ESCKEY(ON).
          
          WARNING:  Script author must use @ESCKEY with caution!
          
          This command does not set the error flag
          
       EXAMPLE
     
          
          
     @ESCKEY(OFF)   @@Disables ESC key interrupt
     @MENU......
     @ESCKEY(ON)    @@Enables ESC key interrupt again




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@EVDELETE                                               @EVDELETE

          SYNOPSIS
     
          @EVDELETE [ ( [label] ) ]
          
          
          SYNTAX
     
          @EVDELETE [ ( [Expr] ) ]
          
          
          PARAMETERS
     
          label     Optional, up to 10 alphanumeric characters.  Label
                    identifier within this transmit file.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Clears entries for this transmit file from the Event Tables.
          'LABEL' (optional) refers to the start point in the transmit
          file for this event.  If 'LABEL' is not specified and this
          transmit file name is used more than once in the Event
          Table, then this command will delete all the events carrying
          this file name.  If 'LABEL is specified then only the events
          set up by this transmit file and starting at the specified
          label will be deleted.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @GETDATE(NOW)
     @IF FUTUREDATE = NOW THEN GOTO DELEVENT
     @SET RESULT = TIMEEVSET("LBL",ADVANCE(NOW,10M))
     @LABEL LBL
     @@Do something useful
     @STOP
     
     @LABEL DELEVENT
     @EVDELETE("LBL")
     @STOP
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@EVSETPRI                                               @EVSETPRI

          SYNOPSIS
     
          @EVSETPRI [ ( [ label ] ) ]
          
          
          SYNTAX
     
          @EVSETPRI [ ( [ Expr ] ) ]
          
          
          PARAMETERS
     
          label     Optional, up to 10 alphanumeric characters.  Label
                    identifier within this transmit file.  The point
                    from where the file starts when it is triggered.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Gives priority to this transmit file.  No other Text or Time
          Events  will be activated until after this one has run
          again, or deleted from the Text or Time Event Menus.
          'LABEL' is optional and if specified will only start this
          transmit file at this point.  If other events exist using
          this file name but with different start 'Label's then the
          one with start point 'LABEL' is the only one with priority.
          Once the priority event has been triggered and its transmit
          file has run the priority ceases.  Now all other events can
          occur when triggered, or if a Time event should have
          happened during the time this priority event was running
          then it will proceed now (after keyboard Time-out).
          Error flag is set if label does not exist
          
       EXAMPLE
     
     @EVSETPRI("LBL")  @@ Set this event to take priority.
     @GETDATE(NOW)  @@ Get current time and set to NOW.
     @@ Create a Time event to start in (advance of) 10 Minutes from
     NOW to start at address LBL.
     @SET result = TIMEEVSET("LBL",ADVANCE(NOW,'10M'))
     @STOP
     
     @LABEL LBL
     @@ Do something useful
     .
     @STOP
          


18.3 SCRIPT LANGUAGE COMMAND DESCRIPTIONS (@EVSETPRI Continued)

          Eg. 2. This file sets up a Text Event waiting for condition
               SUBSCRIBER to be printed.  It inhibits any other
               automatic conditions from occurring and gives the
               operator control until SUBSCRIBER is printed.
          
     @@ Set this file to have priority and when triggered to
     @@ start this transmit file at LABEL TXT.
     @EVSETPRI('TXT')
     
     @@ Set up a Text Event to look for slogan SUBSCRIBER and
     @@ then run this transmit file from point TXT.
     @SET result = TEXTEVSET('TXT','SUBSCRIBER')
     
     @STOP
     
     @LABEL 'TXT'
     @@ Do useful stuff
     .
     @STOP
     
     
     

18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@EXECUTE                                                 @EXECUTE

          SYNOPSIS
     
          @EXECUTE(dos_command)
          
          
          SYNTAX
     
          @EXECUTE(Expr)
          
          
          PARAMETERS
     
          dos_commandCan be a variable substitution or a direct DOS
          command.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Exit to DOS shell then Executes a program or dos command as
          specified by dos_command, then returns to the transmit file.
          
          
       EXAMPLE
     
     @LABEL CHECDATE
     @GETDATE(LDATE)
     @SET DATE = COPY(LDATE,1,6)
     @SET TIME = COPY(LDATE,7,4)
     @SET DAY = COPY(LDATE,13,3)
     
     @COMMENT("       * Check PC time and date..")
     @COMMENT("  DATE=*{DATE}^ DAY=*{DAY}^ TIME=*{TIME}")
     @INKEY(CHOICE," Are DATE and TIME shown above correct [Y/N] ?")
     @IF CHOICE = "Y" THEN GOTO DONE
     
     @EXECUTE("date")
     @EXECUTE("time")
     @CLRSCR
     @GOTO CHECDATE
     
     @LABEL DONE
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FILECLOSE                                             @FILECLOSE

          SYNOPSIS
     
          @FILECLOSE(File)
          
          
          SYNTAX
     
          @FILECLOSE(VarExpr)
          
          
          PARAMETERS
          
          File   The file name to be closed.  May be the file name in
                 quotes, or a variable substitution.
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Closes the nominated file previously opened with @FILEOPEN.
          This command does not set the error flag
          
       EXAMPLE
     
          
          @SET fn = 'test\tfile8.txt'
          @ERASE(fn)
          
          @FILEOPEN(fn,'rw')
          @FILEWRITELN(fn,'line test')
          @FILECLOSE(fn)
          @VIEWFILE(fn)




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FILEEND                                                 @FILEEND

          SYNOPSIS
     
          @FILEEND(File)
          
          
          SYNTAX
     
          @FILEEND(Expr)
          
          
          PARAMETERS
          
          File   The file name in which to go to the end-of-file.  May
                 be the file name in quotes, or a variable
                 substitution.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Sets both the character and line pointer to the end of the
          file, eg if you want to append the data in the file.
          Error flag is set if the file is not open
          
       EXAMPLE
     
          
          
          @LABEL write
            @SET fn = 'test\tfile8.txt'
          
            @FILEOPEN(fn,'rw')
            @FILEEND(fn)
            @FILEWRITELN(fn,'new end of file')
            @FILECLOSE(fn)
            @VIEWFILE(fn)




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FILELNSTART                                         @FILELNSTART

          SYNOPSIS
     
          @FILELNSTART(File)
          
          
          SYNTAX
     
          @FILELNSTART(Expr)
          
          
          PARAMETERS
          
          File   The file name in which to go to the start of the
                 current line.  May be the file name in quotes, or a
                 variable substitution.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Sets the file pointer to the start of the current line in
          the nominated file.
          Error flag is set if the file is not open
          
       EXAMPLE
     
          
          
          @LABEL write
            @SET fn = 'test\tfile8.txt'
          
            @FILEOPEN(fn,'rw')
            @CHECK(off)
            @FILESCANCH(fn,'end of file')
            @CHECK(on)
            @IFERROR then GOTO notfound
            @FILELNSTART(fn)
            @FILEWRITELN(fn,'new end of file')
            @FILECLOSE(fn)
            @VIEWFILE(fn)




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FILEOPEN                                               @FILEOPEN

          SYNOPSIS
     
          @FILEOPEN(File[,mode])
          
          
          SYNTAX
     
          @FILEOPEN(Expr[,FileModeExpr])
          
          
          PARAMETERS
          
          File        The file name in which to go to the start-of-
                      file.  May be the file name in quotes, or a
                      variable substitution.
          Mode        Optional, 'R' - Read Only, 'RW' - Read/Write,
                      default is 'R' read only.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Attempts to open the nominated file.  Mode is optional,
          default is "R", ie Read only.  If the file doesn't exist and
          "R" mode is selected, the error flag is set.  If the file
          doesn't exist and "RW" mode is selected (ie Read/Write) a
          new file will be created.  The command fails if the path
          doesn't exist.  The error flag is also set if the file is
          already open, or if the file is not accessible (eg attempt
          to select "RW" on a read-only file).  Maximum of thirteen
          files open at one time.
          
          
       EXAMPLE
          
            @SET fn = 'test\tfile8.txt'
            @FILEOPEN(fn,'rw')
            @FILEEND(fn)
            @FILEWRITELN(fn,'new end of file')
            @FILECLOSE(fn)
          
          or
          
            @SET fn = 'test\tfile8.txt'
            @CHECK(off)
            @FILEOPEN(fn)
            @CHECK(on)
            @IFERROR then GOTO notthere




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FILESCANCH                                           @FILESCANCH

          SYNOPSIS
     
          @FILESCANCH(file,pattern[,occurrence])
          
          
          SYNTAX
     
          @FILESCANCH(Expr,Expr[,Expr])
          
          
          PARAMETERS
     
         File      may be a variable or the actual file name in
                    quotes.
         pattern   The string to be searched for.
         occurrenceoptional, numeric value may be a variable or the
                    actual occurrence required.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Searches forwards in the file for the occurrence (if set) of
          the string.  If the string is found, the position of the
          file pointer is moved to the first character matching the
          occurrence (if set) of the scan string .  If the string is
          not found, the error flag is set and the file character
          position pointer is not changed.
         NOTE:  Scanning is done forwards from the current file
                 position, character by character, including LF, CR &
                 FF (any ASCII character).
          
       EXAMPLE
     
          
       @SET fn = 'test\tfile8.txt'
       @FILEOPEN(fn)
       @FILESTART(fn)
       @CHECK(off)
       @FILESCANCH(fn,"LNCD",3)   @@scan for third occurrence of string LNCD
       @CHECK(on)
       @IFERROR then GOTO endoffile




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FILESCANLN                                           @FILESCANLN


          SYNOPSIS
     
          @FILESCANLN(file,pattern)
          
          
          SYNTAX
     
          @FILESCANLN(Expr,Expr)
          
          
          PARAMETERS
     
         File      may be a variable or the actual file name in
                    quotes.
         pattern   The string to be searched for.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Searches forwards through the file for the string.  If the
          string is found, the position of the file pointer is moved
          to the start of the line matching the scan string.  If the
          string is not found, the error flag is set and the file
          character position pointer is not changed.
          Error Flag is set if the file is not open, or if the scan
          string is not found.
          
          
       EXAMPLE
     
          
       @SET fn = 'test\tfile8.txt'
       @FILEOPEN(fn)
       @FILESTART(fn)
       @CHECK(off)
       @FILESCANLN(fn,"LNCD")   @@scan for the string LNCD
       @CHECK(on)
       @IFERROR then GOTO endoffile




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FILESEEKCH                                           @FILESEEKCH


          SYNOPSIS
     
          @FILESEEKCH(File,Offset)
          
          
          SYNTAX
     
          @FILESEEKCH(Expr,Expr)
          
          
          PARAMETERS
          
         File      may be a variable or the actual file name in
                    quotes.
          Offset positive or negative numeric value relative to
                 current position.  Defaults to 0, ie no change in
                 current position
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Moves the file character position pointer by the amount
          specified in "Offset", relative to the current file
          position.  The command fails if the file isn't open, or if
          the offset is non-numeric.  The error flag is set if the
          file is not open, or if the number of character positions
          moved is beyond the start-of-file or end-of-file.
          
          
     
       EXAMPLE
     
          
            @SET fn = 'test\tfile8.txt'
            @FILEOPEN(fn,'rw')
            @CHECK(off)
            @FILESEEKCH(fn,100)
            @CHECK(on)
            @IFERROR then GOTO end of file
          .....
          



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FILESEEKLN                                           @FILESEEKLN

          SYNOPSIS
     
          @FILESEEKLN(File,Offset)
          
          
          SYNTAX
     
          @FILESEEKLN(Expr,Expr)
          
          
          PARAMETERS
          
         File       may be a variable or the actual file name in
                    quotes.
          Offset    positive or negative numeric value relative to
                    current position.  Defaults to 0, ie no change in
                    current position
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Seeks the line position specified by "Offset", from the
          current file line position.  The command fails if the file
          isn't open, or if the offset is non-numeric.
          The error flag is set if the file is not open, or if the
          number of line positions moved is beyond the start-of-file
          or end-of-file.
          
          
     
       EXAMPLE
     
          
            @SET fn = 'test\tfile8.txt'
            @FILEOPEN(fn,'rw')
            @CHECK(off)
            @FILESEEKLN(fn,10)
            @CHECK(on)
            @IFERROR then GOTO end of file
          .....
          



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FILESTART                                             @FILESTART

          SYNOPSIS
     
          @FILESTART(File)
          
          
          SYNTAX
     
          @FILESTART(Expr)
          
          
          PARAMETERS
          
         File       may be a variable or the actual file name in
                    quotes.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Sets both the file character and line pointers to the start
          of the nominated file.  The command fails if the file is not
          open.
          The error flag is set if the file is not open.
          
          
     
       EXAMPLE
     
          
            @SET fn = 'test\tfile8.txt'
            @FILEOPEN(fn,'rw')
            @CHECK(off)
            @FILESEEKLN(fn,10)
            @CHECK(on)
            @IFERROR then GOTO end of file
            @FILESTART(fn)
          .....
          



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FILEWRITECH                                         @FILEWRITECH

          SYNOPSIS
     
          @FILEWRITECH(File{,string})
          
          
          SYNTAX
     
          @FILEWRITECH(Expr{,Expr})
          
          
          PARAMETERS
          
         File       may be a variable or the actual file name in
                    quotes.
         string     optional,  may be a variable or the actual text
                    to be written to file in quotes.
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Writes a string to the nominated file.  Note that if
          characters already exist from the current file position,
          this command will overwrite the existing file by exactly the
          number of characters in the @FILEWRITECH command.  If the
          current file position is the end-of file, then the new
          characters will be appended to any existing text.  Any ASCII
          character (0-255) may be written to the file with this
          command.
          The error flag is set if the file is not open in Read/Write
          mode, if write permission is denied, or no disk space left.
          
          
       EXAMPLE
     
          
            @SET fn = 'test\tfile8.txt'
            @FILEOPEN(fn,'rw')
            @FILEEND(fn)
            @FILEWRITECH(fn,'new chars')
            @FILECLOSE(fn)
          



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FILEWRITELN                                         @FILEWRITELN

          SYNOPSIS
     
          @FILEWRITELN(File{,string})
          
          
          SYNTAX
     
          @FILEWRITELN(Expr{,Expr})
          
          
          PARAMETERS
          
         File       may be a variable or the actual file name in
                    quotes.
         string     optional,  may be a variable or the actual text
                    to be written to file in quotes.
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          This command writes a string to the nominated file with a
          CR, LF line terminator.  Note that if characters already
          exist from the current file position, this command will
          overwrite the existing file by exactly the number of
          characters in the @FILEWRITELN command, plus the CR and LF
          characters (ie the line terminator).  If the current file
          position is the end-of file, then the new line will be
          appended to any existing file.  Any ASCII character (0-255)
          may be written to the file with this command.
          The error flag is set if the file is not open in Read/Write
          mode, if write permission is denied, or no disk space left.
          
          
     
       EXAMPLE
     
          
            @SET fn = 'test\tfile8.txt'
            @FILEOPEN(fn,'rw')
            @FILEEND(fn)
            @FILEWRITELN(fn,'new chars')
            @FILECLOSE(fn)
          



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FLUSHALL                                               @FLUSHALL

          SYNOPSIS
     
          @FLUSHALL
          
          
          SYNTAX
     
          @FLUSHALL
          
          
          PARAMETERS
          
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Flushes all existing variables, freeing that memory space.
          This command does not set the error flag
          
          
          EXAMPLE
     
          
            @FLUSHALL
          



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FLUSHVAR                                               @FLUSHVAR

          SYNOPSIS
     
          @FLUSHVAR(variable)
          
          
          SYNTAX
     
          @FLUSHVAR(DefinedVariable)
          
          
          PARAMETERS
     
          variable  the name of a variable to release from memory.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Free the memory storage used by a previously defined
          variable.
          
          
       EXAMPLE
     
          
          
     @INKEY(answer, 'type Y or N')
     @IF answer = 'Y' THEN GOSUB doit
     @FLUSHVAR(answer)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FOR                                                         @FOR

          SYNOPSIS
     
          @FOR variable = count1 DOWNTO/TO count2
          
          
          SYNTAX
     
          @FOR VariableExpr = Expr1 DOWNTO/TO Expr2
          
          
          PARAMETERS
          
          variable  the name of a variable which exists.
          count1    the starting count numeric value.
          count2    the finishing count numeric value.
         TO         Indicates the FOR/NEXT loop will increment from
                    "count1" up to "count2".
         DOWNTO     Indicates the FOR/NEXT loop will decrement from
                    "count1" down to "count2".
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Used in conjunction with @NEXT to establish repetitive
          counting loops.
          For/Next loops may be nested.
          This command does not set the error flag
          
          
       EXAMPLE
     
     @FOR A = 1 to 10
     @COMMENT('A = ',A)
     @NEXT A
          
          or
          
     @FOR A = 10 DOWNTO 1
     @COMMENT('A = ',A)
       @FOR B = 1 to 10
         @COMMENT('A = ',A," and B = ",B)
       @NEXT B
     @NEXT A
          



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FORM                                                       @FORM

          SYNOPSIS
     
          @FORM(X,Y,LENGTH,VARNAME {,X,Y,LENGTH,VARNAME})
          
          
          SYNTAX
     
          @FORM(FormExpr {, FormExpr})
          
               where FormExpr ->Expr, Expr, Expr, VariableExpr
          
          
          PARAMETERS
     
          X         column number
          Y         line number
          LENGTH    length of variable VARNAME
          VARNAME   VARNAME will be input at screen location X,Y of
                    given LENGTH
          
          
       RETURN VALUE
     
          The characters typed in by the operator - stored in variable
          "VARNAME".
          
          
       DESCRIPTION
     
          Allows forms mode input of string data with tabbing between
          the fields.
          TAB moves between the fields.  Enter accepts the field
          values.
          This command does not set the error flag
          
          
       EXAMPLE
     
          This example shows an input box of 4 characters at line 5
          starting from column 35.  The data entered in this box is
          written to variable EMG.
          
@DRAW(low,cup,10,5,"Enter exchange LNCD code      [",#17,#196,#217,"
for menu]")
@FORM(35,5,4,EMG)
@CLRSCR
@SET OK = "N"
@IF EMG = "" then GOSUB MENUSEL
@IF OK = "Y" then GOTO XFOUND
@GOTO NEWXGE
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FUNBUSY                                                 @FUNBUSY

          SYNOPSIS
     
          @FUNBUSY(attempts)
          
          
          SYNTAX
     
          @FUNBUSY(Expr)
          
          
          PARAMETERS
     
          attempts  The number of attempts which will be made to enter
                    a command before failing with an error.  A value
                    of 0 (the default) means that the Script will
                    continually retry the command until terminated by
                    the operator.
          
          
                    RETURN VALUE
     
          None
          
          
                    DESCRIPTION
     
          Sets the number of attempts which will be made to enter a
          command before the script language will stop with an error
          message when the FUNCTION BUSY response is received.
          Error flag is set if the attempts is exhausted
          
          
                    EXAMPLE
     
          
          
     @FUNBUSY(3)
     @CHECK(OFF)
     ALSTP;
     @CHECK(ON)
     @IFERROR then GOTO cmdfailed




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@FUNKEY                                                   @FUNKEY

          SYNOPSIS
     
          @FUNKEY(key_num [, action, file_name [, key_label] ] )
          
          
          SYNTAX
     
          @FUNKEY(Expr [, FunTypeExpr, Expr [, Expr] ] )
          
          
          PARAMETERS
     
          key_num   represents the function key number.
          action    optional, represents the function key process
                    method:
                    A    Auto-transmit (sends command to host)
                    L    Local display (displays command in Main
                    screen)
          T         Activate transmit file (If specified, file_name
                    must also be specified)
          file_name Optional, the text to be entered for 'A' and 'L'
                    actions, or indicates the required directory and
                    transmit file name for 'T' actions.
          key_label optional, 6 character description for function key
                    purpose.  If specified, action and file_name must
                    also be specified.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Sets up a function key to perform a required task or
          activate a specified transmit file.
          key_num 1-10 are function keys F1-F10
          key_num 11-20 are function keys Shift F1- Shift F10
          @FUNKEY(Key) clears the function key
          This command does not set the error flag
          
          
       EXAMPLE
     
          This example programs the Function Key 8 to execute the
          transmit file CONNEXCH.CMD every time it is pressed.
          
     @FUNKEY(8,"T",CONCAT(OZPATH,"CMDS\CONNEXCH.CMD"),"CONEXC")
     @FUNKEY(7)   @@clears Function key 7




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@GETDATE                                                 @GETDATE

          SYNOPSIS
     
          @GETDATE(date_time[,day_no])
          
          
          SYNTAX
     
          @GETDATE(VariableExpr [, VariableExpr] )
          
          
          PARAMETERS
     
          date_time - variable name for storing of the return value
          for the current date.
          day_no    - optional variable
          
          
       RETURN VALUE
     
          The PC date and time in the string "date_time" of the form
          "yymmddHHMMSSday"  (year,month,day,hour,min,sec,day of
          week), where yymmddHHMMSS is made up of numbers and day is
          made up of characters, eg.  Mon, Tue, etc.  The string
          "day_no" has the number of the day of the week, where 0 =
          Sunday, 1 = Monday etc.
          
          
       DESCRIPTION
     
          Returns the PC date and time, and the number of the day of
          the week.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @LABEL CHECDATE
     @GETDATE(LDATE)
     @SET DATE = COPY(LDATE,1,6)
     @SET TIME = COPY(LDATE,7,4)
     @SET DAY = COPY(LDATE,13,3)
     @COMMENT("       * Check PC time and date..")
     @COMMENT("  DATE=*{DATE}^ DAY=*{DAY}^ TIME=*{TIME}")
     @INKEY(CHOICE," Are DATE and TIME shown above correct [Y/N] ?")
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@GETDIR                                                   @GETDIR

          SYNOPSIS
     
          @GETDIR(variable)
          
          
          SYNTAX
     
          @GETDIR(VariableExpr)
          
          
          PARAMETERS
     
          variable  - A string variable holding the directory name.
          
          
          RETURN VALUE
     
          variable returns the current DOS directory.
          
          eg.   "C:\OZTERM\LOG"      or  "F:\APPS\COMMS\OZTERM\LOG"
          
          
          DESCRIPTION
     
          as above
          This command does not set the error flag
          
          
          EXAMPLE
     
          
          
     @GETDIR(DIRCURRENT)
     @COMMENT("This is the current DOS directory  ",DIRCURRENT)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@GOSUB                                                     @GOSUB

          SYNOPSIS
     
          @GOSUB label_name
          
          SYNTAX
     
          @GOSUB LabelExpr
          
          PARAMETERS
     
          label_name  Up to 10 alphanumeric characters marking the
                    start point of the subroutine to be run.
          
       RETURN VALUE
     
          None
          
       DESCRIPTION
     
          Call sub-routine "label_name".  Sub-routines may be nested.
          Requires @LABEL and @RETURN commands to be used with it.
          Will result in jumping to the line following the LABEL
          label_name, and execution of the following lines till an
          @RETURN command is encountered.  It will then jump back to
          the line immediately following the @GOSUB statement.
          The label referred to must be in the same file.  The script
          file will stop if the label is not found.
          This command does not set the error flag
          
       EXAMPLE
     
          
     @LABEL STEP1
       @GOSUB XGESTATE
       CHREP;
       @INKEY(CHOICE," Are we ready to start ?")
       @IF CHOICE = "Y" THEN GO TO READY
       @GOTO NOTREADY
     
     @LABEL XGESTATE
       @COMMENT("         * Checking exchange state..")
       ALLIP;
       DIREP:EMG=ALL;
       STRSP:R=ALL;
       EXEPP:EMG={EMG}0,EM=ALL;
       STSTP:EMG={EMG}0,EMTS=ALL;
     @RETURN
     
     @LABEL READY
       .
     
     @LABEL NOTREADY
       .
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@GOTO                                                       @GOTO

          SYNOPSIS
     
          @GOTO label_name
          
          
          SYNTAX
     
          @GOTO LabelExpr
          
          
          PARAMETERS
     
          label_name  10 alphanumeric characters used to indicate the
                    next line of the transmit file to be run.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Jump to "label_name" and continue execution from the line
          following "label_name".  Requires @LABEL command to be used
          with it.  The label referred to must be in the same file.
          The script file will stop with an error if the label is not
          found.
          
          
       EXAMPLE
     
          
          
     @CLRSCR
     @SET OK = "N"
     @IF EMG = "" then GOSUB MENUSEL
     @IF OK = "Y" then GOTO XFOUND
     @GOTO NEWXGE
       :
     @@ more program statements
       :
     @LABEL NEWXGE
       @COMMENT("*Checking file ^",XGESFILE," for *",EMG)
       @OPENREAD(XGESFILE)
       @IFERROR then GOTO XERROR
     
     @LABEL NEWXGE0
       @READ(LINE)
       @IFERROR then GOTO XERROR
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@HIDE                                                       @HIDE

          SYNOPSIS
     
          @HIDE
          
          
          SYNTAX
     
          @HIDE
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Hides the script file window to allow full Main screen
          display during Script file execution.  This command does not
          set the error flag
          
          
          EXAMPLE
     
          
          
     @LABEL MENUSEL
     @OPENREAD(XGESFILE)
     @IFERROR then return
     @WINDEND
     @HIDE
     @DRAW(box,1,2,80,24,cup,20,2,inv," Select Exchange ")
     @SET PTR = 0
     @SET PAD = " "
     @SET X = 3
     @SET Y = 2
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@IF  THEN                                               @IF  THEN

          SYNOPSIS
     
          @IF (condition) THEN statement
          
          
          SYNTAX
     
          @IF (Expr RelOp Expr) THEN ScriptCommand
          
          
          PARAMETERS
     
          condition Usually consists of a relative comparison (that
                    can be true or false) of two or more expressions.
                    Conditionals allowed are "<", "<=", "=", "<>",
                    ">=", ">",."AND", "NOT", "OR", "XOR", "&", "|",
                    and "^".  Condition evaluates to a Boolean result,
                    ie True or False, and may be a combination of
                    conditional statements.
          
          statement An instruction that does something eg.  set, GOTO,
                    GOSUB, stop etc
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          If "condition" is true then execute "statement".  If
          "condition" is not true then continue with the next line.
          The ELSE command may also be used in conjunction with the IF
          Command.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @IF PRFLAG = "Y" THEN PRINTER(ON)

     or

     @IF SCAN("00FF") <> 0 THEN GOTO RELTES2
     
     or

     @IF NOT((X=0) AND (YES="NO") OR (SCAN("FAULT") = 0)) THEN GOTO
     RELTES2
     @ELSE IF (X&Y) THEN do_something
     @ELSE.....
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@IFERROR  THEN                                     @IFERROR  THEN

          SYNOPSIS
     
          @IFERROR THEN statement
          
          
          SYNTAX
     
          @IFERROR THEN ScriptCommand
          
          
          PARAMETERS
     
          statement An instruction that does something eg.  set, GOTO,
                    GOSUB, stop etc
          
          
       RETURN VALUE
     
          Read and clears the Error Flag.
          
          
       DESCRIPTION
     
          Tests if the Error Flag has been set, and if so executes the
          statement.  Can be used in conjunction with @CHECK(OFF)  to
          error check  commands  and statements which are able to set
          the error flag.  The ELSE Command may also be used in
          conjunction with this command.
          This command does not set the error flag.
          
          
       EXAMPLE
     
          
          
     @CHECK(OFF)
       INFIP:FILE=FD0A1;
     @CHECK(ON)
     @IFERROR THEN GOTO STEP11A   @@if not found
     @ELSE IF
     @ELSE... GOTO STEP11END
     
     @LABEL STEP11A
       @COMMENT(" *    Creating FD0A1..")
       INFII:FILE=FD0A1,RLENGTH=512,NODE=A,TYPE=SEQ,IO=FD-1;
     
     @LABEL STEP11END
       END;
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@INC                                                         @INC

          SYNOPSIS
     
          @INC(var[,count])
          
          
          SYNTAX
     
          @INC(DefinedVariable[,VarExpr])
          
          
          PARAMETERS
     
          var  Numeric value.
          countoptional, numeric value.
          
          
       RETURN VALUE
     
          var + 1, or "var" + "count" if set.
          
          
       DESCRIPTION
     
          Increments NUMERIC variable "var" by 1, or the amount set by
          "count".  If the number is greater than 2,147,483,647 then
          it wraps around to -2,147,483,648.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @SET y = 1
     @INC(Y)
     @IF Y <> 24 then GOTO MENSEL5
          or
     
     @INC(y,5)    @@same as SET y = y+5




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@INCLUDE                                                 @INCLUDE

          SYNOPSIS
     
          @INCLUDE(file_name[,optional label])
          
          
          SYNTAX
     
          @INCLUDE(Expr[,VarExpr])
          
          
          PARAMETERS
     
          file_name       can be a variable substitution or a direct 
                          file name.
          optional label  can be a variable substitution or a direct
                          label name.
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Calls another transmit file and continues execution until
          !$$$$! or end of file is found.  Then returns to the line
          immediately following the @INCLUDE statement in the host
          file.  If optional Label is set then will search the
          specified file for the Label and start from that point.
          Error flag is set if File is not accessible, or label not
          found
          
       EXAMPLE
     
          
          
     @EXECUTE("dir a:")
     @SET FILE = "A:FCEPS.EMG"
     
     @COMMENT(" Loading {FILE}..")
     @CHECK(off)
     @INCLUDE(FILE)              @@load EMRP Function change file!
     @CHECK(on)
     @IFERROR THEN PROMPT
     
     or
     
     @CHECK(off)
     @INCLUDE(FILE,"START")      @@load EMRP Function change file from
     label start
     @CHECK(on)
     @IFERROR THEN PROMPT




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@INKEY                                                     @INKEY

          SYNOPSIS
     
          @INKEY [ ( [ variable {, prompt} ] ) ]
          
          
          SYNTAX
     
          @INKEY [ ( [ VariableExpr {, Expr} ] ) ]
          
          
          PARAMETERS
     
          variable  optional - stores the character typed by the
                 operator.
          prompt optional - can be a variable substitution or a direct
                 text message within quotes.  If "prompt" is required,
                 a "variable" must also be specified.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Prompts the user with  "prompt"  message for the single
          character value to assign to "variable".  The character
          typed is converted to upper case on input.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @INKEY(PRFLAG,"Do you want the printer on line [Y/N] ?")
     @IF PRFLAG = "Y" THEN PRINTER(ON)
     
          or
     
     @SET MESSAGE="Do you want the printer online [y/n]?"
     @INKEY(PRFLAG,MESSAGE)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@INPUT                                                     @INPUT

          SYNOPSIS
     
          @INPUT(variable {, prompt} )
          
          
          SYNTAX
     
          @INPUT(VariableExpr {, Expr } )
          
          
          PARAMETERS
     
          variable  characters typed in by operator are stored in
                    "variable".
          prompt    optional, can be a variable substitution or a
                    direct text message within quotes.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Prompts the user with  "prompt"  message for the value to
          assign to "variable".  The characters input into variable
          are converted to upper case.  Up to 255 characters may be
          entered.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @COMMENT("           C N A 8    P R O C E D U R E")
     @COMMENT(" * This procedure loads CNA8 into the standby CP
     side.")
     @INPUT(EMG,"Enter exchange LNCD code (eg TCKX)")
     
     @SET RELFSW = "RELFSW0"
     @INPUT(RELFSW,"Enter reload file to standby CP load from (usually
     RELFSW0)")
     @LOG(CONCAT("c:",EMG,".LOG"))                 @@log file on
     
          or
     
     @SET MESSAGE="Enter exchange LNCD code (eg TCKX)"
     @INPUT(EMG,MESSAGE)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@KEYTIMEOUT                                           @KEYTIMEOUT

          SYNOPSIS
     
          @KEYTIMEOUT(Secs)
          
          
          SYNTAX
     
          @KEYTIMEOUT(Expr)
          
          
          PARAMETERS
     
          Secs      Number of seconds for keyboard Time-out from 0 -
                    99.  Can be variable or actual number of seconds
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Used to set the number of seconds for Keyboard Time-out.
          This Time-out is the length of time a Pending Time Events
          will wait before running, after there is no activity on the
          Port or Keyboard (eg operator stops entering data).
          
          Note:   A value of 0 means that a Time Event will run
                  regardless of Keyboard or port activity.  Useful for
                  interrupting printouts.
          
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @INPUT(keyto,'Input keyboard Time-out (0-99)')
     @KEYTIMEOUT(keyto)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@LABEL                                                     @LABEL

          SYNOPSIS
     
          @LABEL label_name
          
          
          SYNTAX
     
          @LABEL LabelExpr
          
          
          PARAMETERS
     
          label_name  Up to 10 alphanumeric characters.  Identifying
                    address in a transmit file.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Used by @GOTO, @GOSUB and @INCLUDE jumps to identify the
          address in a file to jump to.  Up to the last 16 Label names
          used are stored in a label cache which speeds up GOTO, GOSUB
          loops.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @LABEL START
     @COMMENT('An endless loop...')
     @GOTO START
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@LOG                                                         @LOG

          SYNOPSIS
     
          @LOG(file_name)
          
          
          SYNTAX
     
          @LOG(Expr)
          
          
          PARAMETERS
     
          file_name can be a variable substitution or direct file
                    name.  All screen output from now on will be saved
                    to this file as the data overflows the screen
                    buffer, or when the log file is closed.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Opens a disk log file to "file_name".  Will append to an
          existing file.  To overwrite an existing file, an @ERASE
          command will be required first.  If the Logging area has no
          free space left the Status line will display the message
          "DISK FULL" where the Log file name would normally be
          displayed.
          The error flag is set it the log file is not accessible.
          
       EXAMPLE
     
          
          
     @SET SUBFILE = "SUBS.LOG"
     @ERASE(SUBFILE)
     @LOG(SUBFILE)
     suscp:scl=tcl-11;
     @CLOSE
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@LOGOF                                                     @LOGOF

          SYNOPSIS
     
          @LOGOF
          
          
          SYNTAX
     
          @LOGOF
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Logs off the host according to the current emulation mode,
          eg sends "LOGOF;" command if in AOM Mode, sends Control-D if
          in TW mode, etc..
          This command does not set the error flag
          
          
          EXAMPLE
     
          
          
          @LOGOF
          @GOTO Disconnect




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@LOGON                                                     @LOGON

          SYNOPSIS
     
          @LOGON
          
          
          SYNTAX
     
          @LOGON
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Logs on to host according to current port emulation mode.
          
          
          EXAMPLE
     
          
          
          @LOGON
          @GOTO dosomething




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@MARK                                                       @MARK

          SYNOPSIS
     
          @MARK[(var)]
          
          
          SYNTAX
     
          @MARK[(Offset)]
          
          
          PARAMETERS
     
          Offsetoptional number of lines to offset from the last
                entered command screen position.  May be a positive or
                negative numeric value.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Marks the screen buffer with an invisible mark.  Used to
          limit the range of the response screen which will be checked
          by @SCAN from the marked point onwards.
          The optional "offset" variable may be used to mark the
          screen buffer line relative to the last entered command, or
          the last @MARK command.  If the offset exceeds the screen
          buffer limits the mark will "wrap around".  For example if
          the number of screen buffer lines is set to 201, and the
          current line position is line 201, if the command @MARK(-
          202) is entered the screen buffer position will "wrap
          around" and return to line 201.
          This command does not set the error flag
          
          
       EXAMPLE 1
     
          
          
     @MODE(FD)
     @MARK(-20)
     @SEND('PRINT TABLE')
     @WAITFOR('FINISHED')
     @SET LINE = SCAN('HOST NAME')




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@MENU                                                       @MENU

          SYNOPSIS
     
          @MENU(var, par1, par2 {, parN} )
          
          
          SYNTAX
     
          @MENU(VariableExpr, Expr, Expr {, Expr} )
          
          
          PARAMETERS
     
          par1 & par2 numeric values, indicating the possible number
                    of choices(entries) in column 1 and column 2
                    respectively in the menu.
          
          parN...   optional.  Identifying character within each
                    choice in the menu.
          
          
       RETURN VALUE
     
          var the number of the item selected from the menu.
          
          
       DESCRIPTION
     
          Allows sliding bar menu selection in either 1 or 2 columns
          and returns the number of the item selected.  Menu boxes and
          options should be displayed first with the @DRAW()
          statement.  Note this command is not case sensitive.
          This command does not set the error flag
          
          
       EXAMPLE 1
     
          This example allows for a single column menu with 5 possible
          selection.  The selections can be made by tabbing to the
          required item and pressing enter or pressing a, b, c, d or
          e.  1, 2, 3, 4 or 5 is returned in the variable CHOICE.
          
     @MENU(CHOICE,5,0,"A","B","C","D","E")
          


18.3 SCRIPT LANGUAGE COMMAND DESCRIPTIONS (@MENU Continued)

          
       EXAMPLE 2
     
          This example will allow for a 2 column highlighted menu
          selection, with 21 selections in column 1 and 19 selections
          in column 2.  The resultant selection number will be written
          to variable PTR.
          
          The selections may be made by using the TAB and Shift TAB
          keys to move through the selections until either ESC or
          Enter key is pressed.
          
     @LABEL MENSEL1
       @SET MAXPTR = PTR
       @IF MAXPTR = 1 then GOTO MENSEL4
     
     @LABEL MENSEL2
       @DRAW(high,cup,21,24,'TAB',LOW,' move', #196,#196)
       @DRAW(HIGH,#17,#196,#217,LOW,' select')
       @MENU(PTR,21,19)
       @IF PTR > MAXPTR then GOTO MENSEL2
       @IF PTR < 1 then GOTO MENSEL2
       @IF PTR = 42 then GOTO NEXTPAGE1
       @CLRSCR
       @OPENREAD(XGESFILE)
       @IFERROR then GOTO MERROR
       @SET COUNT = 0
     
     @LABEL MENSEL3
       @READ(LINE)
       @IFERROR then GOTO MERROR
       @IF copy(LINE,1,1) <> #33 then inc(COUNT)   @@skip comments@@
       @IF COUNT < (PTR + NEXTPTR) then GOTO MENSEL3
          



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@MKDIR                                                     @MKDIR

          SYNOPSIS
     
          @MKDIR(variable/parameter)
          
          
          SYNTAX
     
          @MKDIR(Expr)
          
          
          PARAMETERS
     
          variable A string variable holding the directory name.
          parameterThe actual name of the directory.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          This will create a new DOS directory..
          Use @IFERROR  to test result.
          Error flag is set if directory is not created, or if
          directory exists.
          
       EXAMPLE
     
          
          
     @MKDIR("\ROUTINES")
     
          or
     
     @SET DIRNEW = "\ROUTINES"
     @CHECK(OFF)
     @MKDIR(DIRNEW)
     @CHECK(ON)
     @IFERROR THEN GOTO XERROR
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@MODE                                                       @MODE

          SYNOPSIS
     
          @MODE(type)
          
          
          SYNTAX
     
          @MODE(ModeExpr)
          
          
          PARAMETERS
     
          type  can have the following values:
          
          AOM    Use for AOM and AXE via the AOM connections.
          TW     Use for direct connection to TW port.
          IOG11  Use for AT ports, eg IOG-11, IOG20
          MNOSS  Use for access to AT ports via OSS or APG 40.
          FD     Character Full Duplex.  Use for MDX and
                 other host computers.
          HD     Character Half Duplex.
          SYS12  Use for System 12 access.
          IOIM   Slow TW mode, eg for the IOIM magazine in RSS-Ds
          BFD    Block mode, Full Duplex
          OMI    Use for DMS, SDP, CDMA, Cisco Router, APG40 Node ports.
          S12FD  System 12 MPTMON Mode
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Sets the current port to the specified terminal emulation
          mode.
          This command does not set the error flag
          
          
       EXAMPLE
     
     @MODE("IOG")
          
     or
          
     @SET MTYPE = "OSS"
     @MODE(MTYPE)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@NEXT                                                       @NEXT

          SYNOPSIS
     
          @NEXT Variable
          
          
          SYNTAX
     
          @NEXT Var
          
          
          PARAMETERS
     
          var  Variable name set in the corresponding @FOR statement
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Used in conjunction with the @FOR command to delimit the FOR
          loop functions for that particular "variable".  Several FOR
          loops may be nested.  An early exit from the FOR loop may be
          done using the @ENDFOR command.
          
          
       EXAMPLE
     
          @FOR A = 1 to 10
          @COMMENT('A= ', A)
            @FOR X = 10 DOWNTO 1
              @COMMENT('A= ', A,' and X = ',X)
              @IF KEYPRESS THEN ENDFOR
            @NEXT X
          @NEXT A
          
     


18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@OPENREAD                                               @OPENREAD

          SYNOPSIS
     
          @OPENREAD(file_name)
          
          
          SYNTAX
     
          @OPENREAD(Expr)
          
          
          PARAMETERS
     
          file_name can be a variable substitution or a direct file
          name.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Opens file "file_name" for reading.  Only one file may be
          open at a time using this command.  If a previous file was
          opened with this command it is automatically closed.  Use
          @IFERROR to test result of the OPENREAD command.  To close
          the file after all the data required has been read use
          @OPENREAD("").
          The FILEOPEN Command may be used instead to the open the
          file, with the advantage of being able to open up to
          thirteen files at the one time.  Note that the READ command
          only works in conjunction with the OPENREAD command.
          Error flag is set if the file cannot be opened.
          
       EXAMPLE
     
          
          
     @SET XGESFILE = "cmds\sel_wa.txt"
     @COMMENT("*Checking file ^",XGESFILE," for *",EMG)
     @CHECK(OFF)
     @OPENREAD(XGESFILE)
     @CHECK(ON)
     @IFERROR then GOTO XERROR
     @READ(DATA)
     @OPENREAD("")
    



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@ORDERED                                                 @ORDERED

          SYNOPSIS
     
          @ORDERED(On/Off/All)
          
          
          SYNTAX
     
          @ORDERED(OnOffAllExpr)
          
          
          PARAMETERS
     
          On/Off/   Action ORDERED responses on a line by itself by 
          All       logging off the host if ON, action ORDERED responses
                    by logging off the host if ORDERED appears anywhere
                    in the response if ALL, or not logging off on an 
                    ORDERED response if OFF.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Action ORDERED responses by logging off the host if ON or ALL,
          or not logging off on an ORDERED response if OFF.  The default
          behaviour is to log off when an ORDERED response is received
          (ie., the ORDERED processing is ON).  If set to ON, will only
          respond to ORDERED on a line by itself.  If set to ALL, will
          respond to ORDERED anywhere in the response.  If set to OFF
          will not respond to ORDERED at all.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @IF HOST = '/66' THEN ORDERED(OFF)
     BLODI:DEV=BT7-543;
     BLODI:DEV=BT6A-234;
     @IF HOST <> '/66' THEN GOTO IGNORE
       @LOGOF
       @WAITFOR('Some Result', 10)
     @LABEL IGNORE
     @ORDERED(ON)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@PARAMISS                                               @PARAMISS

          SYNOPSIS
     
     @PARAMISS(ON/OFF)
     
     
          SYNTAX
     
          @PARAMISS(OnOffExpr)
          
          
          PARAMETERS
     
          ON   Treats "PARAMETER MISSING" as an unacceptable response.
          OFF  Treats "PARAMETER MISSING" as an acceptable response.
          
          
       RETURN VALUE
     
          With Check(on) and PARAMISS(ON) a Hard error occurs, and
          with Check(off) and PARAMISS(ON) the Error Flag is set.
          
          
       DESCRIPTION
     
          In System 12 mode allows the script author to use the "?"
          and "!" command terminators with PARAMISS(OFF).  If these
          terminators are used the System-12 host requests additional
          parameters to complete the command sequence.  If Check(ON)
          and PARAMISS(ON) then a hard Error is generated.  This
          displays the "PARAMETER MISSING" response, and the operator
          is asked if they want to Continue, Retry or Esc to Halt the
          script file.  If Check(OFF) and PARAMISS(ON) the Error Flag
          is set and can be checked with the @IFERROR Script Command.
          If Check(OFF) and PARAMISS(OFF) the Error Flag is not set
          and the script will continue normally.
          
          
       EXAMPLE
     
     @INPUT(NumTo,"Enter Time Out value in minutes")
     @RESPONSETO(NumTo)
     @PARAMISS(OFF)
     @CHECK(OFF)
     display-subsc-meter:DN1=K'{DN1}!
     K'{DN2}!
     K'{DN3}.
     @CHECK(ON)
     @IFERROR THEN GOTO NOLASTREP
     @PARAMISS(ON)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@PAUSE                                                     @PAUSE

          SYNOPSIS
     
          @PAUSE
          
          
          SYNTAX
     
          @PAUSE
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Halts the transmit file.  Need to use Alt I and press enter
          to restart auto-execution of file.
          This command does not set the error flag
          
          
          EXAMPLE
     
          
          
     @PAUSE
     
     or
     
     @IFERROR then PAUSE
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@PORTNO                                                   @PORTNO

          SYNOPSIS
     
          @PORTNO(port_no)
          
          
          SYNTAX
     
          @PORTNO(Expr)
          
          
          PARAMETERS
     
          port_no   numeric value indicating which port to be used.
                    Can be a variable, string constant or literal
                    value.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Switches to port number "port_no".
          The error flag is set if the port is invalid.
          
       EXAMPLE
     
          
          
     @PORTNO("2")
     @PORTNO(PORT_NUM)
     @PORTNO(2)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@PRINTER                                                 @PRINTER

          SYNOPSIS
     
          @PRINTER(ON/OFF)
          
          
          SYNTAX
     
          @PRINTER(OnOffExpr)
          
          
          PARAMETERS
     
          ON   Turns the printer on.
          OFF  Turns the printer off.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Turns print logging on or off, so that when the printer is
          on characters received via the current port are also logged
          to the printer.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @COMMENT("        * Software compare ..")
     @INKEY(CHOICE," Do PCORP unload now [Y/N] ?")
     @IF CHOICE <> "Y" THEN GOTO NOPCORP
     @PRINTER(OFF)
     @INCLUDE("CMDS\PCORP.CMD")
     @CNTRLD
     @WINDOW
     @IF PRFLAG = "Y" THEN PRINTER(ON)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@PROMPT                                                   @PROMPT

          SYNOPSIS
     
          @PROMPT
          
          
          SYNTAX
     
          @PROMPT
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Prompts to "Continue execution [Y/N] ?".  (Displayed on line
          24).
          The prompt command is not case sensitive.  If the operator
          answers "Y" the script file continues executing.  If the
          operator answers "N" the script file halts.
          This command does not set the error flag
          
          
          EXAMPLE
     
          
          
     @LABEL DUMP
     @COMMENT("  * That's all.")
     @COMMENT("  * You should do the system backup procedure
     (SYBUP).")
     @INKEY(CHOICE,"Do dump now [Y/N] ?")
     @IF CHOICE <> "Y" THEN GOTO END
     @INCLUDE("CMDS\INFII.CMD")
     
     @LABEL END
       @CLOSE
       @PROMPT
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@QUIT                                                       @QUIT

          SYNOPSIS
     
          @QUIT
          
          
          SYNTAX
     
          @QUIT
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Terminates the OZTERM program.  The @QUIT command closes all
          files.  Note that if the OZTERM.DFT file is in the working
          directory all the functions under Label "Exit" will be
          completed before the program closes.
          This command does not set the error flag
          
          
          EXAMPLE
     
          
          
     @QUIT



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@READ                                                       @READ

          SYNOPSIS
     
          @READ(var)
          
          
          SYNTAX
     
          @READ(VariableExpr)
          
          
          PARAMETERS
     
          var    variable name up to 10 alphanumeric characters long
                 to accept the return value.
          
          
       RETURN VALUE
     
          var    a line from the read file previously opened with
                 @OPENREAD.
          
          
       DESCRIPTION
     
          Reads one line from the read file into variable "var" up to
          a maximum of 255 characters.  The file must be open with the
          @OPENREAD command.  Use @IFERROR to test for end of file and
          COPY() to extract sub-strings.
          The Error flag is set if the command reaches end of file
          (EOF), or if the file is not open.
          
       EXAMPLE
     
          
          
     @LABEL NEWXGE0
     @CHECK(OFF)
     @READ(LINE)
     @CHECK(ON)
     @IFERROR then GOTO XERROR
     @IF copy(LINE,1,1) = #33 then GOTO NEWXGE0@@skip comments!
     @IF trim(copy(LINE,16,4)) = EMG then GOTO XFOUND
     @GOTO NEWXGE0
     


          
18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@RENAME                                                   @RENAME

          SYNOPSIS
     
          @RENAME(OldName,NewName)
          
          
          SYNTAX
     
          @RENAME(Expr,Expr)
          
          
          PARAMETERS
     
          OldName   The name of an existing file.
          NewName   The new name for the file.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Rename an existing file to a new name.  The file names may
          include a drive and path, but both files must be on the same
          drive.
          Error Flag is set if file name already exists or access is
          denied.
          
       EXAMPLE
     
          
          
     @RENAME('c:\path\filename.ext', 'newfile.exb')
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@REPORT                                                   @REPORT

          SYNOPSIS
     
          @REPORT(ON/OFF)
          
          
          SYNTAX
     
          @REPORT(OnOffExpr)
          
          
          PARAMETERS
     
          ON        Allows next command to be entered when 'REPORT
                    FOLLOWS' is received
          OFF       Default, only enters the next command after 'LAST
                    REPORT' is received.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          For System 12 modes to allow multiple commands to be entered
          when 'REPORT FOLLOWS' is received instead of waiting for
          'LAST REPORT.'
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @WINDOW
     @DRAW(BOX,4,4,76,16,CUP,20,6,INV,'SYSTEM12 METER READING
     PROGRAM')
     @DELAYSEC(3)
     @LABEL REPMETER
     @PRINT(OFF)
     @SET DN1 =
     @CLRSCR
     @DRAW(BOX,5,5,21,7,INV,CUP,7,6,'ENTER NUMBER')
     @INPUT(DN1,"ENTER CUSTOMERS SERVICE NUMBER")
     display-subsc-meter:DN1=K'{DN1};
     @REPORT(OFF)
     @INKEY(CHOICE,'DO YOU WISH TO READ ANOTHER CUSTOMERS METER
     [Y/N]?')
     @IF CHOICE = 'Y' THEN GOTO REPMETER
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@RESPONSETO                                           @RESPONSETO

          SYNOPSIS
     
     @RESPONSETO(Minutes)
     
     
          SYNTAX
     
          @RESPONSETO(Expr)
          
          
          PARAMETERS
     
          Minutes   Numeric value for the length of time in minutes.
                    Can be a variable, string constant or literal
                    value.
          
          
       RETURN VALUE
     
          With Check(on) a Hard error occurs, and with Check(OFF) the
          Error Flag is set if LAST REPORT is not received before the
          time limit is reached.
          
          
       DESCRIPTION
     
          For System 12 modes to allow the script author to set a time
          out value whilst waiting for the "LAST REPORT" response
          terminator.  If Check(ON) and the time limit is exceeded,
          then a hard Error is generated, ie operator is asked if they
          want to Continue, Retry or ESC to Halt the script file.  If
          Check(OFF) the Error Flag is set and can be checked with the
          @IFERROR Script Command.  The timer is reset every time the
          REPORT FOLLOWS response is received.
          
          
       EXAMPLE
     
          
          
     @INPUT(NumTo,"Enter Time Out value in minutes")
     @RESPONSETO(NumTo)
     @CHECK(OFF)
     display-subsc-meter:DN1=K'{DN1};
     @CHECK(ON)
     @IFERROR THEN GOTO NOLASTREP
     



18.3 SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@RESTART                                                 @RESTART

          SYNOPSIS
     
          @RESTART
          
          
          SYNTAX
     
          @RESTART
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Jumps to start of current transmit file.
          All run time information is retained
          This command does not set the error flag
          
          
          EXAMPLE
     
          
          
     @COMMENT('An endless loop...')
     @DELAYSEC("10")
     @RESTART
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@RETURN                                                   @RETURN

          SYNOPSIS
     
          @RETURN
          
          
          SYNTAX
     
          @RETURN
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Return from sub-routine.  Causes a jump to the line
          immediately following the @GOSUB statement.
          Script stops if return in/out of GOSUB.
          This command does not set the error flag
          
          
          EXAMPLE
     
          
          
     @LABEL STEP1
     @GOSUB XGESTATE
     CHREP;
       :
       :
     
     @LABEL XGESTATE
       @COMMENT("         * Checking exchange state..")
       ALLIP;
       DIREP:EMG=ALL;
       STRSP:R=ALL;
       EXEPP:EMG={EMG}0,EM=ALL;
       STSTP:EMG={EMG}0,EMTS=ALL;
     @RETURN
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@RMDIR                                                     @RMDIR

          SYNOPSIS
     
          @RMDIR(variable/parameter)
          
          
          SYNTAX
     
          @RMDIR(Expr)
          
          
          PARAMETERS
     
          variable  A string variable holding the directory name.
          parameter -The actual name of the directory.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          This will delete the stated DOS directory.  Use @IFERROR  to
          test result.
          Error Flag is set if Directory exists and cannot be removed,
          ie won't delete the directory if it still contains files.
          
       EXAMPLE
     
          
          
     @RMDIR("\ROUTINES")
     
          or
     
     @SET DIROLD = "\ROUTINES"
     @CHDIR(DIROLD)
     @IFERROR THEN GOTO XERROR
     @EXECUTE("DEL *.*")
     @RMDIR(DIROLD)
     @IFERROR THEN GOTO XERROR
     



18.3 SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@SAVEDIR                                                 @SAVEDIR

          SYNOPSIS
     
          @SAVEDIR(variable)
          
          
          SYNTAX
     
          @SAVEDIR(VariableExpr)
          
          
          PARAMETERS
     
          variable  - A string variable holding the directory name.
          
          
          RETURN VALUE
     
          Variable returns the DOS directory where the OZTERM program
          was started from.  The same directory where the *.SVE files
          are kept.
          eg.   "C:\OZTERM"      or  "H:\COMMS\OZTERM"
          
          
          DESCRIPTION
     
          as above
          This command does not set the error flag
          
          
          EXAMPLE
     
          
          
  @SAVEDIR(DIRSAVE)
  @COMMENT("This is the directory OZTERM will put the save files in
  ",DIRSAVE)




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@SCREENTIMEOUT                                     @SCREENTIMEOUT

          SYNOPSIS
     
          @SCREENTIMEOUT(Number)
          
          
          SYNTAX
     
          @SCREENTIMEOUT(Expr)
          
          
          PARAMETERS
     
          Expr - A number from 0 - 99
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Sets the screen time out between 0 and 99 minutes.  If set
          to 0, no screen time out is performed.  If the OZTERM.STO
          file exists in the working directory, the functions in that
          file will be run before the screen blanks out.
          This command does not set the error flag.
          
          
          EXAMPLE
     
          
     @SCREENTIMEOUT(10)   @@set screen time-out to ten minutes
          



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@SELFILE                                                 @SELFILE

          SYNOPSIS
     
          @SELFILE(file_name{, prompt})
          
          
          SYNTAX
     
          @SELFILE(DefinedVariable {, Expr } )
          
          
          PARAMETERS
     
          file_name a variable name holding the directory mask.  ie
                    A:*.*  or  A:XDCN.* etc.
          prompt    can be a variable substitution or direct text
                    enclosed with quotes.
          
          
       RETURN VALUE
     
          File_name - The name of the selected file.
          
          
       DESCRIPTION
     
          Prompts the user with "prompt" and allows point and shoot
          "file_name" selection.  Press F1 to use the file manager to
          navigate and select the file.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @COMMENT("         * Load XDCN 124 and 103")
     @COMMENT("         * Insert disk for XDCN into the ^--PC's-- *A:
     disk drive")
     @INKEY(CHOICE," Press "Y" when XDCN disk is in the PC's A:
     drive")
     
     @CLRSCR
     @EXECUTE("dir a:")
     @SET FILE = "A:"
     @SELFILE(FILE,"Enter XDCN filename")
     
     @COMMENT(" Loading {FILE}..")
     @INCLUDE(FILE)     @@load XDCN file!
     @IFERROR THEN PROMPT
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@SELPRINT                                               @SELPRINT

          SYNOPSIS
     
          @SELPRINT(printerNumber)
          
          
          SYNTAX
     
          @SELPRINT(Expr)
          
          
          PARAMETERS
     
          printerNumber -A number (1, 2 or 3) indicating which LPT
                         port to use for the printer.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Allow selection of the printer to use for all printing
          operations.  Defaults to 1 (for LPT1) when Ozterm is first
          installed.  The selected printer is saved when Ozterm exits.
          Valid values are 1 (for LPT1) to 3 (for LPT3).  This is the
          same as the Setup Menu Printer selection
          The Error Flag is set if there is no valid printer
          
       EXAMPLE
     
          
          
     @SELPRINT(2)    @@select LPT2
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@SEND                                                       @SEND

          SYNOPSIS
     
          @SEND(var1,var2,...)
          
          
          SYNTAX
     
          @SEND(Expr {, Expr } )
          
          
          PARAMETERS
     
          var1,var2,...  ASCII characters, usually with some meaning
                    to the object being sent to.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Sends the list of variables directly to the port( use #13 to
          send a CR).
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @LABEL ENTERMD
     @COMMENT("Waking up MDX")
     @SEND(#13)
     @COMMENT("              Waiting for *",DESTSTR)
     @WAITFOR(DESTSTR,5)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@SET                                                         @SET

          SYNOPSIS
     
          @SET var = value
          
          
          SYNTAX
     
          @SET Variable = Expr
          
          
          PARAMETERS
     
          var       variable name consisting of up to 10 alphanumeric
                    characters.
          value     can be a numeric value, string variable,
                    ARITHMETIC, BOOLEAN or BITWISE expression or
                    string function.  Can be a directly applied
                    expression or variable substitution.  Operators
                    allowed in the expressions include "+" "-" "*" "/"
                    "AND" "OR" "NOT" "XOR" "&" "|" and "^".  String
                    functions include CONCAT, COPY, SCAN etc.
          
          
       RETURN VALUE
     
          Variable has the result of Expr
          
          
       DESCRIPTION
     
          Sets the value of NUMERIC variables or STRING variables.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @SET PREV = 1
     @SET SAD = PREV + 1
     @SET NEXTONE = SAD / PREV
     @SET DEST = EMG
     @SET MODE = "FD"
     @SET DEST = trim(copy(LINE,45,20))
     @SET TRUE = NOT(A)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@SETDEST                                                 @SETDEST

          SYNOPSIS
     
          @SETDEST [ ( [ PortLabel ] ) ]
          
          
          SYNTAX
     
          @SETDEST [ ( [ Expr ] ) ]
          
          
          PARAMETERS
     
          PortLabel - The name of the destination to be associated
                    with the current port.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Set the name of the destination associated with the current
          port.  This name is displayed in the label on the left end
          of the status bar (ie Field 1).  This field is automatically
          updated when an exchange header is received from the host in
          AOM, IOG11, IOIM, SYS12, MNOSS and TW modes.  The Port Label
          field may be up to 5 characters.  (Note: the current version
          will display up to 8 characters until the field is overwritten
          by Ozterm - but this behaviour will change in a future
          release).
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @SETDEST('Sortr')
     
     or
     
     @SET portNum = GETPORT()
     @SETDEST('Port{portNum}')
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@SETREPLY                                               @SETREPLY

          SYNOPSIS
     
          @SETREPLY(flag, slogan)
          
          
          SYNTAX
     
          @SETREPLY(ReplyFlagExpr, Expr)
               
               where ReplyFlagExpr OK or FAIL
          
          
          PARAMETERS
     
          flag   Can be OK or FAIL
          slogan Possible printout reply after the input of a command.
          
          
       RETURN VALUE
     
          Sets the Error Flag if the "FAIL" slogan is received.
          
          
       DESCRIPTION
     
          Sets "slogan" as an acceptable or unacceptable command
          response.  Ozterm allows the operator to specify one OK
          response and one FAIL response.  Each subsequent @SETREPLY
          with a given flag replaces the previous @SETREPLY for that
          flag.  To be used in conjunction with the WAITREPLY command.
          To reset reply checking of these use set @SETREPLY(OK,"")
          and @SETREPLY(FAIL,"")
          
          
       EXAMPLE
     
          
          
     @SETREPLY(OK,"ORDERED")
     DPNSS;
     @CNTRLD          @@log off
     @SETREPLY(FAIL,"CP FAULT")
     @SETREPLY(OK,"CP SB START PASSED")
     @WAITREPLY
     @IFERROR THEN GOTO FAULTY
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@STOP                                                       @STOP

          SYNOPSIS
     
          @STOP
          
          
          SYNTAX
     
          @STOP
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          To be inserted at the end of the transmit file.  When
          executed the transmit file is closed.
          This command does not set the error flag
          
          
          EXAMPLE
     
          
          
     @INKEY(CHOICE,'DO YOU WISH TO READ ANOTHER CUSTOMERS METER
     [Y/N]?')
     @IF CHOICE = 'Y' THEN GOTO REPMETER
     @IF CHOICE = 'N' THEN GOTO MODE
     @LABEL MODE
     @SEND(#16)
     @SEND(CLR,#13)
     @WAITFOR(AUSTPAC)
     @STOP
     


18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@SYSPWORD                                               @SYSPWORD

          SYNOPSIS
     
          @SYSPWORD(password)
          
          
          SYNTAX
     
          @SYSPWORD(Expr)
          
          
          PARAMETERS
     
          password As required for System 12 access.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Automatically sets your System 12 Password for the @LOGON
          command.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
     @@---- REQUEST System 12 PASSWORD ---------@@
     @LABEL SETSYSPASS
       @INPUT(syspass,'Enter S12 Password')
       @SYSPWORD(syspass)
       @RETURN
      



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@TITLE                                                     @TITLE

          SYNOPSIS
     
          @TITLE (name)
          
          
          SYNTAX
     
          @TITLE(Expr)
          
          
          PARAMETERS
     
          name      The descriptive name to be applied to the transmit
                    file being executed.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Sets the title of the file which is displayed in the
          'Description' field of the "New Transmit File" selection
          window.  Used to indicate to the operator the function of
          the transmit file when selecting a file to execute.
          This command does not set the error flag
          
          
       EXAMPLE
     
     @TITLE("Device Connection")
     
     Ŀ
     Transmit Filename                     Description          
                                                                
      1                                                         
      2 C:\OZTERM\                                              
      3 C:\OZTERM\CMDS\UTILS\UNIVDUMP.CMD  /36 /66 Backup Dump  
      4 C:\OZTERM\CMDS\66\66ALARM.CMD      /66 Fault clearance  
      5 C:\OZTERM\CMDS\29MENU.CMD          Menu of /29 Script f 
      6 C:\OZTERM\CMDS\PMB\DUMUP.CMD       RT DIP stats         
      7 C:\OZTERM\CMDS\NASM\SE.CMD         System Event Data Co 
      8 C:\OZTERM\CMDS\PMB\CMDLOG.CMD      /66 Dump of Commandl 
      9 C:\OZTERM\CMDS\CONNECT.CMD         Device Connection    
     10 C:\OZTERM\OZ_4\OZTERM.DFT                               
                                                                
        F1 directory  F2 file edit  move   select  ESC quit     
     




18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@TRACE                                                     @TRACE

          SYNOPSIS
     
          @TRACE(File_name)
     
          SYNTAX
     
          @TRACE[(Expr)]
          
          PARAMETERS
     
          File_name The file name for storing the Script file tracing.
                    If no file name is set, tracing is turned off.
          
       RETURN VALUE
     
          None
          
       DESCRIPTION
     
          This command is used to turn script tracing on and off.
          When @TRACE is specified with a file name tracing is turned
          on.  All subsequent script file actions are appended to the
          file name specified in the command.  When @TRACE is
          specified without a file name, script file tracing ceases.
          This is similar to the "Program Trace" selection on the
          Transmit File Menu.  In the result file each logical step is
          shown starting with the current script file name.  If a line
          of script contains several commands or functions, that line
          is shown in the result file as each result is received.
          
       EXAMPLE
     
     @TRACE("Trace.txt")
     @SET X = 3
     @SET Y = 1
     @IF ((X=3) AND (Y=1)) THEN GOTO GOOD
     @LABEL GOOD
     @COMMENT("OK")
     @TRACE
     
     Gives the resulting TRACE.TXT file shown below (Note that Line 4
     is shown twice.  Once for the result to the IF command, the
     second time for the result command from a positive result, ie
     GOTO GOOD):
     
     ***** OK      FILENAME = C:\OZTERM\TRACE.CMD
     ***** OK      START TRACE
     00002 OK      @SET | {X} = 3
     00003 OK      @SET | {Y} = 1
     00004 OK      @IF | IF_RESULT = 1
     00004 OK      @GOTO GOOD
     00009 OK      @LABEL GOOD
     00010 OK      @COMMENT
     ***** OK      END TRACE
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@UNHIDE                                                   @UNHIDE

          SYNOPSIS
     
          @UNHIDE
          
          
          SYNTAX
     
          @UNHIDE
          
          
          PARAMETERS
     
          None
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Re-opens the transmit script file window if previously
          hidden with the @HIDE command.
          
          
       EXAMPLE
     
          
          
     @HIDE
     @INCLUDE("SAMP_CON.CMD")
     @UNHIDE
     @INCLUDE("DCN.CMD")
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@VIEWFILE                                               @VIEWFILE

          SYNOPSIS
     
          @VIEWFILE(file_name)
          
          
          SYNTAX
     
          @VIEWFILE(Expr)
          
          
          PARAMETERS
     
          file_name Name (and path) of file to be viewed.  Can be a
                    variable substitution or a direct file name.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Views a the specified file and allows string search.
          Error Flag is set if the file is not accessible or invalid.
          
       EXAMPLE
     
          
          
     @INPUT(COMPSITE," Enter name of site for PCORP compare ")
     @EXECUTE("c:\pcorp\pcorp.bat x={EMG}{CNA} r={COMPSITE}")
     @VIEWFILE("c:\pcorp\dat\error.txt")
     @LABEL END
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@WAITFOR                                                 @WAITFOR

          SYNOPSIS
     
          @WAITFOR(var1[, [var2, ] secs ] )
          
          
          SYNTAX
     
          @WAITFOR(Expr[, [Expr, ] Expr ] )
          
          
          PARAMETERS
     
          var1   String variable text.
          var2   String variable text.  Optional.
          secs   optional if var2 HASN'T been specified.  Must be
                 specified if var2 is set.  numeric value for a number
                 of seconds.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Waits for up to "secs" seconds for the strings "var1" and
          "var2" to be received.
          If there is more than one parameter the last one will be
          interpreted as Time-out
          May be used in conjunction with @SETREPLY
          The error Flag is set if there is a Time-out
          
       EXAMPLE
     
          
          
     @WAITFOR("EXECUTED",10)
     
     @WAITFOR("END",#13,10)
     
     @WAITFOR(#13)
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@WAITREPLY                                             @WAITREPLY

          SYNOPSIS
     
          @WAITREPLY[([Time_out])]
          
          
          SYNTAX
     
          @WAITREPLY[([Expr])]
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Waits for an AXE print-out before stepping to the next
          instruction. May be used in conjunction with @SETREPLY.
          
          
          EXAMPLE
     
          
     @SETREPLY(OK,"ORDERED")
     DPNSS;
     @CNTRLD          @@log off
     @SETREPLY(FAIL,"CP FAULT")
     @SETREPLY(OK,"CP SB START PASSED")
     @WAITREPLY
     @IFERROR THEN GOTO FAULTY
     



18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@WINDEND                                                 @WINDEND

          SYNOPSIS
     
          @WINDEND
          
          
          SYNTAX
     
          @WINDEND
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Closes the 7 line user window created by @WINDOW.
          This command does not set the error flag
          
          
          EXAMPLE
     
          
     @LABEL MENU
       @SET OZPATH = 'C:\OZTERM\'
       @SET DIR = CONCAT(OZPATH,'CMDS\36\')
       @HIDE
       @WINDOW
       @DRAW(CUP,20,1,INV,' -/36 Transmit File Menu ')
       @DRAW(CUP,03,3,HIGH,'1',LOW,' Exchange state check')
       @DRAW(CUP,03,4,HIGH,'2',LOW,' Alarm clearance and Faults')
       @DRAW(CUP,03,7,HIGH,'5',LOW,' PMB Functions'
       @DRAW(CUP,43,5,HIGH,'Q',LOW,'uit')
       @DRAW(HIGH,CUP,6,10,'TAB',LOW,' move',#196,#196)
       @DRAW(HIGH,#17,#196,#217,LOW,' select')
       @MENU(CHOICE,5,3,'1','2','3','4','5','6','7','Q')
       @WINDEND
       @SET FILE = ''
     

18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@WINDOW                                                   @WINDOW

          SYNOPSIS
     
          @WINDOW
          
          
          SYNTAX
     
          @WINDOW
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          None
          
          
          DESCRIPTION
     
          Opens a 7 line user window at the top of the main screen,
          and directs all  @COMMENT displays to this window.  Useful
          for a scrolling type output.  (When used with @MENU only the
          TAB key can be used to select item).
          This command does not set the error flag
          
          
          EXAMPLE
     
          
          
     @WINDOW
     @CHECK(ON)
     @COMMENT("           C N A 8    P R O C E D U R E")
     @COMMENT(" * This procedure loads CNA8 into the standby CP
     side.")
     @INPUT(EMG,"Enter exchange LNCD code (eg TCKX)")
     

18.3      SCRIPT LANGUAGE COMMAND DESCRIPTIONS (Continued)

@WRITE                                                     @WRITE

          SYNOPSIS
     
          @WRITE(file_name {, par } )
          
          
          SYNTAX
     
          @WRITE(Expr {, Expr } )
          
          
          PARAMETERS
     
          file_name can be a variable substitution or a direct file
                    name.
          par       optional - can be an number of variables or
                    strings.  If omitted, a blank line is written to
                    the file.
          
          
       RETURN VALUE
     
          None
          
          
       DESCRIPTION
     
          Writes to file "file_name" the list of variables or string
          constants.  The file is automatically opened and the new
          line is appended.  The line is terminated by CR, LF.  If the
          file is non-existent it will be created.
          The Error flag is set if the file cannot be written to, the
          file is not accessible etc.
          
          
       EXAMPLE
     
          
          
     @SET FILE = "SEQAR.LOG"
     @IF BTCNT = 0 THEN GOTO EXIT
     @WRITE(FILE,"------------",DATE,"---------")
     @SET BTPTR = 0
     @LABEL SEQLOOP
       @INC(BTPTR)
       @IF BTPTR > BTCNT THEN GOTO EXIT
       @SET DEV = TRIM(BT[{BTPTR}])
       @COMMENT(" Doing *{DEV}..")
       SEQAR:DEV={DEV};
       STDEP:DEV={DEV};
       @SET ROUTE = COPY(REPLY(SCAN(DEV)),41,10)     @@find route
       @COMMENT("        Route=*{ROUTE}")
       @WRITE(FILE,BT[{BTPTR}]," ",ROUTE)
       @GOTO SEQLOOP
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS

ADVANCE                                                   ADVANCE

          SYNOPSIS
     
          ADVANCE(date_time, interval_unit[,SINGLE])
          
          
          SYNTAX
     
          ADVANCE(Expr, Expr,[SINGLE])
          
          
          PARAMETERS
     
          date_time   Has format YYMMDDHHMM.
          interval_unit  Can take the values 1 - 99 W,D,H, or M  ie 1
                      - 99 Weeks, Days, Hours or Minutes.
          SINGLE      Optional, the word SINGLE must be used for
                      single advance only.
          
       RETURN VALUE
     
          If have an invalid parameter (eg.  date_time of 9215260930
          has an invalid month) get a result of 0 otherwise result is
          "date_time" incremented by "interval_unit".  Parameter
          date_time is not altered.
          
          
       DESCRIPTION
     
          Allows Date/Time variable to be incremented by a specified
          amount.  This function is intended to be used in conjunction
          with time events.  The result of advancing a date & time
          will always result in a date and time which is in the
          future.  This is achieved by repeatedly advancing the
          parameter by the specified interval until the result is a
          time and date which has not yet passed.  If the optional
          SINGLE parameter is used the Date/Time will only be advanced
          by one unit specified by "interval_unit", regardless of
          whether the result is in the past or not.
          This command does not set the error flag
          
          
       EXAMPLE
     
          Example 1.  This example could be used when scheduling an
          event to run every four weeks.
          
     @SET sched = ADVANCE(sched,'4W')
          
     @SET sched = ADVANCE(sched,'1D',SINGLE)
          


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (ADVANCE Continued)

          Example 2.
          
     @EVDELETE()
     @GETDATE(now)
     @COMMENT('File Time1.cmd was run manually at ',now)
     @SET result = TIMEEVSET('t1',ADVANCE(now,'1m'))
     @IF result = 0 then GOTO SETOK
     @IF result = 1 then GOTO NOSPACE
     @COMMENT('Invalid parameter used')
     @STOP
     
     @LABEL SETOK
     @COMMENT('and subsequent event set.')
     @STOP
     
     @LABEL NOSPACE
     @COMMENT('No space in Event Table for subsequent event')
     @STOP
     
     @LABEL t1
     @GETDATE(now)
     @COMMENT('Time1 Autotriggered at ',now)
     @SET result = TIMEEVSET('t1',ADVANCE(GETSCHED(),'1m'))
     @STOP
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

CONCAT                                                     CONCAT

          SYNOPSIS
     
          CONCAT(par, par {, par } )
          
          
          SYNTAX
     
          CONCAT(Expr, Expr {, Expr } )
          
          
          PARAMETERS
     
          par      any number of string variables or constants
          
          
       RETURN VALUE
     
          The concatenation of all the parameters.
          
          
       DESCRIPTION
     
          Concatenates (joins together as one string) the parameters
          in the order supplied, up to a maximum 255 characters.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
          
  @INPUT(EMG," Enter exchange LNCD code (eg TCKX)")
  @SET RELFSW = "RELFSW0"
  @INPUT(RELFSW," Enter reload file to standby CP load from (usually
  RELFSW0)")
  @LOG(CONCAT("c:",EMG,".LOG"))      @@log file c:LRDC.LOG !
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

CHR                                                           CHR

          SYNOPSIS
     
          CHR(variable)
          
          
          SYNTAX
     
          CHR(var_expr)
          
          
          PARAMETERS
     
          variable Decimal ASCII number 0 - 255
          
          
       RETURN VALUE
     
          Ascii equivalent character eg 65 = A
          
          
       DESCRIPTION
     
          Used to set ascii equivalent characters.
          
          
       EXAMPLE
     
     
     @SET CHAR = CHR(65)
          


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

COPY                                                         COPY

          SYNOPSIS
     
          COPY(source_string, start_position, copy_length)
          
          
          SYNTAX
     
          COPY(Expr, Expr, Expr)
          
          
          PARAMETERS
     
          source_string  a word or line of text.
          start_position numeric value.  Point of "source_string" to
                         start copying.
          copy_length    numeric value.  Number of characters past
                         "start_position" to be copied.
          
          
       RETURN VALUE
     
          A substring of "source_string" being "copy_length"
          characters long starting from position "start_position".
          
          
       DESCRIPTION
     
          Returns a sub-string of variable "source_string", starting
          from position "start_position" for the length "copy_length".
          The first character is position 1.  COPY will copy up to the
          end of the String, or truncate at 255 characters, whichever
          comes first.  No characters returned if copying after the
          end of the string.
          A warning is now displayed if the Script command attempts to
          use illegal start position or copy length parameters, eg
          negative.  This a warning message only displayed for 3
          seconds.  The script will then continue, using the default
          values of 1 fro start position, if that is the invalid
          parameter, or copy length 0, if that is the invalid
          parameter.
          This command does not set the error flag
          
          
       EXAMPLE
     
     @GETDATE(LDATE)
     @SET DATE = COPY(LDATE,1,6)
     @SET TIME = COPY(LDATE,7,4)
     @SET DAY = COPY(LDATE,13,3)
     @COMMENT("       * Check PC time and date..")
     @COMMENT("  DATE=*{DATE}^ DAY=*{DAY}^ TIME=*{TIME}")
     @INKEY(CHOICE," Are DATE and TIME shown above correct [Y/N] ?")
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

DECIMAL                                                   DECIMAL

          SYNOPSIS
     
          DECIMAL(hex_Number)
          
          
          SYNTAX
     
          DECIMAL(Expr)
          
          
          PARAMETERS
     
          hex_value an hexadecimal value.
          
          
       RETURN VALUE
     
          The decimal value corresponding to the hexadecimal
          parameter.
          
          
       DESCRIPTION
     
          Converts the supplied parameter from an hexadecimal value to
          its equivalent decimal value.
          
          
       EXAMPLE
     
          
     @SET D = DECIMAL('2F8')
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

DISKFREE                                                 DISKFREE

          SYNOPSIS
     
          DISKFREE( [ drive ] )
          
          
          SYNTAX
     
          DISKFREE( [ Expr ] )
          
          
          PARAMETERS
     
          drive     optional - specify which drive to examine.  The
                    default is the current drive.
          
          
       RETURN VALUE
     
          The amount of space available on the disk drive.  The value
          returned is in kilo-bytes.
          
          
       DESCRIPTION
     
          Examines the disk drive and returns the amount of free space
          in kilo-bytes.  Note that 1 kilo-byte is 1024 bytes.  This
          function examines only the first letter of the parameter, so
          a file name which includes the drive letter (and optionally,
          a path) is a valid parameter for this function.
          
          
       EXAMPLE
     
          
          
     @SET F = DISKFREE()
     @COMMENT('Free space = ', F, 'k')
     
     
     @COMMENT(DISKFREE('C:'))
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

EVLOADED                                                 EVLOADED

          SYNOPSIS
     
          EVLOADED( [ label ] )
          
          
          SYNTAX
     
          EVLOADED( [ Expr ] )
          
          
          PARAMETERS
     
          label     optional identifying label within the transmit
                    file.  Up to 10 alphanumeric characters.
          
          
       RETURN VALUE
     
          A result of 0 means no events using this transmit file name
          (and label) are set up.
          A result of 1 means that at least one event using this
          transmit file's name (and starting at address "label") has
          been set up.
          
          
       DESCRIPTION
     
          Tests to see if there is an event (Text or Time) set up (in
          the Event Tables) to use this transmit file, specifically
          starting at the point "label" (which is optional).  If
          "label" is not used the brackets () are still required and
          this function will search the event tables for any event
          using this transmit file name (ie. this transmit file that
          is running and that this function is in).
          
          
       EXAMPLE
     
          
          
     @SET result = EVLOADED("trigger")
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

FILECHPOS                                               FILECHPOS

          SYNOPSIS
     
          FILECHPOS(file_name)
          
          
          SYNTAX
     
          FILECHPOS(Expr)
          
          
          PARAMETERS
     
          File_namemay be a variable or the actual file name in
          quotes.
          
          
       RETURN VALUE
     
          The character position pointer value in the specified file.
          
          
       DESCRIPTION
     
          Returns the current character position in the specified
          file.
          NOTE:  Does not return the character position on the line,
                 but the absolute character position from the start of
                 the file.
          
          
       EXAMPLE
     
          
          @SET fn = 'test\tfile8.txt'
          @FILEOPEN(fn,'rw')
          @FILEEND(fn)
          @SET chpos = FILECHPOS(fn)
          @COMMENT("character position = ",chpos)



18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

FILELNPOS                                               FILELNPOS

          SYNOPSIS
     
          FILELNPOS(file_name)
          
          
          SYNTAX
     
          FILELNPOS(Expr)
          
          
          PARAMETERS
     
          File_namemay be a variable or the actual file name in
          quotes.
          
          
       RETURN VALUE
     
          The line position pointer value in the specified file.
          
          
       DESCRIPTION
     
          Returns the current line position in the specified file.
          NOTE:  Does not return the character position on the line,
                 but the line number the file character pointer is
                 currently on.
          
          
       EXAMPLE
     
          
          @SET fn = 'test\tfile8.txt'
          @FILEOPEN(fn,'rw')
          @FILEEND(fn)
          @SET lnpos = FILELNPOS(fn)
          @COMMENT("line number = ",lnpos)



18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

FILEREADCH                                             FILEREADCH

          SYNOPSIS
     
          FILEREADCH(file_name[,numofchars])
          
          
          SYNTAX
     
          FILEREADCH(Expr[,Expr])
          
          
          PARAMETERS
     
         File_name may be a variable or the actual file name in
                    quotes.
         Numofcharsoptional, evaluates to a numeric value for the
                    number of characters to be read from the file.
                    Maximum of 255.
          
       RETURN VALUE
     
          The contents of the file from the current file character
          position, up to Numofchars.  If Numofchars isn't set, only
          one character is read.
          
       DESCRIPTION
     
          Returns a number of characters (including control
          characters, eg CR, LF, etc) from the current file pointer
          position.  If Numofchars isn't set only the next character
          is returned.  If the end-of-file is reached all contents up
          to the end-of-file are returned, and the Error Flag is set.
          The file must first be opened with @FILEOPEN.
          
          
       EXAMPLE
     
          
            @SET fn = 'test\tfile8.txt'
            @FILEOPEN(fn)
            @CHECK(off)
            @SET data = FILEREADCH(fn,10)
            @CHECK(on)
            @IFERROR then GOTO endoffile



18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

FILEREADLN                                             FILEREADLN

          SYNOPSIS
     
          FILEREADLN(file_name)
          
          
          SYNTAX
     
          FILEREADLN(Expr)
          
          
          PARAMETERS
     
         Filename  may be a variable or the actual file name in
                    quotes.
          
          
       RETURN VALUE
     
          The line of data in the file from the current file line
          position.
          
          
       DESCRIPTION
     
          Reads a line of data from the specified file from the start
          of the current line.  The file must already be open, ie
          @FILEOPEN.  If the current file line position is the end-of-
          file the error flag will be set with the next FILEREADLN.
          The command will store the first 255 characters in the line.
          A "line" is the data from the start of the current line to a
          line terminator, ie LF, VT or FF.
          
          
       EXAMPLE
     
          
            @SET fn = 'test\tfile8.txt'
            @FILEOPEN(fn)
            @CHECK(off)
            @SET data = FILEREADLN(fn)
            @CHECK(on)
            @IFERROR then GOTO endoffile



18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

FILETRANS                                               FILETRANS

          SYNOPSIS
     
          FILETRANS(direction, file, protocol)
          
          
          SYNTAX
     
          FILETRANS(FileDirExpr, Expr, FileModeExpr)
          
          
          
          PARAMETERS
     
          direction   R to receive (ie download) the file, or S to
                      send (ie Upload) the file
          file        Specifies the name of the file to be
                      transferred.
          protocol    A for ASCII, X for X-Modem protocol.
          
          
       RETURN VALUE
     
          0         if the file transfer was successful.
          1         if the transfer failed (eg, file could not be
          found, etc).
          
          
       DESCRIPTION
     
          Allows files to be transferred under control of the script.
          Supports ASCII or X-Modem protocols.
          
          
       EXAMPLE
     
          
          
     @SET RESULT = FILETRANS('S', "C:\PATH\FILE.TXT", 'X')
     @IF result = 1 then GOTO error
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

GETDEST                                                   GETDEST

          SYNOPSIS
     
          GETDEST()
          
          
          SYNTAX
     
          GETDEST()
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          The destination label as displayed in the bottom left corner
          of the screen.
          
          
          DESCRIPTION
     
          This function allows a script file to read the name of the
          destination with which it is connected.  The destination is
          the contents of the field displayed in the bottom left
          corner of the screen (ie field 1 of the status line).  This
          field is updated when an exchange header is received, or by
          the script command @SETDEST.
          
          
          EXAMPLE
     
          
          
  @LOGON
  @SET dst = trim(GETDEST())
  @SET hdr = GETHEADER()
  @COMMENT(copy(hdr, POS(dst, hdr), 21))  @@ Get the National Exchange
  Header
  @LOGOFF
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

GETHEADER                                               GETHEADER

          SYNOPSIS
     
          GETHEADER()
          
          
          SYNTAX
     
          GETHEADER()
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          The last header received from the exchange.
          
          
          DESCRIPTION
     
          This function allows script programs to use the information
          contained in the exchange header.
          
          
          EXAMPLE
     
          
          
  @LOGON
  @SET dst = trim(GETDEST())
  @SET hdr = GETHEADER()
  @COMMENT(copy(hdr, POS(dst, hdr), 21))  @@ Get the National Exchange
  Header
  @LOGOFF
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

GETLOG                                                     GETLOG

          SYNOPSIS
     
          GETLOG(variable)
          
          
          SYNTAX
     
          GETLOG(variable)
          
          
          PARAMETERS
     
          variable  optional, used to test if the log file is open or
          not.
          
          
          RETURN VALUE
     
          The full name of the current log file (including the drive
          and path).
          If "variable" is specified:0 Log file not currently open.
                              1    Log file is currently open.
          
          
                              DESCRIPTION
     
          This function allows a script file to determine the name of
          the current log file, and if the log file is open or not if
          the optional "variable" is specified.  This allows the
          current log file name to be saved while a script file logs
          its activity into its own log file, and to restore the
          original log file when it has completed its task.
          Null return indicates file has been previously specified.
          
          
                              EXAMPLE
     
          
          
     @SET OLDLOG = GETLOG(open)
     @LOG('script.log')
       :
       :
     @CLOSE
     @IF open = 1 THEN LOG(OLDLOG)
     



18.4      SCRIPT  LANGUAGE FUNCTION  DESCRIPTIONS (Continued)

GETMODE                                                   GETMODE

          SYNOPSIS
     
          GETMODE()
          
          
          SYNTAX
     
          GETMODE()
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          The current terminal emulation mode (eg. TW, FD, etc).
          
          
          DESCRIPTION
     
          This function allows a script file to determine the current
          terminal emulation mode.  This allows the current terminal
          mode to be saved while a script file uses a different mode
          for some activity.  The saved terminal mode can be restored
          using the @MODE script command.
          
          
          EXAMPLE
     
          
          
     @SET OLDMODE = GETMODE()
     @MODE(FD)
       :
       :
     @MODE(OLDMODE)
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

GETNAME                                                   GETNAME

          SYNOPSIS
     
          GETNAME()
          
          
          SYNTAX
     
          GETNAME()
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          The full path and name of the current file that is running.
          
          
          DESCRIPTION
     
          This function allows a script file to determine the file
          name currently in use.
          
          EXAMPLE
     
          
     @SET CUR_FILE = GETNAME()
          
     

18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

GETPORT                                                   GETPORT

          SYNOPSIS
     
          GETPORT()
          
          
          SYNTAX
     
          GETPORT()
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          The port number for the current port.
          
          
          DESCRIPTION
     
          This function allows a script file to determine the port
          currently in use.  This allows the current port to be saved
          while a script file swaps to another port to perform some
          activity.  The saved port can be restored using the @PORTNO
          script command.
          
          
          EXAMPLE
     
          
          
     @SET OLDPORT = GETPORT()
     @PORTNO(nextport)
       :
       :
     @PORTNO(OLDPORT)
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

GETPRINT                                                 GETPRINT

          SYNOPSIS
     
          GETPRINT()
          
          
          SYNTAX
     
          GETPRINT()
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          The printer number for the currently selected printer.
          
          
          DESCRIPTION
     
          This function allows a script file to determine the printer
          currently in use.  This allows the current printer to be
          saved while a script file sets up another printer to be used
          while it is running.  The saved printer can be restored
          using the @SELPRINT script command.
          
          
          EXAMPLE
     
          
          
     @SET LPT = 3
     @SET OLDLPT = GETPRINT()
     @SELPRINT(LPT)
       :
       :
     @SELPRINT(OLDLPT)
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

GETSCHED                                                 GETSCHED

          SYNOPSIS
     
          GETSCHED()
          
          
          SYNTAX
     
          GETSCHED()
          
          
          PARAMETERS
     
          None.
          
          
          RETURN VALUE
     
          Returns a 0 if this transmit file is not Time triggered.
          Otherwise it returns date_time as set in the Event Table
          (format YYMMDDHHMM - compatible with @GETDATE).
          
          
          DESCRIPTION
     
          Returns the date and time this transmit file was scheduled
          to run.   GETSCHED used in conjunction with ADVANCE can be
          utilised to keep synchronisation of events if OZTERM is not
          running for a while.
          
          
          EXAMPLE
     
          
          
     @SET result = TIMEEVSET('t1',advance(GETSCHED(),'1m'))
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

HEX                                                           HEX

          SYNOPSIS
     
          HEX(decimal_no, [ length ] )
          
          
          SYNTAX
     
          HEX(Expr, [ Expr ] )
          
          
          PARAMETERS
     
          decimal_no     numeric value.  Decimal number to be
                         converted to Hexadecimal.
          length    optional.  The number of characters required for
                    the resultant hex number.  Default is 4.
          
          
       RETURN VALUE
     
          Hexadecimal equivalent to parameter "decimal_no".
          
          
       DESCRIPTION
     
          Returns the hexadecimal value of a number as a string of
          "length" characters.  If the optional Length parameter is
          set, the result is truncated to the number of characters set
          in "length".  If the result has less characters than that
          set in "length", the result is padded with 0's.
          
          
       EXAMPLE
     
          
          
     @SET DECI_NUM = 65124
     @SET HEX_NUM = HEX(DECI_NUM)     @@ assigns a value of FE64
     @SET HEX_NUM = HEX(DECI_NUM,2)   @@ assigns a value of 64
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

INHISTORY                                               INHISTORY

          SYNOPSIS
     
          INHISTORY(date_time)
          
          
          SYNTAX
     
          INHISTORY(Expr)
          
          
          PARAMETERS
     
          date_time Can be a variable substitution or direct date
                    entry of the format YYMMDDHHMM
          
          
       RETURN VALUE
     
          1         if parameter "date_time" is prior to the current
                    Time (ie. In history or in the past).
          0         if parameter "date_time" is a time in advance of
                    the current time (ie. Not in history or in the
                    future).
          
          
       DESCRIPTION
     
          Returns a the value 1 if "date_time" is in the past and a
          value of 0 if "date_time" is in the future.
          
          
       EXAMPLE
     
          The following example runs this file at the next occurring
          3am.  It gets today's date and sets 'sched' equal to 3am
          today.  If it is already past 3am today then 'sched' is
          advanced to 3am tomorrow.  It then sets up a Time Event
          (which runs this transmit file starting at label 3AM) to
          start at 'sched'.
          
     @GETDATE(today)
     @SET sched = CONCAT(copy(today,1,6),'0300')
     @IF INHISTORY(sched) = 0 then GOTO set
     @SET sched = advance(sched,'1D')
     
     @LABEL set
       @SET result = TIMEEVSET('3AM',sched)
       @COMMENT('Set result = ',result)
       @STOP
     
     @LABEL 3AM
       @COMMENT('3AM')
       @STOP
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

INSET                                                       INSET

          SYNOPSIS
     
          INSET(var, expr{,expr})
          
          
          SYNTAX
     
          INSET(DefinedVariable, Expr{,Expr})
          
          
          PARAMETERS
     
          Var       Value to be checked if it is a part of the set.
          Expr...   the values for the members of the set to be
                    checked.
          
       RETURN VALUE
     
          0        if Not in set, ie no match found for "Var".
          1        if In set, ie match found for "Var".
          
       DESCRIPTION
     
          Makes compound @IF statements redundant
          eg   @IF A = 'A' THEN ....
               @IF A = '1' THEN ....
               @IF A = 'Hello' THEN ....
          can be replaced by...
               @IF INSET(A, 'A','1','Hello') THEN ....
          Error flag is set if the variable does not exist or there
          are no expressions.
          
       EXAMPLE
     
          @SET A = 'Hello'
          @IF INSET(A,'BYE','YES','HELLO') THEN .....
          



18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

KEYPRESS                                                 KEYPRESS

          SYNOPSIS
     
          KEYPRESS([key])
          
          
          SYNTAX
     
          KEYPRESS([var])
          
          
          PARAMETERS
     
          key      optional, stores the decimal value of the ASCII
          key pressed.
          
          
       RETURN VALUE
     
          Return of 0 indicates no key pressed
          Return of 1 indicates a key was pressed
          If "key" is specified, stores the  ASCII equivalent value of
          key pressed
          
          
       DESCRIPTION
     
          Returns a value of 0 or 1 depending on whether a key was
          pressed or not.  The optional "key" returns the ASCII
          equivalent value of the key pressed.
          


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (KEYPRESS Continued)
     
     
       EXAMPLE
     
     @WINDOW
     @CLRSCR
     @SET qn = 'N'
     @SET Count = 0
     @SET key = ''
     @GOTO PROGRAM
     
     @LABEL Terminate
       @SET KeyVal = CHR(key)
       @COMMENT('*Key ^{keyVal} *was pressed. (ASCII ^{key})')
       @INKEY(qn,'Do you wish to terminate (Y/N) S = Slow Count')
     @RETURN
     
     @LABEL delayed
       @FOR x = 1 to 100
       @NEXT x
     @RETURN
     
     @LABEL Counter
       @INC(count)
       @IF qn = 'S' then GOSUB delayed
       @DRAW(cup,22,2,high,count)
     @RETURN
     
     @LABEL NewKey
       @SET key = ''
       @COMMENT('I can Identify your key if you press it again..')
       @LABEL RepeatKey
         @GOSUB Counter
         @IF KEYPRESS(key) then GOSUB terminate
         @IF qn = 'Y' then return
       @GOTO RepeatKey
     
     @LABEL Program
       @COMMENT('*KEYPRESS Function:')
       @LABEL Loop
         @GOSUB Counter
         @IF KEYPRESS() then GOSUB NewKey
       @IF qn = 'N' then GOTO loop
     @STOP



18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

LENGTH                                                     LENGTH

          SYNOPSIS
     
          LENGTH(main_string)
          
          
          SYNTAX
     
          LENGTH(Expr)
          
          
          PARAMETERS
     
          main_string string variable.  Can be variable substitution
                      or direct text enclosed in inverted commas.
          
          
       RETURN VALUE
     
          The length of the string "main_string".
          
          
       DESCRIPTION
     
          Returns the length of the text "main_string".
          
          
       EXAMPLE
     
          
          
     @IF LENGTH(EMG) <> 4 THEN GOSUB GETEMG
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

LOWCASE                                                   LOWCASE

          SYNOPSIS
     
          LOWCASE(string)
          
          
          SYNTAX
     
          LOWCASE(Expr)
          
          
          PARAMETERS
     
         string    the string that is to be converted to lower case.
                    May be the actual text, or a variable
                    substitution.
          
       RETURN VALUE
     
          Converted lower case string
          
       DESCRIPTION
     
          Converts A...Z to lower case, all other characters are not
          affected.
          
       EXAMPLE
     
          @SET A = 'abcD1234'
          @comment(LOWCASE(A))   @@(Prints out abcd1234)
          
          
     

18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

MEMAVAIL                                                 MEMAVAIL

          SYNOPSIS
     
          MEMAVAIL()
          
          
          SYNTAX
     
          MEMAVAIL()
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          The amount of memory (in bytes) available in which to
          execute an application or utility.
          
          
          DESCRIPTION
     
          This function allows a script file to determine the amount
          of memory available from a DOS gateway.  A script file could
          elect to not run an application or utility and display an
          error message if insufficient memory is available to execute
          it.
          
          
          EXAMPLE
     
          
          
     @COMMENT('Available memory = <', MEMAVAIL(), '>')
     

18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

ORD                                                           ORD

          SYNOPSIS

          ORD(character)


          SYNTAX

          ORD(Expr)


          PARAMETERS

          character   Any ASCII character


          RETURN VALUE

          The character ordinal value in decimal, eg ORD("A") -> 65


          DESCRIPTION

          Used to convert a character into its ordinal value.

          The command file always stops with a fatal error message to
          the user if the parameter is not a valid character.


          EXAMPLE

        @set chNum = ORD('A')
        @comment(chNum) @@ Print 65



18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

POS                                                           POS

          SYNOPSIS
     
          POS(sub_string, string[,count])
          
          SYNTAX
     
          POS(Expr, Expr,Expr)
          
          PARAMETERS
     
          sub_string  Variable substitution or direct text in quotes.
                      Text being looked for.
          string      Variable substitution or direct text in quotes.
                      Text being searched through for the position of
                      "sub_string".
          count       Optional, used request a particular occurrence
                      of "sub_string".  May be set to a numeric value,
                      or LAST for the last occurrence of the
                      "sub_string".
          
       RETURN VALUE
     
          The start position (a numerical value) of a particular
          string "sub_string" in the string variable "string".
          Returns 0 if not found, or if "count" goes beyond the last
          occurrence of "sub_string". If the substring is "" the
          return value is 0
          
       DESCRIPTION
     
          Returns the start position of a particular string
          "sub_string" in the string variable "string".  The optional
          parameter "count" may be set to find a particular occurrence
          of "sub_string" (the default is 1, ie the first occurrence
          of "sub_string").  If "count" is set to "LAST", the last
          occurrence of "sub_string" will be located (even if the
          "LAST" occurrence is in fact the only occurrence of
          "sub_string").
          
       EXAMPLE
     
     @DRAW(INV,CUP,20,1," DISconnect SEPRM  ")
     @SET LINE = SCAN("LI-")
     @IF LINE = 0 THEN RETURN
     @SET LI = COPY(REPLY(LINE),POS("LI-",REPLY(LINE)) + 3,4)
     @SET LINE = SCAN("SEPRM-")
     @IF LINE = 0 THEN RETURN
     @SET SEPRM = COPY(REPLY(LINE),POS("SEPRM-",REPLY(LINE)) + 6,3)
     
     or
     
     @SET VAR = '1122334455667788'
     @COMMENT(POS('7',VAR,LAST))    @@gives answer 14
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

REGRESS                                                   REGRESS

          SYNOPSIS
     
          REGRESS(date_time, interval_unit)
          
          
          SYNTAX
     
          REGRESS(Expr, Expr)
          
          
          PARAMETERS
     
          date_time Has format YYMMDDHHMM.
          interval_unit  Can take the values 1 - 99 W,D,H, or M  ie 1
                    - 99 Weeks, Days, Hours or Minutes.
          
          
       RETURN VALUE
     
          If have an invalid parameter (eg.  date_time of 9215260930
          has an invalid month) get a result of 0, otherwise result is
          "date_time" decremented by "interval_unit".  Parameter
          date_time is not altered.
          
          
       DESCRIPTION
     
          Allows Date/Time variable to be decremented by a specified
          amount.  This function is intended to be used in conjunction
          with time events, ie opposite to ADVANCE.
          This command does not set the error flag
          
          
       EXAMPLE
     
          
     @SET sched = REGRESS(sched,'4W')
          


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

REPLY                                                       REPLY

          SYNOPSIS
     
          REPLY(line_no)
          
          
          SYNTAX
     
          REPLY(Expr)
          
          
          PARAMETERS
     
          line_no   numeric value or variable substitution for a
                    specified line number.
          
          
       RETURN VALUE
     
          The string characters in line "line_no".
          
          
       DESCRIPTION
     
          Returns the text in the specified line "line_no" from the
          screen buffer since the last executed MML command or @MARK
          Command.
          
          
       EXAMPLE
     
          
          
@LABEL CHECKFCODE
  @SET RESULT = 1
  @SET LINE = SCAN("FCODE",POS)   @@ check for FCODE 0!
  @SET FCODE = COPY(REPLY(LINE + 1),POS,3)
  @IF FCODE = 0 THEN RETURN
  @SET RESULT = 0
  @INKEY(CHOICE," <<<< command failed, FCODE {FCODE} >>>*    press any
key...")
@RETURN
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

REPLYLEN                                                 REPLYLEN

          SYNOPSIS
     
          REPLYLEN
          
          
          SYNTAX
     
          REPLYLEN [ () ]
          
          
          PARAMETERS
     
          None
          
          
          RETURN VALUE
     
          Number of lines in the reply to the last MML command.
          
          
          DESCRIPTION
     
          Determines the number of lines displayed since the last MML
          command was executed or the last @MARK.
          
          
          EXAMPLE
     
          
          
     ALSTP;
     @DELAYSEC(5)
     @COMMENT('The reply was ', REPLYLEN, ' lines long')
     @SET line2 = reply(2)
     @COMMENT('Line 2 was ',line2)
     @COMMENT('The command was entered ', REPLYLEN(), ' lines ago')
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

SCAN                                                         SCAN

          SYNOPSIS
     
          SCAN(check_string [, colpos ] )
          
          
          SYNTAX
     
          SCAN(Expr [, VariableExpr ] )
          
          
          PARAMETERS
     
          check_stringstring of text to be searched for in the last
                    command reply.
          colpos    optional variable to hold the return value of the
                    column position in the string of "check_string".
          
          
       RETURN VALUE
     
          line      0 is returned if the string "check_string" is not
                    found, else a numeric value indicating the line
                    number with reference to the reply that
                    "check_string" was found in.
          colpos    optional, the numeric value indicating the column
                    position "check_string" was found in.
          
          
       DESCRIPTION
     
          Scans the reply from the last executed MML command for the
          string "check_string" and return the line number (0 if not
          found) and also the position of the string "check_string" in
          that individual line, in variable "colpos" (optional).
          
          
       EXAMPLE
     
          
          
     @LABEL RELTES1
       DIVAP:BNR=5, BAN=22, VLN=H0;
       @IF SCAN("00FF",colpos) <> 0 THEN GOTO RELTES2
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

TEXTEVSET                                               TEXTEVSET

          SYNOPSIS
     
          TEXTEVSET(label,slogan)
          
          
          SYNTAX
     
          TEXTEVSET(Expr, Expr)
          
          
          PARAMETERS
     
          label     - is the Label within the file that the text event
                    will run from.
          slogan    - is the string of text required to trigger the
                    Text event and run this transmit file.
          
          
       RETURN VALUE
     
          0         when the Text event was set up OK.
          1         implies no room left in the Text Event Table.
          2        means an invalid parameter (label or slogan) used.
          
          
       DESCRIPTION
     
          Sets up a Text Event (Previously known as Active Printout.
          See section 5.2.2) that will run the transmit file (starting
          at address "label") that this function is in, when the
          printout "slogan" is received.
          
          
       EXAMPLE
     
          
          
     @SET RESULT = TEXTEVSET('TXT','SUBSCRIBER')
     @STOP
     
     @LABEL 'TXT'
     @@Do rest of transmit file
          :
          :
          :
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)
          
TIMEEVSET                                               TIMEEVSET

          SYNOPSIS
     
          TIMEEVSET(label,date_time[,Re_Sch])
          
          
          SYNTAX
     
          TIMEEVSET(Expr, Expr [, ReschedExpr ] )
          
          
          PARAMETERS
     
          label     mandatory parameter identifying the Label at which
                    this transmit file will start when it is
                    triggered.
          date_time mandatory parameter, ie the date and time at which
                    the event will run.  Format is same as that for
                    @GETDATE - YYMMDDHHMM.
          Re_Sch    optional.  Can take A for automatic re-scheduling
                    at startup of OZTERM, in case OZTERM wasn't
                    running at the time the event's transmit file was
                    scheduled to run.  Or it can take M for manual re-
                    scheduling at startup of OZTERM.  Default is M
          
          
       RETURN VALUE
     
          0         when the event was set up OK.
          1         implies no room left in the Text Event Table.
          2         means an invalid parameter (label or slogan) used.
          
       DESCRIPTION
     
          Sets up a Time Event (see section 5.2.3 for more detail) in
          the Time Event menu that will be triggered at the set
          "date_time" to run this transmit file starting at LABEL
          "label".  If the "Re_Sch" has been set to "A", and the Date
          and Time has passed for the event to run, and OZTERM wasn't
          running when that time occurred, the event will clear from
          the Time Event menu without running.  If "Re_Sch" was set to
          "M" and the same circumstances occurred, when OZTERM is next
          run the operator is asked if they want to re-schedule the
          Time Event or let it run now.
          


18.4 SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (TIMEEVSET Continued)

       EXAMPLE
     
     @EVDELETE()     @@ remove all events for this script
     @GETDATE(now)
     @COMMENT('File Time1.cmd was run manually at ',now)
     @SET result = TIMEEVSET('t1',advance(now,'1m'))
     @IF result = 0 then GOTO SETOK
     @IF result = 1 then GOTO NOSPACE
     @COMMENT('Invalid parameter used')
     @STOP
     
     @LABEL SETOK
       @COMMENT('and subsequent event set.')
       @STOP
     
     @LABEL NOSPACE
       @COMMENT('No space in Event Table for subsequent event')
       @STOP
     
     @LABEL t1
       @GETDATE(now)
       @COMMENT('Time1 Autotriggered at ',now)
       @SET result = TIMEEVSET('t1',advance(GETSCHED(),'1m'))
       @STOP



18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

TRIM                                                         TRIM

          SYNOPSIS
     
          TRIM(main_string)
          
          
          SYNTAX
     
          TRIM(Expr)
          
          
          PARAMETERS
     
          main_string string variable, often a line of text read from
                    a file or screen.
          
          
       RETURN VALUE
     
          "main_string" with any leading or trailing spaces removed.
          "main_string" is not changed.
          
          
       DESCRIPTION
     
          Trims leading and trailing spaces from the string variable
          "main_string".
          
          
       EXAMPLE
        
          
     @SET DEST = trim(copy(LINE,45,20))
     @SET MODE = trim(copy(LINE,42,3))
     


18.4      SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

UPCASE                                                     UPCASE

          SYNOPSIS
     
          UPCASE(string)
          
          
          SYNTAX
     
          UPCASE(Expr)
          
          
          PARAMETERS
     
          string   the string to be converted to Upper Case.
          
          
       RETURN VALUE
     
          String converted to upper case
          
       DESCRIPTION
     
          Converts a...z to upper case, all other characters are not
          affected
          
       EXAMPLE
     
          @SET A = 'abcD1234'
          @comment(UPCASE(A))   @@(Prints out ABCD1234)
          
          

18.4 SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

VAREXIST                                                 VAREXIST

          SYNOPSIS
     
          VAREXIST(variable)
          
          
          SYNTAX
     
          VAREXIST(VariableExpr)
          
          
          PARAMETERS
     
          variable  The name of a variable whose existence is being
                    tested.
          
          
       RETURN VALUE
     
          0        if the variable does not exist.
          1        if it does exist.
          
          
       DESCRIPTION
     
          Allows a script file to determine the existence of a
          variable.  The typical usage of this facility is to
          initialise a variable to some sensible value if some other
          part of the script has not already set it up.
          
          
       EXAMPLE
         
          
     @IF VAREXIST(SPEED) = 0 THEN SET SPEED = 9600
     


18.4 SCRIPT LANGUAGE FUNCTION DESCRIPTIONS (Continued)

VERSION                                                   VERSION

          SYNOPSIS
     
          VERSION()
          
          
          SYNTAX
     
          VERSION()
          
          
          PARAMETERS
     
          None
          
          
       RETURN VALUE
     
          A string representation of the version number of Ozterm
          which is running the script file.
          
          
       DESCRIPTION
     
          Allows a script file to determine which version of Ozterm is
          being used to execute this transmit file.
          
          
       EXAMPLE
      
          
     @COMMENT("You are currently running Ozterm version ", VERSION())
     



18.5 SCRIPT LANGUAGE COMMAND INDEX


!               Indicates the following is a remark             
!$$$$!          End of sub-file, halt transmit file or return to host file
@@              Used to indicate that anything following is a remark
@AOMPWORD       Automatically sets your AOM password            
@AUTODIAL       Auto-dial the destination 'dest'                
@BAUD           Sets communication parameters                   
@BMODDIR        Sets Path for B Module Directory                
@BREAK          Send a 200 ms break to line                     
@CAT            Assigns subs category information to var 'catstring'
@CATFILE        Sets File name for Subs Category file           
@CHDIR          Change to another DOS directory                 
@CHECK          Enables/Disables command reply checking         
@CLOSE          Closes and flushes disk log file                
@CLRSCR         Clears the complete top screen                  
@CNTRLD         Logs off, and waits for 'quiet' line            
@COMMENT        Displays the text on screen                     
@DEC            Decrements numeric variable 'var'               
@DEL5MSEC       Pause for '5msecs' no of units of 5 msec        
@DELAY          Pause for 'mins' no of minutes                  
@DELAYSEC       Pause for 'secs' no of seconds                  
@DRAW           Allows elaborate screen output                  
@DTRBREAK       Release modem/network connection                
@EDITFILE       opens a file in the OZTERM editor               
@ELSE           Alternative for condition tested in IF and IFERROR 
@ENDFOR         allows early exit from FOR/NEXT loop            
@ERASE          Erases the file 'file_name'                     
@ESCKEY         Enables/Disables ESC key when script file is running
@EVDELETE       Clears the entry of this event from the Event table
@EVSETPRI       Inhibit other events until this one has been executed again
@EXECUTE        Executes a program or dos command               
@FILECLOSE      Closes nominated file                          
@FILEEND        Sets pointer to the end of the nominated file  
@FILELNSTART    Sets File pointer to start of the current line 
@FILEOPEN       Opens nominated file                           
@FILESCANCH     Scan for a character string in a file          
@FILESCANLN     Scan a line in a file for a string             
@FILESEEKCH     Seeks a file character pointer position        
@FILESEEKLN     Seeks a file line pointer position             
@FILESTART      Sets the file position to the start of a file  
@FILEWRITECH    Writes a string to a file                      
@FILEWRITELN    Writes a string with CR, LF to a file          
@FLUSHALL       Flushes all variables                          
@FLUSHVAR       Free memory used by a previously defined variable
@FOR            Used with @NEXT for repetitive counting Loop   
@FORM           Allows form mode input of string data          
@FUNBUSY        Set the number of attempts to be made to enter a command
@FUNKEY         Set up a function key                          
@GETDATE        Returns the PC date and time                   
@GETDIR         Store the current DOS directory                
@GOSUB          Call sub-routine 'label_name'                  
@GOTO           Jump to 'label_name'                           
@HIDE           Hides the Script file window                   
@IF-THEN        If condition                                   
@INC            Increments numeric variable 'var'              
@INCLUDE        Calls another transmit file and continues execution
@INKEY          Prompts for single character to assign to 'variable'
@INPUT          Prompts for the value to assign to 'variable'  
@KEYTIMEOUT     Sets the Keyboard Time-out in Setup Menu for Time Events
@LABEL          Used for @GOTO, @GOSUB and @INCLUDE jumps      
@LOG            Opens new disk log file to 'file_name'         
@LOGON          Logs onto host according to current emulation mode 
@MARK           Marks the screen buffer for @SCAN              
@MENU           Allows sliding bar menu selection              
@MKDIR          Make a new DOS directory                       
@MODE           Sets emulation mode                            
@NEXT           Used in @FOR Loops                             
@OPENREAD       Opens file 'file_name' for reading             
@ORDERED        Set action for handling ORDERED responses      
@PARAMISS       System 12, handles PARAMETER MISSING response  
@PAUSE          Halts the transmit file                        
@PORTNO         Switches to port number 'port_no'              
@PRINTER        Toggles the printer on/off                     
@PROMPT         Prompts to continue execution                  
@QUIT           Terminates OZTERM program                      
@READ           Reads one line of the read file into variable 'var'
@REPORT         System 12, inhibit 'REPORT FOLLOWS'            
@RESPONSETO     System 12, sets number of minutes to wait for LAST REPORT
@RESTART        Jump to start of transmit file                 
@RETURN         Return from sub-routine                        
@RMDIR          Delete a DOS directory                         
@SAVEDIR        Store the DOS OZTERM start directory           
@SCREENTIMEOUT  Sets the screen time out                       
@SELFILE        Allows point and shoot file selection          
@SELPRINT       Select the printer to use for printing operations
@SEND           Sends the variables to the current port        
@SET            Sets the value of variables                    
@SETDEST        Set the destination flag for the current port  
@SETREPLY       Sets 'slogan' to check command response        
@STOP           Close transmit file                            
@SYSPWORD       Sets the System 12 Password                    
@TITLE          Displays title in the transmit file select window
@TRACE          Starts/ends Script file program tracing        
@UNHIDE         re-opens the transmit script window (ie opposite to HIDE)
@VIEWFILE       Views a text file and allows string search     
@WAITFOR        Waits for string var to be received            
@WAITREPLY      Waits for an AXE print-out                     
@WINDEND        Closes the 7 line window at top of screen      
@WINDOW         Opens 7 line user window at top of screen      
@WRITE          Writes to file                                 




18.6 SCRIPT LANGUAGE FUNCTION INDEX.


ADVANCE         Allows Date/Time variable to be incremented    
CONCAT          Concatenates string variables/constants        
CHR             Setting character equivalents                  
COPY            Returns a substring                            
DECIMAL         Returns the decimal equivalent of the Hexadecimal parameter
DISKFREE        Returns the free disk space in kBytes          
EVLOADED        Checks Event Tables for usage of this transmit file
FILECHPOS       Returns the current character position in a file
FILELNPOS       Returns the current line position in a file    
FILEREADCH      Reads character/s from a file                  
FILEREADLN      Reads a line of data from a file               
FILETRANS       Send or Receive a file                         
GETDEST         Get the destination label displayed on the screen
GETHEADER       Get the whole of the last header line received 
GETLOG          Get the full name of the current log file      
GETMODE         Get the current port terminal emulation mode   
GETNAME         Get the name of the file currently running     
GETPORT         Get the port currently being used              
GETPRINT        Get the printer currently being used           
GETSCHED        Returns the Date/Time this transmit file was scheduled to run
HEX             Returns hexadecimal value of a number          
INHISTORY       Returns 1 or 0 if Date/Time is in the past or future
INSET           Checks for an expression in a set              
KEYPRESS        Detects whether a key has been pressed         
LENGTH          Returns the length of 'string'                 
LOWCASE         Changes string to lower case                   
MEMAVAIL        Returns the amount of conventional memory available
ORD             Returns a character ordinal value in decimal
POS             Returns the position of 'sub-string' in 'string'
REGRESS         Allows Date/Time variable to be decremented   
REPLY           Returns the Main screen reply line 'line_no'   
REPLYLEN        Returns the number of lines in the reply received
TEXTEVSET       Creates a Text Event in the SETUP menu         
TIMEEVSET       Creates a Time Event in the SETUP menu         
TRIM            Trims spaces from 'string'                     
UPCASE          Changes string to upper case                   
VAREXIST        Determines whether a variable has been defined 
VERSION         Determine the version of Ozterm which is running this script




                          TELSTRA PROPRIETY 
