jez / vim-superman Goto Github PK

View Code? Open in Web Editor NEW

190.0 6.0 20.0 17 KB

Read Unix man pages faster than a speeding bullet!

Home Page: http://blog.jez.io/2014/12/20/vim-as-a-man-page-viewer/

License: MIT License

Vim Script 83.20% Shell 16.80%

vim

vim-superman's Introduction

Vim SuperMan

Read Unix man pages faster than a speeding bullet!

Unix man pages by default open with the less pager. Getting them to open with Vim can be a little bit of a pain, but in recent versions of Vim there's a plugin ($VIMRUNTIME/ftplugin/man.vim) that makes this easy.

This is a simple Vim plugin and sh function that makes replacing man from the command line a cinch.

Installation

Use your favorite plugin manager. If you don't have one, I'd recommend Vundle, though you should probably also take a look at Pathogen, as it's more common.

# if your ~/.vim folder isn't under source control:
git clone https://github.com/jez/vim-superman ~/.vim/bundle/vim-superman

# if your ~/.vim folder is under source control:
git submodule add https://github.com/jez/vim-superman ~/.vim/bundle/vim-superman

Then, add the following to your .bashrc, .bash_profile, .zshrc, or whatever file you use to configure your shell:

export PATH="$PATH:$HOME/.vim/bundle/vim-superman/bin"

(Note: you'll have to change this location if you installed Vim SuperMan somewhere else.)

Close and reopen your terminal and you're set! You can even add

compdef vman="man"

to your ~/.zshrc or

complete -o default -o nospace -F _man vman

to your ~/.bashrc to get tab completion. (Thanks to texasflood for the Bash completion snippet.)

Usage

This predominantly a command line tool. To open the man page for vim:

$ vman vim

It's that simple. The underlying :Man command supports specifying a specific section, so you could also do something like

$ vman 3 printf

To see the man page for the C printf() library call.

FAQ

For more information, see the associated blog post.

Jake, why not just name the bash function `man`?

The actual man command supports many more features than the Vim plugin does (for a complete list, see man(1)). If you shadow the real man command, things start to break, for example apropos, which uses man under the hood.

When I install `vim-superman` it looks nothing like this!

There are a couple other plugins of mine featured prominently here, including Solarized Dark for the color scheme and Vim Airline for the statusbar. If you're curious about my whole setup, be sure to check out my dotfiles repository.

License

MIT License. See LICENSE.

vim-superman's People

Contributors

Stargazers

Watchers

Forkers

andreicristianpetcu kurtenbachkyle lytedev musoke casey idlewan henrebotha shofel timfeirg ccszwg syyyr camflint beauwilliams pearagit coldeasy wchmb yididiel7 minnerlas

vim-superman's Issues

Autocomplete doesn't work for me for some reason, despite following all the install instructions.

(yes, I put the stuff in my .bashrc)

Example: If I try to autocomplete $ vman ma:

[krompus@creator ~]$ vman mabash: completion: function `_man' not found
[krompus@creator ~]$ vman mail/

It seems it's trying (and succeeding) to autocomplete from the pwd, and not the man pages. Any ideas?

(This is a beautiful program by the way! Finally, I can have :set scrolloff=5 in man pages!)

Can anyone check if vman and man always work.

I have fish shell. I translated the vman function to fish-speak. The function works nicely, for example,
vman ls works.

I noticed that vman help returns "No manual entry for help" but man help works.

Can anyone else confirm this on bash ?

It'll be great if we can be sure that there is no man page for a command when vman says so. Otherwise, we'll have to check man every time.

I'm getting strange line wrapping behaviour. (screenshot provided).

It seems that the lines are attempting to make themselves "too long" by one character, triggering vim's soft linewrapping, which looks awful for manpages.

Here's what it looks like (vman at the top, vim on the left, man on the right).

Is there a solution to this?

(Thanks for the beautiful program, by the way!

Don't use $EDITOR, use $VISUAL

VISUAL vs EDITOR what's the difference?

The EDITOR editor should be able to work without use of "advanced" terminal functionality (like old ed or ex mode of vi). It was used on teletype terminals.

A VISUAL editor could be a full screen editor as vi or emacs.

Please change to:

${VISUAL:-vim} -c "SuperMan $*"

Visual is where vi got its name from after all! :)

Follow `man` behaviour

This is great, thanks!

Could the null man behaviour be emulated?

$ ~/.local/share/vim/bundle/vim-superman/bin/vman
No manual entry for
$ man
What manual page do you want?

Please add unite.vim source

Hi,

Awesome plugin! Please add a unite.vim source so we can search in the manual pages also.
https://github.com/Shougo/unite.vim
How to make a unite source
http://ujihisa.blogspot.ro/2010/11/how-to-make-unite-plugin.html

Thank you!

Release tag

Hi Jake,

I'm using vman for quite a while now and would like to have a release tag to have a better checkout mechanism for updating the plugin.

Bests from Berlin

cannot get to specific section from shell using neovim

For example,

usr/bin/vim -c "SuperMan 3 printf" will open printf(3) perfectly,

but nvim -c "SuperMan 3 printf" will open printf(1).

However in nvim, :SuperMan 3 printf also works correctly.

Set keywordprg to :Man

So that I can press K on something in :Man and not have it open in !man.

Read man page in split mode

Hi,
I find superman really great, especially when doing c programming and needing to read man pages.
I use the plugin from inside vim with for example

:SuperMan printf

I would like to open the man page in a split. Currently it creates a new buffer, and loads in a complete windows.