 {COMMO} (tm) Help  (C)Copyright 1989-1997 Fred P. Brucker  All Rights Reserved

[00.10] *****  {COMMO} Macro Key-labels

 Key-labels are special macro labels that let you start a macro by pressing the
 associated key (they can also be the targets of GOTO, CALL, etc.).  They fall
 into two general categories: predefined and user-defined.


[00.20] ****  Table of PREDEFINED Key-labels

      Key Name     Key-label     Key Name     Key-label
      ________     _________     ________     _________

      F1            nf1   ...    F10           nf0
      F11           nfa          F12           nfb

      Ctrl+F1       cf1   ...    Ctrl+F10      cf0
      Ctrl+F11      cfa          Ctrl+F12      cfb

      Shift+F1      sf1   ...    Shift+F10     sf0
      Shift+F11     sfa          Shift+F12     sfb

      Alt+F1        af1   ...    Alt+F10       af0
      Alt+F11       afa          Alt+F12       afb

      Alt+A         ala   ...    Alt+Z         alz
      Alt+1         al1   ...    Alt+0         al0
      Alt =         al=          Alt -         al-

      Escape        esc          Grey *        gr*
      Grey -        gr-          Grey +        gr+

      Backspace     bsp          Ctrl+Bckspc   cbs
      Tab           tab          Shift+tab     stb
      Enter         ent          Ctrl+Enter    cen

      Home          hom          End           end
      PgUp          pgu          PgDn          pgd
      Up            upa          Down          dna
      Left          lfa          Right         rta
      Insert        ins          Delete        del

      Ctrl+Home     chm          Ctrl+End      cnd
      Ctrl+PgUp     cpu          Ctrl+PgDn     cpd
      Ctrl+Right    cra          Ctrl+Left     cla

      Keypad 0      kp0   ...    Keypad 9      kp9
      Keypad .      kp.          Ctrl+PrtSc    cpr

      Alt+[         al[          Alt+]         al]
      Alt+;         al;          Alt+'         al'
      Alt+,         al<          Alt+.         al.
      Alt+/         al/          Alt+\         al\
      Alt+*         al*          Alt+`         al`
      Alt+Kp -      ak-          Alt+Kp +      ak+
      Alt+Enter     aen          Center Key    cky

 TIPS on using key-labels:

  >   Key-labels are always three characters in length.

  >   Some key-labels are not available on systems with an older BIOS.  And
      some keys do not exist on the 83-key keyboard.

  >   If the same key-label appears more than once, the first occurrence will
      be used (as with any macro label).

  >   Key-labels are not case sensitive.

  >   The Center Key is the Keypad 5 with Numlock off.


[00.30] ****  USER-DEFINED Key-labels

 Almost any key combination on the keyboard may be defined with the "mky" item
 in the Setup File.

 TIPS on using user-defined key-labels:

  >   You may have up to 32 user-defined key-labels.

  >   User-defined key-labels may be used to "override" predefined key-labels.

  >   Use Alt+K in the Internal Editor to obtain the scan code for any key.

  >   Beware that some keys give the same scan code when used with various
      shift keys (Ctrl, Alt or Shift) as when unshifted.  Some examples are:
      Space, Esc, Return and Backspace.

  >   You cannot define keys formed with multiple shift keys.  For example, you
      cannot use Ctrl+Alt+F1 or Ctrl+Shift+Home.


[00.40] *****  List of Reserved Variables


[00.50] ****  USER-DEFINED Reserved Variables

   _modini     Modem Initialization String
   _dialpf     Default dialing prefix
   _dialsf     Default dialing suffix
   _dialsr     Dialing success response(s)
   _dialfr     Dialing failure response(s)
   _dialir     Inter-dial Delay response(s)
   _dialrt     Dialing response text, available:
                 (1) after a dialing attempt if _dtc=1 or 2
                 (2) in the Inter-dial Delay macro.
   _uselog     Path\filename of Usage Log
   _menux      Menu display string, x=1, 2, 3, etc.
   _mlabel     List of macro labels for pop-up menu
   _menter     Macro label for Enter key in menu
   _mcolor     Colors used with pop-up menu: text,border
   _exted      External editor command line


