pathogen.vim

Manage your

'runtimepath'

For new users, I recommend using Vim's built-in package management instead.

:help packages

Installation

Install to

~/.vim/autoload/pathogen.vim

mkdir -p ~/.vim/autoload ~/.vim/bundle && \
curl -LSso ~/.vim/autoload/pathogen.vim https://tpo.pe/pathogen.vim

If you're using Windows, change all occurrences of

~/.vim

~\vimfiles

Runtime Path Manipulation

Add this to your vimrc:

execute pathogen#infect()

If you're brand new to Vim and lacking a vimrc,

vim ~/.vimrc

execute pathogen#infect()
syntax on
filetype plugin indent on

Now any plugins you wish to install can be extracted to a subdirectory under

~/.vim/bundle

'runtimepath'

cd ~/.vim/bundle && \
git clone https://github.com/tpope/vim-sensible.git

Now sensible.vim is installed. If you really want to get crazy, you could set it up as a submodule in whatever repository you keep your dot files in. I don't like to get crazy.

If you don't like the directory name

bundle

execute pathogen#infect('stuff/{}')

The

{}

You can also pass an absolute path instead. I keep the plugins I maintain under

~/src

execute pathogen#infect('bundle/{}', '~/src/vim/bundle/{}')

Normally to generate documentation, Vim expects you to run

:helptags

:helptags ~/.vim/doc

:Helptags

'runtimepath'

Helptags

Finally, pathogen.vim has a rich API that can manipulate

'runtimepath'

Native Vim Package Management

Vim 8 includes support for package management in a manner similar to pathogen.vim. If you'd like to transition to this native support, pathogen.vim can help. Calling

pathogen#infect()

bundle/{}

pack/{}/start/{}

Runtime File Editing

:Vopen

:Vedit

:Vsplit

:Vvsplit

:Vtabedit

:Vpedit

:Vread

FAQ

Can I put pathogen.vim in a submodule like all my other plugins?

Sure, stick it under

~/.vim/bundle

runtime bundle/vim-pathogen/autoload/pathogen.vim

Or if your bundles are somewhere other than

~/.vim

~/src/vim

source ~/src/vim/bundle/vim-pathogen/autoload/pathogen.vim

Will you accept these 14 pull requests adding a

.gitignore

for

tags

so I don't see untracked changes in my dot files repository?

No, but I'll teach you how to ignore

tags

git config --global core.excludesfile '~/.cvsignore'
echo tags >> ~/.cvsignore

While any filename will work, I've chosen to follow the ancient tradition of

.cvsignore

What about Vimballs?

If you really must use one:

:e name.vba
:!mkdir ~/.vim/bundle/name
:UseVimball ~/.vim/bundle/name

Why don't my plugins load when I use Vim sessions?

Vim sessions default to capturing all global options, which includes the

'runtimepath'

set sessionoptions-=options

Contributing

If your commit message sucks, I'm not going to accept your pull request. I've explained very politely dozens of times that my general guidelines are absolute rules on my own repositories, so I may lack the energy to explain it to you yet another time. And please, if I ask you to change something,

git commit --amend

Beyond that, don't be shy about asking before patching. What takes you hours might take me minutes simply because I have both domain knowledge and a perverse knowledge of Vim script so vast that many would consider it a symptom of mental illness. On the flip side, some ideas I'll reject no matter how good the implementation is. "Send a patch" is an edge case answer in my book.

Self-Promotion

Like pathogen.vim? Follow the repository on GitHub and vote for it on vim.org. And if you're feeling especially charitable, follow tpope on Twitter and GitHub.

License

Copyright (c) Tim Pope. Distributed under the same terms as Vim itself. See

:help license