Next: Entering and Exiting, Previous: The Echo Area, Up: Introduction [Contents][Index]
Hemlock has a fairly good online documentation facility. You can get brief documentation for every command, variable, character attribute, and key by typing a key.
This command prompt for a key-event indicating one of a number of other documentation commands. The following are valid responses:
List commands and other things whose names contain a specified keyword.
Give the documentation and bindings for a specified command.
Give the documentation for any Hemlock thing.
Give the documentation for a Hemlock variable and its values.
Give the documentation for a command bound to some key.
List the last sixty key-events typed.
Give the documentation for a mode followed by a short description of its mode-specific bindings.
Give the documentation and bindings for commands that have at least one binding involving a mouse/pointer key-event.
List all the key bindings for a specified command.
Describe a LISP object.
Quit without doing anything.
List all of the options and what they do.
This command prints brief documentation for all commands, variables, and character attributes whose names match the input. This performs a prefix match on each supplied word separately, intersecting the names in each word’s result. For example, giving Apropos "f m" causes it to tersely describe following commands and variables:
Notice Mark Form demonstrates that the "f" words may follow the "m" order of the fields does not matter for Apropos.
The bindings of commands and values of variables are printed with the documentation.
This command prompts for a command and prints its full documentation and all the keys bound to it.
This command prints full documentation for the command which is bound to the specified key in the current environment.
This command prints the documentation for a mode followed by a short description of each of its mode-specific bindings.
Show Variable prompts for the name of a variable and displays the global value of the variable, the value local to the current buffer (if any), and the value of the variable in all defined modes that have it as a local variable. Describe and Show Variable displays the variable’s documentation in addition to the values.
This command displays the last sixty key-events typed. This can be useful if, for example, you are curious what the command was that you typed by accident.
This command displays the documentation and bindings for commands that have some binding involving a mouse/pointer key-event. It will not show the documentation for the Illegal command regardless of whether it has a pointer binding.
This command prompts for the name of a command and displays its key bindings in a pop-up window. If a key binding is not global, the environment in which it is available is displayed.
This command prints full documentation for any thing that has documentation. It first prompts for the kind of thing to document, the following options being available:
Describe a character attribute, given its name.
Describe a command, given its name.
Describe a command, given a key to which it is bound.
Describe a variable, given its name. This is the default.
Next: Entering and Exiting, Previous: The Echo Area, Up: Introduction [Contents][Index]