FSHELP

CMS Commands

fshelp.helpcmd.txt
FSHELP                                           (MECAFF) CMS User Area command

FSVIEW is a MECAFF-based for standard CMS HELP topics.

+----------+------------------------------------------------------------------+
| FSHELP   | [ topic ]                                                        |
|          | ( REBUILD                                                        |
+----------+------------------------------------------------------------------+

The fullscreen display of a standard HELP topic is invoked from CMS with

    FSHELP topic

This looks for a file topic HELPxxx on all accessed disks (with xxx one of
CMD, DBG, EE, EDT, EXC or REX) and displays it.
If the additional help file exists (topic HELPxxx2 on the same disk), it is
appended to the displayed content.

FSHELP allows to navigate to other help topics either with the subcommand

   Help topic

or by placing the cursor in a word of the displayed help text and pressing the
PF01 key.

The topics opened are stacked in a last-in-first-out manner: closing the
current topic with PF03 displays the previous one and so on until closing the
first (initial) topic terminates FSHELP, returning to the CMS prompt.

When invoked without a topic, FSHELP looks for a file MENU FSHELP on all
accessed disks and displays this file as top level menu. If this file is not
found, the help menu is build based on the help files on all accessed disks
(with filetype HELPxxx, see above), grouping the topics by the command types
CMS, CP, EE, EDIT, DEBUG, EXEC. This help file is automatically saved in the
file MENU FSHELP A2. If necessary (for example to include new help topics),
this menu help file can be regenerated on disk A by invoking FSHELP with only
the option REBUILD:

    FSHELP ( REBUILD


PF-Keys
-------

Browsing through the help information, navigating to other topics and leaving
FSHELP is typically controlled with the PF-keys. The commands assigned to PF
keys can be customized in the EE profiles, FSHELP has the following default
assignments  (summarized the screen bottom line):

  PF01  : GOTO
  PF02  : GOTO
  PF03  : BACK
  PF04  : /
  PF05  : TOP
  PF06  : PGUP
  PF07  : PGUP SHORT
  PF08  : PGDOWN SHORT
  PF09  : PGDOWN
  PF10  : BOTTOM
  PF12  : GOTO
  PF15  : QUIT
  PF16  : -/

Commands
--------

The following commands are supported on the subcommand program prompt of
FSHELP:

+----------+------------------------------------------------------------------+
| Help     | topic                                                            |
+----------+------------------------------------------------------------------+

Navigate to the specified help topic, pushing the current topic onto the stack.


+----------+------------------------------------------------------------------+
| GOto     |                                                                  |
+----------+------------------------------------------------------------------+

Navigate to the topic identified by the word where the cursor is in the help
text (the cursor must be in the help text area).
If no such topic exists, an error message is displayed and the cursor stays at
the current place in the help text.


+----------+------------------------------------------------------------------+
| Back     |                                                                  |
+----------+------------------------------------------------------------------+

Close the current topic and display its predecessor in the help topic stack.
If the initial topic is currently displayed, FSHELP is terminated.


+----------+------------------------------------------------------------------+
| TOp      |                                                                  |
+----------+------------------------------------------------------------------+

Scroll to the top of the help topic.


+----------+------------------------------------------------------------------+
| PGUP     | [ SHORT ]                                                        |
+----------+------------------------------------------------------------------+

Scroll up the topic by one page height. If the option SHORT is given,
scrolling is done only by 2/3 page height.

+----------+------------------------------------------------------------------+
| PGDOwn   | [ SHORT ]                                                        |
+----------+------------------------------------------------------------------+

Scroll down the topic by one page height. If the option SHORT is given,
scrolling is done only by 2/3 page height.


+----------+------------------------------------------------------------------+
| BOTtom   |                                                                  |
+----------+------------------------------------------------------------------+

Scroll to the bottom of the help topic.


+----------+------------------------------------------------------------------+
| Quit     |                                                                  |
+----------+------------------------------------------------------------------+

Terminate FSHELP.


+----------+------------------------------------------------------------------+
|          | /text/                                                           |
+----------+------------------------------------------------------------------+

Search forward for text in the current help page.


+----------+------------------------------------------------------------------+
|          | -/text/                                                          |
+----------+------------------------------------------------------------------+

Search backward for text in the current help page.


+----------+------------------------------------------------------------------+
|          | /                                                                |
+----------+------------------------------------------------------------------+

Repeat the last search in the search direction last used.


+----------+------------------------------------------------------------------+
|          | -/                                                               |
+----------+------------------------------------------------------------------+

Reverse the search direction and repeat the last search in the new search
direction.


Customizing FSHELP
------------------

FSHELP can be customized with the following commands in the EE profiles
(PROFILE EE or SYSPROF EE):

+----------+------------------------------------------------------------------+
| PF       | FSHELP  pfno  command  [ parameters ... ]                        |
|          | FSHELP  CLEAR pfno                                               |
+----------+------------------------------------------------------------------+

Set or clear the command issued by a PF key. The pfno must be a number from
1 to 24, the maximal command length is 120 characters.


+-----------+-----------------------------------------------------------------+
| INFOLines | FSHELP  CLEAR                                                   |
|           | FSHELP  ADD infoline-text                                       |
+-----------+-----------------------------------------------------------------+

Control the information line at the bottom of the screens, usually describing
the PF key settings. FSHELP supports only one configurable information line.
CLEAR will display an empty line, ADD will display the text passed.