High Voltage Shareware/high1.zip/high1/DIR9/SCRSUM.ZIP/CMDSUM.TXT

Text File | 1994-01-21 | 21KB | 233 lines

OzCIS Script Language Commands


By Name

command   category      syntax                                    summary                                                       log safe
--------  ------------  ----------------------------------------  ------------------------------------------------------------  ------------
ADD       Wait          add <num> <str>                           add a string to a multiple-wait command                       yes
BREAK     Online        break                                     send a Break signal to CIS                                    yes
CALL      Flow Control  call <str>                                call a sub-script                                             yes
CAPTURE   Capture       capture <on|off> [<str>]                  manage capture files                                          yes
CLS       Output        cls                                       clear the screen                                              yes
CONCAT    String        concat <strvar> <str>                     combine two or more strings                                   yes
CWRITE    Capture       cwrite <str>                              write directly to the capture file                            yes
DEBUG     Output        debug <on|off>                            echo currently executing command on the status line           yes
DEC       Numeric       dec <numvar> [<num>]                      decrease the value of a numeric variable                      yes
DEFINE    Variable      define <var> [<value>]                    create a user variable and optionally give it a value         yes
DELAY     Flow Control  delay <num>                               pause processing for a specified interval                     yes
DELSTR    String        delstr <strvar> <num> <num> [<strvar>]    delete a substring from within a larger string                yes
DL        Online        dl <libnum>;<cisname>;<localname>         download a file                                               No
DOS       Flow Control  dos [<str>]                               run an external program, or get the command processor prompt  with caution
DWAIT     Wait          dwait <numvar>                            activate a multiple-wait, and continue if nothing found       yes
END       Flow Control  end                                       signal the end of the script                                  yes
ENTER     Online        enter <servicepage>                       go to any CIS service page and wait for first prompt          No
ERASE     File IO       erase <filename>                          delete a file from the disk                                   yes
ERROR     Output        error <str>                               displays an error message in a dialog box                     yes
FAIL      Flow Control  fail                                      signal that the script ended abnormally                       yes
FAPPEND   File IO       fappend <filevar> <str>                   open a disk file ready to add to the end of it                yes
FCLOSE    File IO       fclose <filevar>                          close a disk file                                             yes
FCREATE   File IO       fcreate <filevar> <str>                   create and open a new disk file                               yes
FEOF      File IO       feof <filevar>                            returns TRUE when the end of the file has been reached        yes
FERROR    File IO       ferror                                    returns the DOS error value of the last file operation        yes
FEXISTS   File IO       fexists <str>                             returns TRUE when the specified file is found                 yes
FOPEN     File IO       fopen <filevar> <str>                     open an existing disk file (for reading and writing?)         yes
FREADLN   File IO       freadln <filevar> <strvar>                read the next line of text from a disk file                   yes
FWRITE    File IO       fwrite <filevar> <str>                    write a line of text to a disk file                           yes
GIF       Online        gif <str>                                 set a filename for the next GIF file to be downloaded/viewed  No
GO        Online        go <servicename>                          go to any CIS service page and wait for first prompt          No
GOSUB     Flow Control  gosub <label>                             call a script subroutine                                      yes
GOTO      Flow Control  goto <label>                              go to a label elsewhere in the script                         yes
IF        Flow Control  if <expression> <command>                 test an expression and branch based on the result             yes
INC       Numeric       inc <numvar> [<numlit>]                   increase the value of a numeric variable                      yes
INPUT     Input         input <var> <str>                         get input from the user in a pop up dialog box                yes
JUMP      Flow Control  jump <label>                              jump to a label elsewhere in the script                       yes
LENGTH    String        length <numvar> <str>                     set a numeric variable with the length of a string variable   yes
LSEND     Output        lsend <str>                               send a string followed by a CR to the modem                   yes
LWRITE    Output        lwrite <str>                              send a string followed by a CR to the screen                  yes
MIDSTR    String        midstr <strvar> <num> <num> [<strvar>]    return a substring from a larger string                       yes
MWAIT     Wait          mwait <numvar>                            activate a multiple-wait, exit with error if nothing found    yes
OFF       Online        off                                       log off of CIS                                                yes
ONERROR   Flow Control  onerror <label>                           set the label for an error handling routine                   yes
POS       String        pos <numvar> <str> <strvar>               return the position of a substring within a larger string     yes
POSNC     String        posnc <numvar> <str> <strvar>             same as POS but ignores differences in case                   yes
PROMPT    Input         prompt <var> <str>                        get input from the user in a pop up dialog box                yes
RETURN    Flow Control  return                                    return from a subroutine to the point where it was called     yes
RUN       Flow Control  run <scriptname>                          chain to a sub-script                                         yes
SEND      Output        send <str>                                send a string to the modem with NO <CR> afterwards            yes
SENDLN    Output        sendln <str>                              send a string followed by a CR to the modem                   yes
SET       Variable      set <var> <value>                         assign a value to a variable                                  yes
SL        Online        sl <liblist> [<modifiers>] [</u>]         perform a long library scan (full descriptions)               No!
STATLINE  Output        statline <str>                            display a string in the status line (bottom of the screen)    yes
STATUS    Output        status <str>                              display a string in the status line (bottom of the screen)    yes
STR       String        str <strvar> <num>                        convert a number to a string                                  yes
TERM      Online        term                                      put the user into manual terminal mode                        with caution
TIMEOUT   Wait          timeout <num>                             set the number of seconds to wait before generating an error  yes
TRIM      String        trim <strvar>                             removes leading and trailing whitespace from a string         yes
ULSEND    Output        ulsend <str>                              send an "invisible" string to the modem with a <CR>           yes
UPCASE    String        upcase <strvar>                           convert all letters in a string variable to upper case        yes
USEND     Output        usend <str>                               send an "invisible" string to the modem, without a <CR>       yes
VAL       Numeric       val <numvar> <str>                        convert a string to a numeric variable                        yes
WAIT      Wait          wait <str>                                wait until the specified string arrives, or until time is up  yes
WMH       Capture       wmh [<str>]                               write a dummy mail message header to the open capture file    yes
WRITE     Output        write <str>                               send a string without CR to the screen                        yes
WRITELN   Output        writeln <str>                             send a string with CR to the screen                           yes


