Retro1.org codex

FSCTL                                            (MECAFF) CMS User Area command

The CMS command FSCTL allows to set the display attributes for the visuals
elements of the MECAFF console as well as the functionality bound to the PF
keys when the terminal is owned by the MECAFF console.
It also allows to control the flow mode of the MECAFF console, allowing to
continuously output data on the console without entering the "More..." state.

+----------+------------------------------------------------------------------+
| FSCTL    | ATTR elem color [ HIGHLight ] [ elem color [ HIGHLight ] ...]    |
| FS-CTL   | PF pfno [ cmd-text ]                                             |
|          | FLOWmode [ ON | OFf ]                                            |
+----------+------------------------------------------------------------------+

Setting display attributes
--------------------------

Using the subcommand ATTR sets the color and optionally the highlighting for
the elements of the MECAFF console, where elem can be:

  NORMal       : output lines from VM/370

  ECHOinput    : commands entered on  the MECAFF command prompt displayed in
                 the output area

  FSBG         : output lines from VM/370 received while the terminal is owned
                 by the CMS program in fullscreen mode (temporary attribute
                 used to highlight these lines while in More... state)

  CONSolestate : state indicator in front of the input prompt of the MECAFF
                 console.

  CMDInput     : the input prompt of the MECAFF console.

The color  can be one of:

   Default, Blue, Red, Pink, Green, Turquoise, Yellow, White.

Several visual elements can be set with one FS-CTL command, when specifying
the same elements more than once only the last setting will be use.

Example:

    FSCTL ATTR  NORMAL GREEN  ECHO WHITE HIGHLIGHT  FSBG RED


Setting PF key bindings
-----------------------

The subcommand PF sets the command issued by MECAFF when the corresponding key
is pressed while the screen is owned by the MECAFF console. The command bound
to a PF key can be either an internal MECAFF command or a command string that
will be sent to the VM as if it had been given on the command line.

The following internal commands can be bound to PF keys (with the PF key they
are assigned per default):

  !CMDCLR   : clear input area of the console (PF03)

  !TOP      : scroll the output area to the start of the buffered lines (PF06)

  !BOTTOM   : scroll the output area to the end of the buffered lines (PF09)

  !PAGEUP   : scroll the output area one page towards the start of the buffered
              lines (PF08)

  !PAGEDOWN : scroll the output area one page towards the end of the buffered
              lines (PF07)

  !CMDPREV  : step the input prompt back in input history (PF12)

  !CMDNEXT  : step the input prompt forward in input history (PF11)

A command text to be sent to VM can be up to 60 characters long, longer
command strings will be truncated.  If no command is given, the command
currently bound to the PF key will be removed.

Examples:

    FSCTL PF 2 FSLIST * C
    (set PF 02 to send the command "FSLIST * C" to CMS)

    FSCTL PF 1 !CMDPREV
    (set PF 01 to retrieve the previous entry of the command history into the
    prompt area)

    FSCTL PF 12
    (remove the command bound to PF 12)

Controlling the flow mode
-------------------------

The subcommand FLOWMODE activates (missing parameter or parameter ON) or
deactivates (parameter OFF) the flow mode. An activated flow mode will remain
active until it is explicitely deactivated or a MECAFF fullscreen program is
started.