SCUHELP

Gives help about SCUBA software

Description:

Displays help about SCUBA software. The help information has classified and alphabetical lists of commands, general information about SCUBA and related material; it describes individual commands in detail.

Usage:

scuhelp [topic] [subtopic] [subsubtopic] [subsubsubtopic]

Parameters:

TOPIC = LITERAL (Read)
Topic for which help is to be given.
SUBTOPIC = LITERAL (Read)
Subtopic for which help is to be given.
SUBSUBTOPIC = LITERAL (Read)
Subsubtopic for which help is to be given.
SUBSUBSUBTOPIC = LITERAL (Read)
Subsubsubtopic for which help is to be given.

Examples:

scuhelp
No parameter is given so the introduction and the top-level help index is displayed.
scuhelp application/topic
This gives help about the specified application or topic.
scuhelp application/topic subtopic
This lists help about a subtopic of the specified application or topic. The hierarchy of topics has a maximum of four levels.
scuhelp Hints
This gives hints for new and intermediate users.
scuhelp summary
This shows a one-line summary of each application.
scuhelp classified classification
This lists a one-line summary of each application in the given functionality classification.

Notes:

The environment variable SURF_HELP should be set to point to the help file. This variable is usually set as part of the Starlink login.

Navigating the Help Library

The help information is arranged hierarchically. You can move around the help information whenever SCUHELP prompts. This occurs when it has either presented a screens worth of text or has completed displaying the previously requested help. The information displayed by SCUHELP on a particular topic includes a description of the topic and a list of subtopics that further describe the topic.

At a prompt you may enter:

You can abbreviate any topic or subtopic using the following rules.

Ambiguous abbreviations result in all matches being displayed.

Implementation Status: