SAY

From ICE Enterprises
Jump to navigation Jump to search

echoes a text line to the terminal

<TEXT> - A formatable string with optional results substitution

This is used to print an informative string to the terminal - normally for
use in macros.  <TEXT> will normally be surrounded with doubles quotes ("")
to preserve case and allow spaces.  A typical string would have the form:

  SAY  "The bin ^NBIN frequency shift is ^FREQ Hz"

The trailing quote may be omitted. When executed, the strings preceded by
the caret (^) will be interpreted as results parameters, and assuming the
parameters NBIN and FREQ are defined as 5 and 5.6420 respectively, the user
will see:

  The bin 5 frequency shift is 5.6420 Hz

Examples:
  * nM> SAY "Hello"
    Hello

  * nM> SAY "The bin ^NBIN frequency shift is ^FREQ Hz"
    The bin 5 frequency shift is 5.6420 Hz

  * The /L=F switch can be used to repress the new line in a macro
    startmacro
      SAY/L=F "Running"
      SAY/L=F "."
      SAY/L=F "."
      SAY/L=F "."
      SAY "Done"
    endmacro

    Outputs the text:
      Running...Done


Switches:
  /L - Write a new line if true [DEF=TRUE]

See Also: INFO, WARN