https://github.com/gpanders/vim-man
Read man pages in Vim
https://github.com/gpanders/vim-man
Last synced: about 1 month ago
JSON representation
Read man pages in Vim
- Host: GitHub
- URL: https://github.com/gpanders/vim-man
- Owner: gpanders
- Created: 2019-03-08T14:29:14.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-09T23:19:06.000Z (about 6 years ago)
- Last Synced: 2025-02-05T09:52:00.657Z (3 months ago)
- Language: Vim script
- Homepage:
- Size: 7.81 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vim-man
Read man pages in vim.
## Note for neovim users
neovim contains an autoloaded implementation of `:Man` already, so this plugin
is not only unnecessary but will in fact conflict with neovim's native
implementation.
If you use a common config for both vim and neovim, make sure you only load this
plugin if `has('nvim')` is false.
For example, you could use the following in your vimrc:
```vim
" With vim-plug
if !has('nvim')
Plug 'gpanders/vim-man'
endif
" With native vim packages
" Place vim-man under ~/.vim/pack/gpanders/opt/, then use:
if !has('nvim')
packadd vim-man
endif
```
## Motivation
This is a modification of the man ftplugin that is included in Vim, written by
SungHyun Nam. That ftplugin supplied a `:Man` command that allowed you to find
and read man pages in vim, but it was not loaded until you first visited a man
page or you ran `runtime ftplugin/man.vim`. In addition, the plugin did not use
autoloads so you paid the full price of defining these functions even if
you never used the `:Man` command in your vim session.
I simply took SungHyun's file and split it up into three parts: a plugin file
that provides the `:Man` command, an autoload file that will only be executed
when you actually use `:Man`, and the ftplugin file to configure vim for reading
man pages.
## Customization
This plugin provides two mappings: `(ManPreGetPage)` and `(ManBS)`.
The first allows you to call `:Man` on the word under your cursor. This is
equivalent to settings `keywordprg=:Man` and using `K`, but allows you to keep
`keywordprg` to a different value. The second deletes all backspace characters
in the page.
You can use these mappings as follows (these are just suggested keys, you can of
course use any mapping you like):
`~/.vimrc`:
```vim
nmap K (ManPreGetPage)
```
`~/.vim/after/ftplugin/man.vim`:
```vim
nmap h (ManBS)
```
To enable folding in man pages, put the following in your `vimrc`:
```vim
let g:ft_man_folding_enable = 1
```
## Credit
SungHyun Nam did the bulk of the work in creating and writing the man ftplugin
and the `:Man` command.
## License
Distributed under the same terms as Vim itself. See `:help license`.