[00.60] ****  BUILT-IN Variables

   _hom        {COMMO} home directory (e.g., c:\commo\, a:\)
   _dsk        Current disk (e.g., C:)
   _dir        Current directory (e.g., \upload, \)
   _set        Filename of Setup File (e.g., COMMO.SET)
   _fon        Filename of current Dialing Directory (e.g., COMMO.FON)
   _mac        Filename of resident Macro File (e.g., COMMO.MAC)
   _aux        Filename of auxiliary Macro File
   _edf        Filename for external editor
   _edl        Line number for external editor
   _cap        Current Capture File path\filename
   _scr        Current Screen Image File path\filename

   _ffn        Find file name (use with FILE function)
   _ffs        Find file size
   _ffd        Find file date
   _fft        Find file time

   _err        Exit code set by certain functions
   _met        Error message after Macro Error occurs
   _dfc        Disk full on capture: 1=YES, 0=NO; reset when
               Capture File is opened, set when disk is full
   _cfs        Capture File status: 0=CLOSED, 1=OPEN
   _pos        Position in string
   _len        Length of string

   _por        Current serial port number: 1, 2, etc.
   _spe        Current serial port speed: 2400, 38400, etc.
   _fmt        Current serial port data format: 8n1, 7e1, etc.
   _mod        Last speed reported by modem
   _pad        Current serial port address: 03F8, 02E8, etc.
   _irq        Current IRQ number: 4, 3, etc.

   _ent        Character(s) sent when Enter is pressed.  Values are:
                 ^m    (cr)      New Line Mode reset
                 ^m^j  (cr/lf)   New Line Mode set

   _nci        Number of characters in input buffer (received and not yet
               displayed)
   _sfi        Speech Friendly Interface: 1=ON, 0=OFF

   _dtc        Dialing termination code (available after each dialing
               attempt).  Values are:
                 0 = no systems were marked
                 1 = successful connection
                 2 = failure response received
                 3 = timed out
                 4 = operator intervention

   _msn        Menu label selection number, from last MENU function
               (0 for Enter, 1 to 26 for A to Z, etc.)
   _rem        Remainder from last DIVIde
   _nam        Current System Name (up to 40 chars)
   _num        Current Phone Number (up to 40 chars)
   _pas        Current Password String
   _ela        Elapsed time in minutes:seconds
   _elt        Elapsed timer in clock ticks (55 ms)
   _ver        Version number text
   _vsp        Bytes available in Variable Space
   _pfw        Key pressed from window: 1=YES, 0=NO ("no" means it was pressed
               from the Terminal Screen).  Defined after pressing a key that
               starts a macro.

   _dat        Full date (format defined in Setup File)
   _mon        Month, mm
   _day        Day of the month, dd
   _yea        Year, yy
   _dwn        Numeric day of the week: 1=Mon, ... , 7=Sun
   _dwt        Text day of the week: Mon, Tue, ...

   _tim        Full time (format defined in Setup File)
   _24h        24 hour, hh
   _12h        12 hour, hh
   _amp        Am/pm indicator, xm
   _min        Minute, mm
   _sec        Second, ss

   _row        Current cursor row
   _col        Current cursor column
   _slr        Status Line row on screen, 0=OFF