By Category

category      command   syntax                                    summary                                                       log safe
------------  --------  ----------------------------------------  ------------------------------------------------------------  ------------
Capture       CAPTURE   capture <on|off> [<str>]                  manage capture files                                          yes
Capture       CWRITE    cwrite <str>                              write directly to the capture file                            yes
Capture       WMH       wmh [<str>]                               write a dummy mail message header to the open capture file    yes

File IO       ERASE     erase <filename>                          delete a file from the disk                                   yes
File IO       FAPPEND   fappend <filevar> <str>                   open a disk file ready to add to the end of it                yes
File IO       FCLOSE    fclose <filevar>                          close a disk file                                             yes
File IO       FCREATE   fcreate <filevar> <str>                   create and open a new disk file                               yes
File IO       FEOF      feof <filevar>                            returns TRUE when the end of the file has been reached        yes
File IO       FERROR    ferror                                    returns the DOS error value of the last file operation        yes
File IO       FEXISTS   fexists <str>                             returns TRUE when the specified file is found                 yes
File IO       FOPEN     fopen <filevar> <str>                     open an existing disk file (for reading and writing?)         yes
File IO       FREADLN   freadln <filevar> <strvar>                read the next line of text from a disk file                   yes
File IO       FWRITE    fwrite <filevar> <str>                    write a line of text to a disk file                           yes

Flow Control  CALL      call <str>                                call a sub-script                                             yes
Flow Control  DELAY     delay <num>                               pause processing for a specified interval                     yes
Flow Control  DOS       dos [<str>]                               run an external program, or get the command processor prompt  with caution
Flow Control  END       end                                       signal the end of the script                                  yes
Flow Control  FAIL      fail                                      signal that the script ended abnormally                       yes
Flow Control  GOSUB     gosub <label>                             call a script subroutine                                      yes
Flow Control  GOTO      goto <label>                              go to a label elsewhere in the script                         yes
Flow Control  IF        if <expression> <command>                 test an expression and branch based on the result             yes
Flow Control  JUMP      jump <label>                              jump to a label elsewhere in the script                       yes
Flow Control  ONERROR   onerror <label>                           set the label for an error handling routine                   yes
Flow Control  RETURN    return                                    return from a subroutine to the point where it was called     yes
Flow Control  RUN       run <scriptname>                          chain to a sub-script                                         yes

Input         INPUT     input <var> <str>                         get input from the user in a pop up dialog box                yes
Input         PROMPT    prompt <var> <str>                        get input from the user in a pop up dialog box                yes

Numeric       DEC       dec <numvar> [<num>]                      decrease the value of a numeric variable                      yes
Numeric       INC       inc <numvar> [<numlit>]                   increase the value of a numeric variable                      yes
Numeric       VAL       val <numvar> <str>                        convert a string to a numeric variable                        yes

Online        BREAK     break                                     send a Break signal to CIS                                    yes
Online        DL        dl <libnum>;<cisname>;<localname>         download a file                                               No
Online        ENTER     enter <servicepage>                       go to any CIS service page and wait for first prompt          No
Online        GIF       gif <str>                                 set a filename for the next GIF file to be downloaded/viewed  No
Online        GO        go <servicename>                          go to any CIS service page and wait for first prompt          No
Online        OFF       off                                       log off of CIS                                                yes
Online        SL        sl <liblist> [<modifiers>] [</u>]         perform a long library scan (full descriptions)               No!
Online        TERM      term                                      put the user into manual terminal mode                        with caution

