Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jez/vim-superman
Read Unix man pages faster than a speeding bullet!
https://github.com/jez/vim-superman
vim
Last synced: 3 days ago
JSON representation
Read Unix man pages faster than a speeding bullet!
- Host: GitHub
- URL: https://github.com/jez/vim-superman
- Owner: jez
- License: mit
- Created: 2014-12-21T05:21:47.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2023-07-05T12:24:03.000Z (over 1 year ago)
- Last Synced: 2024-12-18T09:09:35.291Z (11 days ago)
- Topics: vim
- Language: Vim script
- Homepage: http://blog.jez.io/2014/12/20/vim-as-a-man-page-viewer/
- Size: 16.6 KB
- Stars: 192
- Watchers: 6
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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.
```bash
# 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:
```bash
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
```zsh
compdef vman="man"
```
to your ~/.zshrc or
```bash
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`:
```bash
$ vman vim
```
It's that simple. The underlying `:Man` command supports specifying a specific
section, so you could also do something like
```bash
$ vman 3 printf
```
To see the man page for the C `printf()` library call.
## FAQ
For more information, see the [associated blog post][blog].
### 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][sdark] for the color scheme and [Vim Airline][vairline] for the
statusbar. If you're curious about my whole setup, be sure to check out my
[dotfiles repository][dotfiles].
## License
MIT License. See LICENSE.
[blog]: http://blog.jez.io/2014/12/20/vim-as-a-man-page-viewer/
[sdark]: https://github.com/altercation/vim-colors-solarized
[vairline]: https://github.com/bling/vim-airline
[dotfiles]: https://github.com/jez/dotfiles