SQLMON provides extensive online help, with descriptions of screens, fields, subsystems, and commands, as well as performance tuning hints. The help facility is context sensitive; for example, if you request tuning information from within the Lock subsystem, you see only tuning hints related to locking issues.
Invoking the Help Facility |
 |
To invoke the SQLMON help facility, issue the following command from a subsystem prompt:
SQLMONITOR OVERVIEW => help
|
By default, SQLMON displays help information for the screen you last accessed. To override the default, you can specify the screen name on the command line. For example, to get help information on the IO screen from the Overview subsystem, enter
SQLMONITOR OVERVIEW => help io
|
Leaving the Help Facility |
|
To leave the help facility, enter any of the following commands to
return to the subsystem prompt:
SQLMONITOR HELP OVERVIEW => //
SQLMONITOR HELP OVERVIEW => EXIT
SQLMONITOR HELP OVERVIEW => QUIT
|
Once you return to the subsystem prompt, you can access SQLMON screens, issue SQLMON commands, or exit the program.
Issuing Help Commands |
|
When you enter the help facility, it displays the help prompt for the current screen:
SQLMONITOR HELP OVERVIEW =>
|
Let's assume that you have just visited the Lock Memory screen. The easiest way to get help on the screen is to enter the command HELP from the prompt:
SQLMONITOR [ LOCK ] => help
|
You would then see information about using the Lock Memory screen, and then return to the help prompt, which looks like this:
SQLMONITOR [ HELP LOCK MEMORY ] =>
|
Notice that the name of the screen is displayed in the help prompt, not just the name of the Lock subsystem.
To see a description of each field that appears on the Lock Memory screen, enter
SQLMONITOR [ HELP LOCK MEMORY ] => help
|
You can then type additional commands to get more information:
SQLMONITOR [ HELP LOCK MEMORY ] => control
SQLMONITOR [ HELP LOCK MEMORY ] => tune
|
When you want to leave the help facility, type //, EXIT, or QUIT:
SQLMONITOR [ HELP LOCK MEMORY ] => //
SQLMONITOR [ LOCK ] =>
|
You can also add options to the HELP command when you enter the help facility. For example, after you visit the Static DBEFile screen, you can enter the following command to display a description of each field on the screen:
SQLMONITOR [ STATIC ] => help info
|
Then, to leave the help facility and return to the screens, enter
SQLMONITOR [ HELP STATIC DBEFILE ] => //
SQLMONITOR [ STATIC ] =>
|
Table 6-3 “SQLMON Help Commands” summarizes the parameters you can add to the
HELP command.
Table 6-3 SQLMON Help Commands
| Help Command | Description |
|---|
| ScreenName | Generates help text for the screen you specify. |
| CONTROL | Describes the SET commands that affect the current screen. |
| INFO | Describes each field belonging to the current screen. |
| SUBSYSTEM | Describes each of the screens in the subsystem. |
| TUNE | Generates a list of topics on database performance tuning. |
| TUNE TuneNumber | Provides detailed information on the tuning topic designated by TuneNumber. |
| MAIN | Displays general information on SQLMON. |
| SetCommand | Describes the SetCommand you specify. |
The HELP command is documented fully in the chapter "SQLMON Command Reference."