Output        CLS       cls                                       clear the screen                                              yes
Output        DEBUG     debug <on|off>                            echo currently executing command on the status line           yes
Output        ERROR     error <str>                               displays an error message in a dialog box                     yes
Output        LSEND     lsend <str>                               send a string followed by a CR to the modem                   yes
Output        LWRITE    lwrite <str>                              send a string followed by a CR to the screen                  yes
Output        SEND      send <str>                                send a string to the modem with NO <CR> afterwards            yes
Output        SENDLN    sendln <str>                              send a string followed by a CR to the modem                   yes
Output        STATLINE  statline <str>                            display a string in the status line (bottom of the screen)    yes
Output        STATUS    status <str>                              display a string in the status line (bottom of the screen)    yes
Output        ULSEND    ulsend <str>                              send an "invisible" string to the modem with a <CR>           yes
Output        USEND     usend <str>                               send an "invisible" string to the modem, without a <CR>       yes
Output        WRITE     write <str>                               send a string without CR to the screen                        yes
Output        WRITELN   writeln <str>                             send a string with CR to the screen                           yes

String        CONCAT    concat <strvar> <str>                     combine two or more strings                                   yes
String        DELSTR    delstr <strvar> <num> <num> [<strvar>]    delete a substring from within a larger string                yes
String        LENGTH    length <numvar> <str>                     set a numeric variable with the length of a string variable   yes
String        MIDSTR    midstr <strvar> <num> <num> [<strvar>]    return a substring from a larger string                       yes
String        POS       pos <numvar> <str> <strvar>               return the position of a substring within a larger string     yes
String        POSNC     posnc <numvar> <str> <strvar>             same as POS but ignores differences in case                   yes
String        STR       str <strvar> <num>                        convert a number to a string                                  yes
String        TRIM      trim <strvar>                             removes leading and trailing whitespace from a string         yes
String        UPCASE    upcase <strvar>                           convert all letters in a string variable to upper case        yes

Variable      DEFINE    define <var> [<value>]                    create a user variable and optionally give it a value         yes
Variable      SET       set <var> <value>                         assign a value to a variable                                  yes

Wait          ADD       add <num> <str>                           add a string to a multiple-wait command                       yes
Wait          DWAIT     dwait <numvar>                            activate a multiple-wait, and continue if nothing found       yes
Wait          MWAIT     mwait <numvar>                            activate a multiple-wait, exit with error if nothing found    yes
Wait          TIMEOUT   timeout <num>                             set the number of seconds to wait before generating an error  yes
Wait          WAIT      wait <str>                                wait until the specified string arrives, or until time is up  yes


Synonyms

command   category      synonym
--------  ------------  ----------
CALL      Flow Control  RUN
ENTER     Online        GO
GO        Online        ENTER
GOTO      Flow Control  JUMP
INPUT     Input         PROMPT
JUMP      Flow Control  GOTO
LSEND     Output        SENDLN
LWRITE    Output        WRITELN
PROMPT    Input         INPUT
RUN       Flow Control  CALL
SENDLN    Output        LSEND
STATLINE  Output        STATUS
STATUS    Output        STATLINE
WRITELN   Output        LWRITE

ADD       Wait          none
BREAK     Online        none
CAPTURE   Capture       none
CLS       Output        none
CONCAT    String        none
CWRITE    Capture       none
DEBUG     Output        none
DEC       Numeric       none
DEFINE    Variable      none
DELAY     Flow Control  none
DELSTR    String        none
DL        Online        none
DOS       Flow Control  none
DWAIT     Wait          none
END       Flow Control  none
ERASE     File IO       none
ERROR     Output        none
FAIL      Flow Control  none
FAPPEND   File IO       none
FCLOSE    File IO       none
FCREATE   File IO       none
FEOF      File IO       none
FERROR    File IO       none
FEXISTS   File IO       none
FOPEN     File IO       none
FREADLN   File IO       none
FWRITE    File IO       none
GIF       Online        none
GOSUB     Flow Control  none
IF        Flow Control  none
INC       Numeric       none
LENGTH    String        none
MIDSTR    String        none
MWAIT     Wait          none
OFF       Online        none
ONERROR   Flow Control  none
POS       String        none
POSNC     String        none
RETURN    Flow Control  none
SEND      Output        none
SET       Variable      none
SL        Online        none
STR       String        none
TERM      Online        none
TIMEOUT   Wait          none
TRIM      String        none
ULSEND    Output        none
UPCASE    String        none
USEND     Output        none
VAL       Numeric       none
WAIT      Wait          none
WMH       Capture       none
WRITE     Output        none