sponsor Vim development Vim logo Vim Book Ad

Perldoc from VIM : Perldoc from VIM

 script karma  Rating 11/8, Downloaded by 1108  Comments, bugs, improvements  Vim wiki

created by
Johannes Petzold
 
script type
ftplugin
 
description
This script gives you direct access to perldoc documentation from inside VIM.
Perldoc support is automatically activated when editing perl files.

Requirements: "perl" v5.004 (or better) and "perldoc" must be accessible from your command line. Also, module Pod::Text::Termcap must be installed.

Usage: After installing (see below), edit a perlfile, press <F3>, enter name of wanted perldoc-page.
A new window is opened (presuming the wanted page exists), hopefully containing what you're looking for - a perldoc page, tuned up with some VIM syntaxhighlighting, generated from POD informations.

Perldoc pages that have already been retrieved earlier are taken from cache.
This speeds up the search and avoids double generation of VIM's synhighlight-commands.

You'll need to specify a directory where the cached perldoc-pages will be stored. This is done in the 2nd line of pdoc4vim.vim (you'll be guided there automatically if a valid entry couldn't be found).
Of course you can change the perldoc-key (default: F3) too, just check out the first lines from pdoc4vim.vim.
 
install details
- Store pdoc4vim.vim somewhere it doesn't bother you, e.g. in $vim/vimfiles directory.
- Add this line to the file $vim/vimfiles/ftplugin/perl.vim (create if it doesn't exist):
  source <path to pdoc4vim.vim>
  e.g.: source $vim/vimfiles/pdoc4vim.vim
- Open an existing *.pl-file (or create a new one, starting with :set filetype=perl),
  press F3. Follow instructions on screen.
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
pdoc4vim.vim 1.0 2005-02-24 6.0 Johannes Petzold Initial upload
ip used for rating: 3.128.198.21

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
Vim at Github