diff vim/vimfiles/bundle/ctrlp.vim/readme.md @ 7:86e0ac713642

Re-added the latest ctrlp.vim plugin. The ctrlp.vim commit was e61e7d5b801ade5fcefeab3aca75c1f37d54bdf1.
author Brian Neal <bgneal@gmail.com>
date Sun, 29 Apr 2012 16:20:31 -0500
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/vim/vimfiles/bundle/ctrlp.vim/readme.md	Sun Apr 29 16:20:31 2012 -0500
@@ -0,0 +1,78 @@
+# ctrlp.vim
+Full path fuzzy __file__, __buffer__, __mru__ and __tag__ finder for Vim.
+
+* Written in pure Vimscript for MacVim and Vim 7.0+.
+* Full support for Vim’s regexp as search pattern.
+* Built-in Most Recently Used (MRU) files monitoring.
+* Built-in project’s root finder.
+* Open Multiple Files.
+* [Extensible][3].
+
+![ctrlp][1]
+
+## Basic Usage
+* Press `<c-p>` or run `:CtrlP` to invoke CtrlP in find file 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.
+
+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.
+* Press `<c-r>` to switch to regexp mode.
+* 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
+opening the file.  
+e.g. `abc:45` will open the file matched the pattern and jump to line 45.
+* 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 multiple files and `<c-o>` to open them.
+
+## Basic Options
+* Change the mapping to invoke CtrlP:
+
+    ```vim
+    let g:ctrlp_map = '<c-p>'
+    ```
+
+* When CtrlP is invoked, it automatically sets its local working directory
+according to this variable:
+
+    ```vim
+    let g:ctrlp_working_path_mode = 2
+    ```
+
+    0 - don’t manage working directory.  
+    1 - the parent directory of the current file.  
+    2 - the nearest ancestor that contains one of these directories or files:
+    `.git/` `.hg/` `.svn/` `.bzr/` `_darcs/`
+
+* If you want to exclude directories or files from the search, use the Vim’s
+option `wildignore` and/or the option `g:ctrlp_custom_ignore`. Examples:
+
+    ```vim
+    set wildignore+=*/tmp/*,*.so,*.swp,*.zip  " MacOSX/Linux
+    set wildignore+=tmp\*,*.swp,*.zip,*.exe   " Windows
+
+    let g:ctrlp_custom_ignore = '\.git$\|\.hg$\|\.svn$'
+    let g:ctrlp_custom_ignore = {
+      \ 'dir':  '\.git$\|\.hg$\|\.svn$',
+      \ 'file': '\.exe$\|\.so$\|\.dll$',
+      \ 'link': 'some_bad_symbolic_links',
+      \ }
+    ```
+
+* 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._
+
+[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