* SCRIPT COMMANDS

These commands are used (in conjunction with other Kermit commands) for
carrying out an automated dialog with a remote computer.

 ASK <variable> <prompt>
  Print the <prompt> on the screen, assign what user types to the <variable>.

 ASKQ <variable> <prompt>
  Like ASK, but do not echo what user types.

 GETOK <prompt>
  Like ASK, but asks a Yes or No question.  Succeeds if answer is Yes,
  fails if answer is No, otherwise reprompts.

 OUTPUT <string>
  Send the <string> out the communications port.  May include backslash
  codes, variables, etc, plus the special items \B to send a BREAK and
  \L to send a Long BREAK.

 SET OUTPUT PACING <msec>
  How many milliseconds (thousands of a second) to pause between each
  character in the OUTPUT string.

 INPUT [<timeout>] <string>
  Wait up to <timeout> secs for <string> to arrive at communications port.
  If it arrives, set SUCCESS.  If not, time out and set FAILURE.
  String may contain backslash codes.

 SET INPUT CASE { IGNORE, OBSERVE } = IGNORE
  Say whether alphabet case should matter in searching for INPUT string.

 SET INPUT DEFAULT-TIMEOUT <secs> = 1
  Timeout interval to use if none given in INPUT command.

 SET INPUT ECHO { ON, OFF } = ON
  Whether to display characters read by INPUT command on the screen.

 SET INPUT TIMEOUT-ACTION { PROCEED, QUIT } = PROCEED
  PROCEED means set SUCCESS or FAILURE and go on to next statement in macro
  definition or TAKE file.  QUIT means to quit from current macro or TAKE
  file immediately upon timeout (i.e. upon failure).

 IF SUCCESS <command>
  Execute the <command> if the preceding INPUT command succeeded.  Also works
  with file transfer commands like SEND, RECEIVE, GET, BYE, etc.

 IF FAILURE <command>
  Execute the <command> if the preceding INPUT or file transfer command failed.

 PAUSE <secs>
  Do nothing for specified number of seconds, or until any character is typed
  at the keyboard.

 MPAUSE <msecs>
  Like PAUSE, but number is milliseconds rather than seconds.

 WAIT [<timeout>] [CD] [CTS] [DSR] [RI]
  Wait <timeout> (seconds or until time hh:mm:ss) for specified modem signals.

 CLEAR [ { INPUT-BUFFER, DEVICE-BUFFER, BOTH } ]
  CLEAR INPUT clears the INPUT/REINPUT command buffer (characters that have
  already been read by Kermit's INPUT command).	 CLEAR DEVICE clears the
  communication device buffer (characters that have not yet been read by
  by Kermit), CLEAR BOTH (the default) clears both of these buffers.

 STOP
  Return immediately from the current macro or TAKE file to the MS-Kermit>
  prompt.

 STOP [ <number> ] [ <text> ]
  Return immdediately from the current macro or TAKE file to the MS-Kermit>
  prompt, using the <number>, if specified, as the SUCCESS / FAILURE code, and
  setting the value of \v(status) to that number.  If the <number> is omitted,
  the SUCCESS / FAILURE status of the previous command is retained and
  \v(status) is not changed.  If the optional <text> is given, it is printed
  on the screen.  Leading and trailing spaces are removed unless the text is
  enclosed in curly braces, in which case only the curly braces are removed.
  Examples:

    STOP			; No message, status is not changed
    STOP 0			; No message, status is 0 (SUCCESS)
    STOP 1			; No message, status is 1 (FAILURE)
    STOP This is a message	; Status not changed, message is printed
    STOP {  Indented text}	; Ditto, leading spaces are preserved
    STOP 0 This is a message	; Status set to 0, message is printed
    STOP 1 { This is a message} ; Status set to 1, message is printed

 END
  Return from current macro or TAKE file to the macro or TAKE file which
  invoked it, or if none, to the MS-Kermit> prompt.  Synonym: POP.

 END [ number ] [ text ]
  Return from current macro or TAKE file to the macro or TAKE file which
  invoked it, or if none, to the MS-Kermit> prompt.  Otherwise, identical to
  STOP.	 Synonym: POP.

 GOTO <label>
  Instead of executing the next statement in the current macro definition or
  TAKE-file, go to the specified label and begin executing there.  The label
  must be a word that begins with a colon (:) in the left margin in a macro
  definition or TAKE file.  If it is not found, Kermit "POPs" one level and
  looks there, and so on through all active macros and command files.

 :LOOP
  The previous line shows a label called "loop".  GOTO LOOP would find it.

 REINPUT <timeout> <string>
  Like INPUT, but instead of waiting for <string> to arrive at communications
  port, REINPUT rescans the text that has already arrived.

 SET COUNT <number>
  Sets the loop counter to <number>.

 IF COUNT <command>
  Subtract one from count.  If result is greater than 0, execute <command>.
  Use with GOTO to construct counted loops.

 SET ALARM <time>
  Set an alarm <time> seconds from now, or at time hh:mm:ss.

 IF ALARM <command>
  If the alarm time has passed, execute the <command>.

 SET ERRORLEVEL <number>
  Set errorlevel to be returned to DOS by Kermit upon exit.

 IF ERRORLEVEL <number> <command>
  If the ERRORLEVEL value is greater than or equal to the <number>,
  execute the <command>.  Equivalent to:
  IF NOT < \v(errorlevel) <number> <command>

 IF EXIST <filename> <command>
  If the named file exists, execute the <command>.

 IF INPATH <filename> <command>
  If the named file can be found in your DOS PATH, or in the current
  directory, execute the <commmand>.

 IF EQUAL <word1> <word2> <command>
  Execute the command if the two words are the same.  The words may be text or
  variables.

 IF LGT <word1> <word2> <command>
 IF LLT <word1> <word2> <command>
  Execute the command if <word1> is lexically greater than (LGT) or lexically
  less than (LLT) <word2>.  EQUAL, LGT, and LLT are alphabetical comparisons.
  Case is treated according to SET INPUT CASE.	To compare text items that
  contain spaces, use { brackets } for grouping:
    IF LLT {\%a} {more than one word} <command>

 OPEN {READ, WRITE, APPEND} <filename>
  Open a DOS file in the given mode.

 READ <variable-name>
  Read a line from the current OPEN READ file into the given variable,
  discarding line terminators.	Sets FAILURE flag at end of file.

 WRITE FILE <text>
  Write the text into the current OPEN WRITE or OPEN APPEND file; <text> can
  contain any mixture of ordinary characters, backslash codes, variable names.

 CLOSE {READ, WRITE}
  Close the current READ or WRITE (including APPEND) file.


.