# help(2)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

## NAME

help - Help; high level introduction to help
help-command - Help; command information
help-variable - Help; variable information
help-item - Help; item information

## SYNOPSIS

n help (esc ?)
help-command "command" (C-h C-c)
help-variable "variable" (C-h C-v)
help-item "item" (C-h C-i)

## DESCRIPTION

The help commands provide a quick on-line help facility within MicroEmacs 2009 without invoking a third party documentation system (e.g. a browser such as Netscape(1) or winhelp(1)).

The on-line help is assisted by a set of macros which enable key words within the help buffers to be located by either tagging (`esc t`) or by selection with the left mouse button. The tag mechanism supports command completion.

help provides general help on the philosophy and functionality of MicroEmacs 2009, if an argument n of 0 is given to the command it changes the current buffer to the internal help buffer, typically named "`*on-line help*`". This is a hidden system buffer used to store all the on-line help and can be used for a variety of things. Note that access to this buffer must be via the help command, not find-buffer and the help command will also ensure the system help file is loaded first.

help-command describes the purpose of the given command.

help-variable Describes the purpose of the given variable, similar to help-command, only for variables.

help-item Describes the purpose of any given item, where item could be a command, variable or any aspect of MicroEmacs 2009.

## FILES

The help files are ASCII text files located in the MicroEmacs 2009 home directory. The files are defined as follows:-

`me.ehf` - Help text file.
`hkehf.emf` - Help macros.

## SEE ALSO

osd-help(3), command-apropos(2), describe-bindings(2), describe-key(2), list-commands(2), list-variables(2).

(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12

</HMTL>