help(1) CLIX help(1)
NAME
help - Runs the UNIX System Help Facility
SYNOPSIS
help
[help] starter
[help] usage [-d] [-e] [-o] [command_name]
[help] locate [keyword ... ]
[help] glossary [term]
help arg ...
DESCRIPTION
The CLIX system Help Facility provides online assistance for CLIX system
users, whether they desire general information or specific assistance for
use of the Source Code Control System (SCCS) commands.
Without arguments, help displays a menu of available online assistance
commands with a short description of their functions. The commands and
their descriptions are:
starter Information about the CLIX system for the beginning user
locate Locate CLIX system commands using function-related keywords
usage CLIX system command usage information
glossary definitions of CLIX system technical terms
The user may choose one of the above commands by entering its
corresponding letter (given in the menu), or may exit to the shell by
typing q (for ``quit'').
With arguments, help directly invokes the named online assistance command,
bypassing the initial help menu. The commands starter, locate, usage, and
glossary, optionally preceded by the word help, may also be specified at
shell level. When executing glossary from shell level some of the symbols
listed in the glossary must be escaped (preceded by one or more
backslashes, `` \'') to be understood by the Help Facility. For a list of
symbols refer and how many backslashes to use for each, refer to the
glossary manual page.
From any screen in the Help Facility, a user may execute a command with
the shell (sh) by typing an ! and the command to be executed. The screen
2/94 - Intergraph Corporation 1
help(1) CLIX help(1)
will be redrawn if the command that was executed was entered at a first
level prompt. If entered at any other prompt level, only the prompt will
be redrawn.
By default, the Help Facility scrolls the data that is presented to the
user. If you prefer to have the screen clear before displaying the data
(nonscrolling), the shell variable $SCROLL must be set to no and exported
so it will become part of your environment. This is done by adding the
following line to your .profile file (see profile): ``export SCROLL ;
SCROLL=no''. If you later decide that scrolling is desired, $SCROLL must
be set to yes.
Information on each of the Help Facility commands (starter, locate, usage,
glossary, and help) is located on their respective manual pages.
The Help Facility can be tailored to a customer's needs by use of the
helpadm command.
If the first argument to help is different from starter, usage, locate, or
glossary, help assumes information is being requested about the SCCS
Facility. The arguments may be either message numbers (which normally
appear in parentheses following messages) or command names, of one of the
following types:
⊕ Begins with non-numerics, ends in numerics. The non-numeric prefix is
usually an abbreviation for the program or set of routines which
produced the message (for example, ge3 for message 3 from the get
command).
⊕ Does not contain numerics (as a command, such as get).
⊕ Is all numeric (for example, 212).
CAUTIONS
If the shell variable $TERM (see sh) is not set in the user's .profile
DIAGNOSTICS
Error messages are self explanatory.
EXIT VALUES
Exit values are not valid.
RELATED INFORMATION
Commands: glossary(1), helpadm(1), locate(1), sh(1), starter(1),
usage(1), admin(1), cdc(1), comb(1), delta(1), get(1), prs(1), rmde(1),
sact(1), sccsdiff(1), unget(1), val(1), vc(1), what(1)
2 Intergraph Corporation - 2/94
help(1) CLIX help(1)
Files: profile(4), sccsfile(4)
Miscellany: term(4)
2/94 - Intergraph Corporation 3