[00.70] *****  Summary of Macro Functions (alphabetical)

 Four-letter function name abbreviations are shown in uppercase (case is
 ignored during macro execution).  Many arguments are optional.  Function
 switches are all shown for reference.

 In some cases omitting arguments will bring up the associated window or toggle
 a toggle (e.g. DIAL or SOUNd).  See function descriptions for details.

 Key    Function, Arguments               Description
 _____  _____________________________     ____________________________________

        {ALARm-F ring-count}              Ring the alarm
 Alt+A  {ASCIiup-ES path\filename[\],     ASCII Upload
         pacing}
        {AUTO label,string}               Auto Receive
        {BEEP ddd,fff,...}                Play a sequence of sounds
 Alt+B  {BREAk-Tn}                        Send Break
        {CALL-F label,filename}           Execute a macro
        {CALOok label1,label2,string}     Additional string, call submacro
        {CAPMode s/f/r}                   Set Capture Mode
 Alt+1  {CAPTure-N y/n,path\filename}     Capture File Options
 Alt+-  {CHATmode y/n}                    Chat Mode toggle
 Alt+C  {CLEAr}                           Clear Screen
        {COMPare name,string}             Compare a variable to a string
        {CURSor y/n}                      Terminal Screen cursor toggle
        {DECRement name,number}           Subtract from a numeric variable
 Alt+D  {DIAL-C tries,label1,label2}      Dialing Directory
        {DISPlay-R row,col,attr,string}   Display a string to the screen
        {DIVIde name,number}              Divide a numeric variable
 Alt+=  {DOORway-MS}                      Doorway Mode toggle
 Alt+P  {DPARms speed,format,port,        Set default Terminal Parameters
         terminal-type,delay}
        {ELAPse}                          Reset the elapsed timer
        {EDIT path\filename}              Edit a file
        {EXECute-ADMNSWn command}         Execute a DOS command
 Alt+X  {EXIT-D return-code}              Exit {COMMO}
        {FILE-SX filespec}                Find directory entry information
        {FONFile filename}                Load a new Dialing Directory file
        {GETString-AHIPR name,            Get a string from the modem
         count,label}
        {GOLOok label,string}             Additional string, go to macro
        {GOTO-F label,filename}           Transfer macro control
 Alt+H  {HANGup y/n}                      Drop DTR to hangup
 F1     {HELP-C xx.xx.xx}                 Online Help file/topic
        {HOLD hh:mm}                      Hold until specified 24 hr time
        {IFCArrier-C true,false}          Test for presence of carrier detect
        {IFCOndition-CEGL true,false}     Test conditions set by COMPare
        {IFERrorlevel-C number,           Test if exit code ò number
         true,false}
        {IFEXist-C path\filename,         Test for existence of file(s)
         true,false}
        {INCRement name,number}           Add to a numeric variable
        {INFOrm-DnQS string}              Display an advisory message
 Alt+O  {INITmodem}                       Send modem init string
        {INPUt-EL name,prompt}            Input from the keyboard
        {INSTring name,string}            Find a string within a string
        {KEYStuff hhhh,...}               Put key codes into keyboard buffer
        {LENGth string}                   Determine the length of a string
        {LIGHts y/n}                      Signal Lights toggle
        {LOCAlecho y/n}                   Local Echo toggle
        {LOOKfor string}                  Look for string from port
 Alt+M  {MACRo string}                    Macro Processor window
        {MARK strings}                    Mark numbers for dialing
        {MENU rows,cols,string}           Create a pop-up menu
        {MULTiply name,number}            Multiply a numeric variable
        {NOCArrier-E label}               Macro to execute when carrier drops
        {NOOP}                            No-op function, does nothing
        {OFFLog}                          Make an {Off} Usage Log entry
 Alt+P  {PARMs speed,format,port,         Set current Terminal Parameters
         terminal-type,delay}
        {PARMs-C port,address,irq,freq}   Change hardware port parameters
 Alt+W  {PASSword}                        Send current password
        {PAUSe-T nnn}                     Pause for time interval
        {POPStack-C}                      Pop from the macro stack
 Alt+2  {PRINtlog y/n}                    Print Log toggle
        {PUSHstack label,filename}        Push a location to the macro stack
        {RCLOse}                          Close the read file
        {READ name}                       Read from a file to a variable
        {RETUrn}                          Return from a CALL
        {ROPEn path\filename,label}       Open a file for reading
        {RTRAn-I item,item,...}           Maintain receive Translate Table
        {RXMOdem-ACDGNWnY path\filename}  Receive a file using Xmodem
        {RYMOdem-ACDGNWnY path}           Receive files using Ymodem Batch
        {RZMOdem-ADNRWnY path}            Receive files using Zmodem Batch
 Alt+I  {SCREen y/n,path\filename}        Screen Image Save
 Alt+K  {SCROllback}                      Display Scrollback Buffer
        {SEND-BNW string}                 Send a text string
        {SETDial timer1,timer2}           Set DIAL parameters
        {SETEsc-KP label}                 Set a label to GOTO on Esc
        {SETGet get-timer,label,          Set GETString parameters
         y/n/l,string}
        {SETLook-N look-timer,label,      Set LOOKfor parameters
         nochar-timer,string/label}
        {SETR label}                      Macro to GOTO on a Macro Error
        {SETUp}                           Edit Setup File
        {SETVariable-ES name,string}      Assign a string to a variable name
        {SFICtrl-E y/n}                   Speech Friendly Interface control
 Alt+S  {SHELl-MS}                        Shell to DOS
        {SOUNd y/n}                       Master Sound toggle
        {SIGNal-DR}                       Set state of hardware signals
        {SPDCtrl y/n}                     Serial port display control
        {SPOCtrl y/n}                     Serial port output control
        {SSLOok-R name,string}            Additional string, send variable
        {STATusline y/n}                  Status Line on/off toggle
        {STOP} or {}                      Stop macro processing
        {STRAn-I item,item,...}           Maintain send Translate Table
        {SUBString name,[-]start,         Move a substring to a variable
         count,string}
        {SXMOdem-ADKUWn filespec}         Send a file using Xmodem
        {SYMOdem-ADKUWn filespec,...}     Send files using Ymodem Batch
        {SZMOdem-ADRUWn filespec,...}     Send files using Zmodem Batch
 Alt+T  {TOGGles}                         Set Toggles
        {UNLOad}                          Release auxiliary Macro File
        {UNMArk-L strings}                Unmark Dialing Directory entries
        {VIDEo-M}                         Set alternate video mode
        {VTCUr string1|string2}           VT102 cursor key strings
        {VTPAd string1|string2}           VT102 keypad key strings
        {WCLOse}                          Close the write file
        {WINDow-K}                        Preserve window displays
        {WOPEn-A path\filename}           Open a file for writing
        {WRITe string}                    Write a string to a file


