ctrlp.vim/readme.md

88 lines
3.2 KiB
Markdown
Raw Normal View History

2011-09-05 19:45:33 -04:00
# ctrlp.vim
2012-06-18 12:03:42 -04:00
Full path fuzzy __file__, __buffer__, __mru__, __tag__, __...__ finder for Vim.
2011-09-05 19:30:54 -04:00
2012-06-14 00:36:21 -04:00
* Written in pure Vimscript for MacVim, gVim and Vim 7.0+.
* Full support for Vim's regexp as search patterns.
* Built-in Most Recently Used (MRU) files monitoring.
2012-06-14 00:36:21 -04:00
* Built-in project's root finder.
2012-05-08 10:26:49 -04:00
* Open multiple files at once.
* Create new files and directories.
2012-06-14 00:36:21 -04:00
* [Extensible][2].
2011-08-21 22:14:00 -04:00
![ctrlp][1]
2012-06-18 12:03:42 -04:00
## Basic Usage
* Run `:CtrlP` or `:CtrlP [starting-directory]` to invoke CtrlP in find file mode.
2012-06-19 12:45:00 -04:00
* Run `:CtrlPBuffer` or `:CtrlPMRU` to invoke CtrlP in find buffer or find MRU file mode.
* Run `:CtrlPMixed` to search in Files, Buffers and MRU files at the same time.
2012-06-14 00:36:21 -04:00
2012-06-19 12:45:00 -04:00
Check `:help ctrlp-commands` and `:help ctrlp-extensions` for other commands.
2012-06-14 00:36:21 -04:00
2012-06-18 12:03:42 -04:00
##### Once CtrlP is open:
* Press `<c-f>` and `<c-b>` to cycle between modes.
* Press `<c-d>` to switch to filename only search instead of full path.
* Press `<c-r>` to switch to regexp mode.
* Press `<F5>` to purge the cache for the current directory and get new files.
* Use `<c-n>`, `<c-p>` to select the next/previous string in the prompt's history.
* Use `<c-y>` to create a new file and its parent directories.
* Use `<c-z>` to mark/unmark multiple files and `<c-o>` to open them.
2012-06-14 00:36:21 -04:00
2012-06-19 12:45:00 -04:00
Run `:help ctrlp-mappings` or submit `?` in CtrlP for more mapping help.
2012-06-14 00:36:21 -04:00
2012-06-18 12:03:42 -04:00
* Submit two or more dots `..` to go up the directory tree by one or multiple levels.
* End the input string with a colon `:` followed by a command to execute it on the opening file(s):
2012-06-19 12:45:00 -04:00
Use `:25` to jump to line 25.
2012-06-18 12:03:42 -04:00
Use `:/any\:\ string` to jump to the first instance of `any: string`.
2012-06-19 12:45:00 -04:00
Use `:difft` when opening multiple files to run `:difft` on the first 4 files.
2012-06-14 00:36:21 -04:00
2012-06-18 12:03:42 -04:00
## Basic Options
2012-06-19 12:45:00 -04:00
* Change the default mapping and the default command to invoke CtrlP:
```vim
let g:ctrlp_map = '<c-p>'
let g:ctrlp_cmd = 'CtrlP'
```
2012-06-18 12:03:42 -04:00
* When invoked, unless a starting directory is specified, CtrlP will set its local 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
2012-06-14 00:36:21 -04:00
0 - don't manage working directory.
2012-05-08 10:26:49 -04:00
1 - the directory of the current file.
2 - the nearest ancestor that contains one of these directories or files:
2012-06-14 00:36:21 -04:00
`.git` `.hg` `.svn` `.bzr` `_darcs`
Define additional root markers with the `g:ctrlp_root_markers` option.
2011-09-05 19:47:40 -04:00
2012-06-19 12:45:00 -04:00
* Exclude files and directories using Vim's `wildignore` and CtrlP's own `g:ctrlp_custom_ignore`:
2011-09-11 18:49:42 -04:00
```vim
2012-03-03 10:31:50 -05:00
set wildignore+=*/tmp/*,*.so,*.swp,*.zip " MacOSX/Linux
set wildignore+=tmp\*,*.swp,*.zip,*.exe " Windows
2012-06-19 12:45:00 -04:00
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
```
2012-05-08 10:26:49 -04:00
* Use a custom file listing command:
```vim
2012-03-03 10:31:50 -05:00
let g:ctrlp_user_command = 'find %s -type f' " MacOSX/Linux
let g:ctrlp_user_command = 'dir %s /-n /b /s /a-d' " Windows
```
2012-06-19 12:45:00 -04:00
Check `:help ctrlp-options` for other options.
## Installation
Use your favorite method or check the homepage for a [quick installation guide][3].
2011-08-21 22:14:00 -04:00
[1]: http://i.imgur.com/yIynr.png
2012-06-14 00:36:21 -04:00
[2]: https://github.com/kien/ctrlp.vim/tree/extensions
2012-06-18 12:03:42 -04:00
[3]: http://kien.github.com/ctrlp.vim