perlhelp.vim is a Vim plugin that provides quick and easy access to perldoc. The perldoc text is displayed in a new window. This window is reused for resulting lookups if left open. When looking up a module filetype is set to perl so it is correctly highlighted, if syntax highlighting is turned on.
About Vim:
Vim is a text editor first released by Bram Moolenaar in 1991 for the Amiga computer. Vim was created as an extended version of the vi editor, with many additional features designed to be helpful in editing program source code; its full name is Vi IMproved.
While Vim is cross-platform, it is most popular on Unix-like operating systems.
Released under a software license compatible with the GNU General Public License, Vim is free and open source software. The program's license includes some charityware clauses.
Like vi, Vim's interface is based not on menus or icons but on commands given in a text user interface; its GUI mode, gVim, adds menus and toolbars for commonly used commands but the full functionality is still expressed through its command line mode.
For many users learning Vim may be difficult and slow initially, but once the basics are understood they progress quickly and editing becomes more efficient. To facilitate this, Vim has a built-in tutorial for beginners. There is also the Vim Users' Manual that details the basic and more advanced Vim features. This manual can be read from within Vim, or found online.
Vim also has a built-in help facility (using the :help command) that allows users to query and navigate through commands and features.
Functions:
The functions can accept an argument for the topic to lookup. If no argument is supplied they will prompt for the topic.
PerlFAQ - Lookup a regular expression using perldoc -q.
PerlHelp - Lookup a topic using perldoc.
PerlFunc - Lookup a function using perldoc -f.
PerlMod - Lookup a module using perldoc -m.
PerlVar - Lookup a Perl builtin variable in the perlvar page.
Key Mappings:
< Leader >ph - Lookup the selected text in visual mode or the word under the cursor in normal mode using perldoc.
< Leader >PH - Prompt for a topic to lookup using perldoc.
< Leader >pf - Lookup the selected text in visual mode or the word under the cursor in normal mode using perldoc -f.
< Leader >PF - Prompt for a function to lookup using perldoc -f.
< Leader >pm - Lookup the selected text in visual mode or the word under the cursor in normal mode using perldoc -m.
< Leader >PM - Prompt for a module to display using perldoc -m.
< Leader >pq - Lookup the selected text in visual mode or the word under the cursor in normal mode using perldoc -q.
< Leader >PQ - Prompt for a regular expression to lookup using perldoc -q.
< Leader >pv - Lookup the selected text in visual mode or the word under the cursor in normal mode in the perlvar page.
< Leader >PV - Prompt for a Perl builtin variable and look it up in the perlvar page.
The < Leader > key is normally ''. Thus to lookup the word under the cursor type 'ph'.
Tip:
Adding the following to your vimrc file will make POD documentation in Perl modules easier to read:
let perl_include_pod=1
Product's homepage
Find us on Google+