[00.80] *****  Macro Functions Listed by Class


[00.90] ****  Variable manipulation

   SETVariable    Assign a string to a variable name
   INCRement      Increase a numeric variable
   DECRement      Decrease a numeric variable
   MULTiply       Multiply a numeric variable
   DIVIde         Divide a numeric variable
   INSTring       Find a string within a string
   SUBString      Move a substring to a variable
   LENGth         Determine the length of a string


[01.00] ****  Looking for text

   AUTO           Auto Receive
   SETLook        Set LOOKfor parameters
   LOOKfor        Look for string from port
   SSLOok         Additional string, send variable
   CALOok         Additional string, call submacro
   GOLOok         Additional string, go to macro


[01.10] ****  File Input/Output

   ROPEn          Open a file for reading
   READ           Read from a file to a variable
   RCLOse         Close the read file
   WOPEn          Open a file for writing
   WRITe          Write to a file from a variable
   WCLOse         Close the write file


[01.20] ****  Dialing/connect/disconnect

   SETDial        Set dialing timers
   DIAL           Dialing Directory
   FONFile        Load a new Dialing Directory file
   DPARms         Set default Terminal Parameters
   HANGup         Drop DTR to hangup
   MARK           Mark numbers for dialing
   UNMArk         Unmark Dialing Directory entries


[01.30] ****  Modem control

   PARMs          Set current Terminal Parameters
   LOCAlecho      Local Echo toggle
   INITmodem      Send modem init string
   BREAk          Send a Break signal
   LIGHts         Signal Lights toggle
   SIGNal         Set state of hardware signals
   SPOCtrl        Serial port output control


[01.40] ****  Send/receive data

   ASCIiup        ASCII Upload
   SEND           Send a text string
   CAPMode        Set Capture Mode
   CAPTure        Capture File Options
   SETGet         Set GETString parameters
   GETString      Get a string from the modem
   RXMOdem        Receive a file using Xmodem
   RYMOdem        Receive a file using Ymodem
   RZMOdem        Receive a file using Zmodem
   SXMOdem        Send a file using Xmodem
   SYMOdem        Send a file using Ymodem
   SZMOdem        Send a file using Zmodem
   PASSword       Send current password
   RTRAn          Maintain Receive Translate Table
   STRAn          Maintain Send Translate Table
   VTCUr          VT102 cursor key strings
   VTPAd          VT102 keypad key strings


[01.50] ****  Testing

   COMPare        Compare a variable to a string
   IFCOndition    Test Condition Flag
   IFERrorlevel   Test Exit Codes
   IFEXist        Test for existence of file(s)
   IFCArrier      Test for presence of Carrier Detect


[01.60] ****  Macro control

   CALL           Execute a macro
   RETUrn         Return from a CALL
   PUSHstack      Push a location to the macro stack
   POPStack       Pop from the macro stack
   GOTO           Transfer control to a label
   UNLOad         Release the auxiliary Macro File from memory
   STOP           Stop macro execution
   PAUSe          Pause for interval 1-999 seconds
   HOLD           Hold until specified 24 hr time
   NOCArrier      Set a label to GOTO when carrier is lost
   SETEsc         Set a label to GOTO on Esc
   SETR           Set a label to GOTO when a Macro Error occurs


[01.70] ****  Video/sound related

   CLEAr          Clear Screen
   CURSor         Terminal Screen cursor toggle
   DISPlay        Display a string to the screen
   SCREen         Screen Image Save
   SFICtrl        Speech Friendly Interface control
   SPDCtrl        Serial port display control
   STATusline     Status Line on/off toggle
   VIDEo          Change to an alternate video mode
   WINDow         Preserve window display

   SOUNd          Master Sound toggle
   ALARm          Ring the alarm
   BEEP           Play a sequence of sounds


[01.80] ****  Miscellaneous

   CHATmode       Chat Mode toggle
   DOORway        Doorway Mode toggle
   ELAPse         Reset the elapsed timer
   EDIT           Edit a file
   EXECute        Execute a DOS command
   EXIT           Exit {COMMO}
   FILE           Find directory entry information
   HELP           Online Help topic
   INFOrm         Display an advisory message
   INPUt          Input from the keyboard
   KEYStuff       Put key codes into the keyboard buffer
   MACRo          Macro File window
   MENU           Create a pop-up macro menu
   NOOP           No-op function, does nothing
   OFFLog         Make an {Off} entry in the Usage Log
   PRINtlog       Print Log toggle
   SCROllback     Display Scrollback Buffer
   SETUp          Edit Setup File
   SHELl          Shell to DOS
   TOGGles        Set Toggles

