Accessing Help

This section describes how Epsilon can help you access programming language and library documentation. See Getting Help for directions on obtaining help on Epsilon itself.

To get help on the word at point, press Shift-F1 to run the context-help command. It provides help on the identifier at point, selecting the appropriate type of help based on the current mode. See Context-Sensitive Help for details. In some modes, it uses commands explained in this section.

Epsilon for Unix provides a man command for reading man pages. At its prompt, type anything you would normally type to the man command, such as -k open to get a list of man pages related to the keyword "open". If you don't use any flags or section names, Epsilon will provide completion on available topics. For example, type "?" to see all man page topics available. Within man page output, you can double-click on a reference to another man page, such as echo(1), or press <Enter> to follow it, or press m to be prompted for another man page topic. The man command also works under Windows using the Cygwin environment, if its man program is installed.

The search-man-pages command generates a list of man pages that contain some specified text, putting its results in the grep buffer. (See Searching Multiple Files.) It first prompts for the search string. You can use Ctrl-t, Ctrl-c, or Ctrl-w to toggle regular expression, case folding, or word searching behavior, as with grep and other searching commands.

Then it asks if you want to restrict searching to particular man page sections, such as 1 for commands or 3 for subroutines. Use * to search all sections. Finally, it asks if you want to restrict the search to man page entries matching a certain file pattern, such as *file* to search only pages whose names contain "file".

For speed reasons, it searches each man page without processing it through the man command, searching the man page in source format. By default, it shows only the first match in each page; set the search-man-pages-shows-all variable to see all matches. The result appears in the grep buffer; when you view a match from there, Epsilon will then use the man command to display its processed form.

Epsilon also includes a perldoc command for reading Perl documentation. Just like man, it works by running an external program, in this case the perldoc program that comes with Perl. Run perldoc on the topic perldoc to see the flags you can use with it, such as -f to locate the documentation for a specific Perl function.

Standard bindings:

   man

   perldoc

   search-man-pages

Previous Up Next
Pulling Words Commands by Topic Context-Sensitive Help