currently comes with a single (rather large) ASCII text file,
command (which can be abbreviated
) will open a new window on that file.
You can then search for information on a particular topic,
using standard vi
Because it is a flat ASCII file, it is also easy to
print out and read through.
In addition to the help file, vile
has a number of built-in
commands for displaying information about the facilities and state
of the editor. Some of the most useful commands are:
Creates a new window that shows a complete list of all vile
commands, with a brief description of each one.
The information is placed in its own buffer that can be treated
just like any other vile
In particular, it is easy to write it out to a file for later printing.
Shows all commands whose names contain a given substring.
This is easier than just randomly searching through the
help file to find information on a particular topic.
Prompts you for a key or key sequence, and then shows the description
of that command. For instance, the
key will implement
Prompts you for a function name, and then shows the description
of that function. For instance, the
function deletes a given number of characters to the right of the
current cursor position.
commands all give the descriptive information, plus all
other synonyms (since a function may have more than one name, for
convenience), all other keys that are bound to it (since many
key sequences may be bound to the same function), and whether the
command is a "motion" or an "operator."
A good example of this is the output of
"next-line" ^J j #-B
(motion: move down CNT lines )
This shows all four of its names and its three key-bindings. (The
terminal-independent representation of the
up-arrow -- a complete list of those names is in the help file.)
variable can be set to a colon-separated search path
for the help file.[
environment variable can be
used to override the name of the help file (typically
The combination of online searchable help, built-in
command and key descriptions, and command completion
makes the help facility straightforward to use.