⇑ Updated MKS Toolkit
![[3khat16.ico]](../../img/3khat16.ico)
HP3000
3kMail
![[archive16.gif]](../../img/archive16.gif "Wayback Archive")
helpdisplay brief command explanations |
Command |
help [command ...]
help command provides information about the MKS utility
specified by command.
help acts as a mnemonic reference tool for command options.
It offers more information than the standard usage message displayed by all
commands, but considerably less than the reference pages. Output for a single
command is intentionally brief and usually fits on one screen.
help first looks for the help file provided in
/etc/helpfile. If help cannot find this file,
it looks for helpfile in the directory where the
help command is located.
If help cannot find command, and if
HELPCMD is set, it invokes this help utility.
help uses a helpindex file to quickly locate
information in the help file. If help cannot find a
helpindex file, it creates one in the same directory that holds the
help file. If you change the help file (for example, add new information),
help checks the modification dates and rebuilds the
helpindex file if the help file has a later date.
You can assign a list of directories separated by colons to the environment
variable HELP. help searches
these directories (in addition to /etc) when looking for the
helpfile and helpindex files. Such directories can
hold help information you create yourself.
HELPcontains a list of additional path names to search when looking for
helpfile and helpindex files.
HELPCMDcontains the path name for an additional command to execute if the
help command fails to find help. This lets users add
specialized help commands for their environment.
/etc/man1/*.1unformatted manual entries.
/etc/helpfilehelp information obtained from reference pages.
/etc/helpindexan index to /etc/helpfile to speed up the search for help
information.
0Successful completion.
1Failure because the help file could not be found or because it contained no information on the desired command.
man
envvar