sponsor Vim development Vim logo Vim Book Ad

help.vim : help subsystem (create buffer with context-dependent help page)

 script karma  Rating 35/11, Downloaded by 2262  Comments, bugs, improvements  Vim wiki

created by
Nikolay Panov
 
script type
utility
 
description
This plugin can help you call man or perldoc -f or many other help system in dependent from context.

Changes:
      * 1.18-1 now support perdoc in win32 OS...
      * 1.18     several bugfixes, added call apropos if man page not found.
      * 1.17     support fvwm, muttrc filetype, many fixes...
      * 1.17g   new, extended implementation of help.vim (http://www.vim.org/scripts/script.php?script_id=561)
      * 1.17b   forked by help.vim,v 1.16 2002/01/05 19:58:38 from Slava Gorbanev, added support tcl/tk and many fixes

Usage:
          use <F1> by default or other key (if you remap it) to call Help(expand("<cword>"))
          this function creating in half window buffer with contex-dependent
          manual (or other) page about word under corsor.

    By default in help-buffer set key-mapping:
    q           for exit (and ``Esc'' in GUI mode)
    o           for command :only
    D           for go to DESCRIPTION section
    S           for go to SYN section
    (and other --- see source code by detail)

You can mapping go to any other section:
for example for go to NAME section by N key call next command:
map N :call GoToSection('NAME')

Now support: sh, vim, perl, tcl/tk, C/C++, fvwm, muttrc and many other.

TODO nicier documentation (oh, my terrible english)...
TODO support many other language
 
install details
put this into your plugin directory (~/.vim/plugin)
 

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
help.vim 1.20 2008-11-26 7.0 Nikolay Panov Some new help systems are supported now (e.g. pydoc for python). And the plugin is tested under vim 7.
help.vim 1.20 2008-11-26 6.0 Nikolay Panov Some new help systems are supported now (e.g. pydoc for python).
help.vim 1.18-1 2003-04-03 6.0 Nikolay Panov now support perdoc in win32 OS...
help.vim 1.18 2003-03-11 6.0 Nikolay Panov several bugfixes, added call apropos if man page not found
ip used for rating: 3.82.58.213

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