help(1)
_________________________________________________________________
help Command
DG/UX system Help Facility
_________________________________________________________________
SYNTAX
help
[ help ] starter
[ help ] usage [ -d ] [ -e ] [ -o ] [ command_name ]
[ help ] locate [ keyword1 [ keyword2 ] ... ]
[ help ] glossary [ term ]
help sccs_command | (sccs_message number)
DESCRIPTION
The DG/UX system Help Facility provides on-line assistance for
DG/UX system users, whether they desire general information about
DG/UX or specific assistance for use of the Source Code Control
System (SCCS) commands.
Without arguments, help prints a menu of available on-line
assistance commands with a short description of their functions.
The commands and their descriptions are:
COMMAND DESCRIPTION
starter information about the DG/UX system for the
beginning user
locate locate DG/UX system commands using function-
related keywords
usage DG/UX system command usage information
glossary definitions of DG/UX 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 on-line
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 and how many backslashes to use for each, refer
DG/UX 4.00 Page 1
Licensed material--property of copyright holder(s)
help(1)
to the glossary(1) manual page.
From any screen in the Help Facility, a user may execute a
command via the shell (sh(1)) by typing a ! and the command to be
executed. The screen 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
printing the data (non-scrolling), the shell environment variable
SCROLL must be set to no. This is done in the Bourne shell, sh,
by adding the following line to your .profile file (see
profile(4)): ``SCROLL=no; export SCROLL''. In the csh(1), add
the following line to your .login file: "setenv 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(1M) 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:
type1 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 (e.g., ge3
for message 3 from the get command).
type2 Does not contain numerics (e.g. a command, such as get).
type3 Is all numeric (e.g., 212).
If the first argument is not a true SCCS command or message
number, then the help main menu appears.
_________________________________________________________________
EXAMPLES
$ help get
get:
get [-r<SID>] [-c<cutoff>] [-i<list>] [-x<list>] [-a<seq no.>]
DG/UX 4.00 Page 2
Licensed material--property of copyright holder(s)
help(1)
[-k] [-e] [-l<p>] [-p] [-m] [-n] [-s] [-b] [-g] [-t] file ...
$
help with an argument that is an SCCS command will display usage
of that command.
$ help ge3
ge3:
"e not allowed with m"
You can't use both the -e and -m arguments on the same get command.
$
help with an error number from an SCCS module will display text
associated with that error number.
_________________________________________________________________
SEE ALSO
glossary(1), helpadm(1M), locate(1), csh(1), sh(1), starter(1),
usage(1).
admin(1), cdc(1), comb(1), delta(1), get(1), prs(1), rmdel(1),
sact(1), sccsdiff(1), unget(1), val(1), vc(1), what(1),
profile(4), sccsfile(4), term(5) in the Programmer's Reference
for the DG/UX System.
WARNINGS
If the shell environment variable TERM (see sh(1)) is not set in
the user's .profile file on .login, then TERM will default to the
terminal value type 450 hard. For a list of valid terminal
types, refer to term(5).
DG/UX 4.00 Page 3
Licensed material--property of copyright holder(s)