68 lines
1.5 KiB
Groff
68 lines
1.5 KiB
Groff
'\"macro stdmacro
|
|
.TH HELP 1
|
|
.SH NAME
|
|
help \- ask for help about SCCS error messages and commands
|
|
.SH SYNOPSIS
|
|
.B help
|
|
[\^args\^]
|
|
.SH DESCRIPTION
|
|
.I Help\^
|
|
finds information to explain a message from an SCCS command or explain
|
|
the use of an SCCS command.
|
|
Zero or more arguments may be supplied.
|
|
If no arguments are given,
|
|
.I help\^
|
|
will prompt for one.
|
|
.PP
|
|
The arguments may be either
|
|
message numbers (which normally appear in parentheses following messages)
|
|
or command names,
|
|
of one of the following types:
|
|
.PP
|
|
.RS .3i
|
|
.TP "\w'type 3\ \ \ 'u"
|
|
type 1
|
|
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., \f3ge6\fP, for message 6 from the
|
|
.I get\^
|
|
command).
|
|
.TP
|
|
type 2
|
|
Does not contain numerics (as a command, such as
|
|
.BR get )
|
|
.TP
|
|
type 3
|
|
Is all numeric (e.g., \f3212\fP)
|
|
.RE
|
|
.PP
|
|
The response of the program will be the explanatory information related
|
|
to the argument, if there is any.
|
|
.PP
|
|
When all else fails, try ``help stuck''.
|
|
.SH EXAMPLE
|
|
.IP
|
|
help he1
|
|
.PP
|
|
prints the message for error number "he1".
|
|
.SH FILES
|
|
.TP "\w'/usr/lib/help/helploc\ \ 'u"
|
|
/usr/lib/help
|
|
directory containing files of message text.
|
|
.ns
|
|
.TP
|
|
/usr/lib/help/helploc
|
|
file containing locations of help files not in \f3/usr/lib/help\fP.
|
|
.SH DIAGNOSTICS
|
|
Use
|
|
.IR help\^ (1)
|
|
for explanations.
|
|
.SH NOTES
|
|
.IR help\^ (1)
|
|
is not a general help facility.
|
|
It only knows about the SCCS commands and error messages generated
|
|
by those commands.
|
|
.SH SEE ALSO
|
|
admin(1), delta(1), edit(1), get(1)
|