vim/ctrlp.vim
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Kien N 2012-05-08 21:26:49 +07:00
parent 3e83d624bb
commit 9c9e120b81
1 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
readme.md
View File

@ -5,26 +5,27 @@ Full path fuzzy __file__, __buffer__, __mru__ and __tag__ finder for Vim.
* Full support for Vim’s regexp as search pattern. * Full support for Vim’s regexp as search pattern.
* Built-in Most Recently Used (MRU) files monitoring. * Built-in Most Recently Used (MRU) files monitoring.
* Built-in project’s root finder. * Built-in project’s root finder.
* Open Multiple Files. * Open multiple files at once.
* Create new files and directories.
* [Extensible][3]. * [Extensible][3].
![ctrlp][1] ![ctrlp][1]
## Basic Usage ## Basic Usage
* Press `<c-p>` or run `:CtrlP` to invoke CtrlP in find file mode. * Press `<c-p>` or run `:CtrlP [dir]` to invoke CtrlP in find file mode.
* Run `:CtrlPBuffer` or `:CtrlPMRU` to invoke CtrlP in buffer or MRU mode. * Run `:CtrlPBuffer` or `:CtrlPMRU` to invoke CtrlP in buffer or MRU mode.
* Or run `:CtrlPMixed` to search in a mix of files, buffers and MRU files. * Run `:CtrlPMixed` to search in a mix of files, buffers and MRU files.
Once CtrlP is open: Once CtrlP is open:
* Press `<c-f>` and `<c-b>` to switch between find file, buffer, and MRU file * Press `<c-f>` and `<c-b>` to cycle between modes.
modes.
* Press `<c-d>` to switch to filename only search instead of full path. * Press `<c-d>` to switch to filename only search instead of full path.
* Press `<c-r>` to switch to regexp mode. * Press `<c-r>` to switch to regexp mode.
* Press `<F5>` to purge the cache for the current directory and get new files. * Press `<F5>` to purge the cache for the current directory and get new files.
* End the input string with a colon `:` followed by a command to execute after * End the input string with a colon `:` followed by a command to execute it after
opening the file. opening the file:
e.g. `abc:45` will open the file matched the pattern and jump to line 45. Use `:45` to open selected file and jump to line 45.
Use `:difft` to open the marked files and run `:difft` on the first 4 files.
* Submit two dots `..` as the input string to go backward the directory tree by * Submit two dots `..` as the input string to go backward the directory tree by
1 level. 1 level.
* Use `<c-y>` to create a new file and its parent dirs. * Use `<c-y>` to create a new file and its parent dirs.
@ -37,15 +38,15 @@ e.g. `abc:45` will open the file matched the pattern and jump to line 45.
let g:ctrlp_map = '<c-p>' let g:ctrlp_map = '<c-p>'
``` ```
* When CtrlP is invoked, it automatically sets its local working directory * When invoked, unless a path is specified, CtrlP will automatically set its
according to this variable: local working directory according to this variable:
```vim ```vim
let g:ctrlp_working_path_mode = 2 let g:ctrlp_working_path_mode = 2
``` ```
0 - don’t manage working directory. 0 - don’t manage working directory.
1 - the parent directory of the current file. 1 - the directory of the current file.
2 - the nearest ancestor that contains one of these directories or files: 2 - the nearest ancestor that contains one of these directories or files:
`.git/` `.hg/` `.svn/` `.bzr/` `_darcs/` `.git/` `.hg/` `.svn/` `.bzr/` `_darcs/`
@ -64,13 +65,19 @@ option `wildignore` and/or the option `g:ctrlp_custom_ignore`. Examples:
\ } \ }
``` ```
* Use a custom file listing command with: * Use a custom file listing command:
```vim ```vim
let g:ctrlp_user_command = 'find %s -type f' " MacOSX/Linux let g:ctrlp_user_command = 'find %s -type f' " MacOSX/Linux
let g:ctrlp_user_command = 'dir %s /-n /b /s /a-d' " Windows let g:ctrlp_user_command = 'dir %s /-n /b /s /a-d' " Windows
``` ```
* Define an external matcher:
```vim
let g:ctrlp_match_func = {}
```
_Check [the docs][2] for more mappings, commands and options._ _Check [the docs][2] for more mappings, commands and options._
[1]: http://i.imgur.com/yIynr.png [1]: http://i.imgur.com/yIynr.png