ctrlp.vim/readme.md

80 lines
2.7 KiB
Markdown
Raw Normal View History

2011-09-05 19:45:33 -04:00
# ctrlp.vim
Full path fuzzy __file__, __buffer__, __mru__ and __tag__ finder for Vim.
2011-09-05 19:30:54 -04:00
2011-09-05 10:59:18 -04:00
* Written in pure Vimscript for MacVim and Vim 7.0+.
* Full support for Vims regexp as search pattern.
* Built-in Most Recently Used (MRU) files monitoring.
* Built-in projects root finder.
* Open Multiple Files.
* [Extensible][3].
2011-08-21 22:14:00 -04:00
![ctrlp][1]
## Basic Usage
* Press `<c-p>` or run `:CtrlP` to invoke CtrlP in find file mode.
* Or run `:CtrlPBuffer` or `:CtrlPMRU` to invoke CtrlP in buffer or MRU mode.
Once CtrlP is open:
* Press `<c-f>` and `<c-b>` to switch between find file, buffer, and MRU file modes.
* Press `<c-d>` to switch to filename only search instead of full path.
2012-01-18 08:56:18 -05:00
* Press `<F5>` to purge the cache for the current directory and get new files.
2011-09-12 21:27:27 -04:00
* Use `*` or `|` in the prompt to submit the string as a Vims regexp pattern.
* Or press `<c-r>` to switch to regexp mode.
* End the input string with a colon `:` followed by a command to execute after opening the file.
e.g. `abc:45` will open the file matched the pattern and jump to line 45.
2011-09-09 09:49:50 -04:00
* Submit two dots `..` as the input string to go backward the directory tree by 1 level.
* Use `<c-y>` to create a new file and its parent dirs.
* Use `<c-z>` to mark/unmark files and `<c-o>` to open them.
2011-08-21 22:14:00 -04:00
2011-09-05 10:59:18 -04:00
## Basic Options
* Change the mapping to invoke CtrlP:
2011-09-05 20:11:20 -04:00
2011-08-21 22:14:00 -04:00
```vim
let g:ctrlp_map = '<c-p>'
```
2011-09-05 20:11:20 -04:00
2011-09-07 17:01:08 -04:00
* When CtrlP is invoked, it automatically sets the working directory according to this variable:
2011-09-05 19:47:40 -04:00
2011-08-21 22:14:00 -04:00
```vim
let g:ctrlp_working_path_mode = 2
2011-08-21 22:14:00 -04:00
```
2011-09-05 19:47:40 -04:00
2011-09-05 20:00:33 -04:00
0 - dont manage working directory.
2011-09-05 10:59:18 -04:00
1 - the parent directory of the current file.
2 - the nearest ancestor that contains one of these directories or files:
2011-09-05 19:47:40 -04:00
2011-09-05 10:59:18 -04:00
.git/
.hg/
.bzr/
_darcs/
root.dir
2011-09-05 19:47:40 -04:00
* If you want to exclude directories or files from the search, you can use the Vims option `wildignore`
and/or the option `g:ctrlp_custom_ignore`. Examples:
2011-09-11 18:49:42 -04:00
```vim
2011-09-13 13:17:20 -04:00
set wildignore+=*/.git/*,*/.hg/*,*/.svn/* " for Linux/MacOSX
set wildignore+=.git\*,.hg\*,.svn\* " for Windows
let g:ctrlp_custom_ignore = '\.git$\|\.hg$\|\.svn$'
let g:ctrlp_custom_ignore = {
\ 'dir': '\.git$\|\.hg$\|\.svn$',
\ 'file': '\.exe$\|\.so$\|\.dll$',
2012-01-18 08:56:18 -05:00
\ 'link': 'some_bad_symbolic_links',
\ }
2011-09-11 18:49:42 -04:00
```
* Use a custom file listing command with:
```vim
let g:ctrlp_user_command = 'find %s -type f' " MacOSX/Linux
let g:ctrlp_user_command = 'dir %s /-n /b /s /a-d' " Windows
```
_Check [the docs][2] for more mappings, commands and options._
2011-08-21 22:14:00 -04:00
[1]: http://i.imgur.com/yIynr.png
[2]: https://github.com/kien/ctrlp.vim/blob/master/doc/ctrlp.txt
[3]: https://github.com/kien/ctrlp.vim/tree/extensions