Permalink
Browse files

Update ctrlp.txt

  • Loading branch information...
1 parent 31ff4b9 commit af66338cb6ff366b436fc2cdcafbcdaefd44deb3 @kien committed Sep 6, 2012
Showing with 84 additions and 71 deletions.
  1. +84 −71 doc/ctrlp.txt
View
@@ -35,50 +35,50 @@ OPTIONS *ctrlp-options*
Overview:~
- |loaded_ctrlp| Disable the plugin.
- |ctrlp_map| Default mapping.
- |ctrlp_cmd| Default command used for the default mapping.
- |ctrlp_by_filename| Default to filename mode or not.
- |ctrlp_regexp| Default to regexp mode or not.
- |ctrlp_match_window_bottom| Where to show the match window.
- |ctrlp_match_window_reversed| Sort order in the match window.
- |ctrlp_max_height| Max height of the match window.
- |ctrlp_switch_buffer| Jump to an open buffer if already opened.
- |ctrlp_reuse_window| Reuse special windows (help, quickfix, etc).
- |ctrlp_tabpage_position| Where to put the new tab page.
- |ctrlp_working_path_mode| How to set CtrlP's local working directory.
- |ctrlp_root_markers| Additional, high priority root markers.
- |ctrlp_use_caching| Use per-session caching or not.
- |ctrlp_clear_cache_on_exit| Keep cache after exiting Vim or not.
- |ctrlp_cache_dir| Location of the cache directory.
- |ctrlp_dotfiles| Ignore dotfiles and dotdirs or not.
- |ctrlp_custom_ignore| Hide stuff when using |globpath()|.
- |ctrlp_max_files| Number of files to scan initially.
- |ctrlp_max_depth| Directory depth to recurse into when scanning.
- |ctrlp_user_command| Use an external scanner.
- |ctrlp_max_history| Number of entries saved in the prompt history.
- |ctrlp_open_new_file| How to open a file created by <c-y>.
- |ctrlp_open_multiple_files| How to open files selected by <c-z>.
- |ctrlp_arg_map| Intercept <c-y> and <c-o> or not.
- |ctrlp_follow_symlinks| Follow symbolic links or not.
- |ctrlp_lazy_update| Only update when typing has stopped.
- |ctrlp_default_input| Seed the prompt with an initial string.
- |ctrlp_use_migemo| Use Migemo patterns for Japanese filenames.
- |ctrlp_prompt_mappings| Change the mappings in the prompt.
+ |loaded_ctrlp|................Disable the plugin.
+ |ctrlp_map|...................Default mapping.
+ |ctrlp_cmd|...................Default command used for the default mapping.
+ |ctrlp_by_filename|...........Default to filename mode or not.
+ |ctrlp_regexp|................Default to regexp mode or not.
+ |ctrlp_match_window_bottom|...Where to show the match window.
+ |ctrlp_match_window_reversed|.Sort order in the match window.
+ |ctrlp_max_height|............Max height of the match window.
+ |ctrlp_switch_buffer|.........Jump to an open buffer if already opened.
+ |ctrlp_reuse_window|..........Reuse special windows (help, quickfix, etc).
+ |ctrlp_tabpage_position|......Where to put the new tab page.
+ |ctrlp_working_path_mode|.....How to set CtrlP's local working directory.
+ |ctrlp_root_markers|..........Additional, high priority root markers.
+ |ctrlp_use_caching|...........Use per-session caching or not.
+ |ctrlp_clear_cache_on_exit|...Keep cache after exiting Vim or not.
+ |ctrlp_cache_dir|.............Location of the cache directory.
+ |ctrlp_dotfiles|..............Ignore dotfiles and dotdirs or not.
+ |ctrlp_custom_ignore|.........Hide stuff when using |globpath()|.
+ |ctrlp_max_files|.............Number of files to scan initially.
+ |ctrlp_max_depth|.............Directory depth to recurse into when scanning.
+ |ctrlp_user_command|..........Use an external scanner.
+ |ctrlp_max_history|...........Number of entries saved in the prompt history.
+ |ctrlp_open_new_file|.........How to open a file created by <c-y>.
+ |ctrlp_open_multiple_files|...How to open files selected by <c-z>.
+ |ctrlp_arg_map|...............Intercept <c-y> and <c-o> or not.
+ |ctrlp_follow_symlinks|.......Follow symbolic links or not.
+ |ctrlp_lazy_update|...........Only update when typing has stopped.
+ |ctrlp_default_input|.........Seed the prompt with an initial string.
+ |ctrlp_use_migemo|............Use Migemo patterns for Japanese filenames.
+ |ctrlp_prompt_mappings|.......Change the mappings in the prompt.
MRU mode:
- |ctrlp_mruf_max| Max MRU entries to remember.
- |ctrlp_mruf_exclude| Files that shouldn't be remembered.
- |ctrlp_mruf_include| Files to be remembered.
- |ctrlp_mruf_relative| Show only MRU files in the working directory.
- |ctrlp_mruf_default_order| Disable sorting.
- |ctrlp_mruf_case_sensitive| MRU files are case sensitive or not.
+ |ctrlp_mruf_max|..............Max MRU entries to remember.
+ |ctrlp_mruf_exclude|..........Files that shouldn't be remembered.
+ |ctrlp_mruf_include|..........Files to be remembered.
+ |ctrlp_mruf_relative|.........Show only MRU files in the working directory.
+ |ctrlp_mruf_default_order|....Disable sorting.
+ |ctrlp_mruf_case_sensitive|...MRU files are case sensitive or not.
Advanced options:
- |ctrlp_open_func| Use custom file opening functions.
- |ctrlp_status_func| Change CtrlP's two statuslines.
- |ctrlp_buffer_func| Call custom functions in the CtrlP buffer.
- |ctrlp_match_func| Replace the built-in matching algorithm.
+ |ctrlp_open_func|.............Use custom file opening functions.
+ |ctrlp_status_func|...........Change CtrlP's two statuslines.
+ |ctrlp_buffer_func|...........Call custom functions in the CtrlP buffer.
+ |ctrlp_match_func|............Replace the built-in matching algorithm.
-------------------------------------------------------------------------------
Detailed descriptions and default values:~
@@ -134,9 +134,9 @@ try to jump to it instead of opening a new instance: >
<
e - jump when <cr> is pressed, but only to windows in the current tab.
t - jump when <c-t> is pressed, but only to windows in another tab.
- v - like e, but jump when <c-v> is pressed.
- h - like e, but jump when <c-x> is pressed.
- E, T, V, H - like e, t, v and h respectively, but jump to windows anywhere.
+ v - like "e", but jump when <c-v> is pressed.
+ h - like "e", but jump when <c-x> is pressed.
+ E, T, V, H - like "e", "t", "v", and "h", but jump to windows anywhere.
0 or <empty-string> - disable this feature.
*'g:ctrlp_reuse_window'*
@@ -166,16 +166,20 @@ variable: >
let g:ctrlp_working_path_mode = 'ra'
<
c - the directory of the current file.
+ a - like "c", but only applies when the current working directory outside of
+ CtrlP isn't a direct ancestor of the directory of the current file.
r - the nearest ancestor that contains one of these directories or files:
.git .hg .svn .bzr _darcs
- a - like c, but only if the current working directory outside of CtrlP is not
- a direct ancestor of the directory of the current file.
- 0 or <empty-string> - don't manage working directory.
+ w - begin finding a root from the current working directory outside of CtrlP
+ instead of from the directory of the current file (default). Only applies
+ when "r" is also present.
+ 0 or <empty-string> - disable this feature.
Note #1: you can use b:ctrlp_working_path_mode (a |b:var|) to set this option
on a per buffer basis.
-Note #2: with 'ra' or 'rc', use the behavior of a or c when a root isn't found.
+Note #2: with "ra" or "rc", use the behavior of "a" or "c" if a root can't be
+found.
*'g:ctrlp_root_markers'*
Use this to set your own root markers in addition to the default ones (.git,
@@ -191,6 +195,7 @@ Enable/Disable per-session caching: >
1 - Enable caching.
n - When bigger than 1, disable caching and use the number as the limit to
enable caching again.
+
Note: you can quickly purge the cache by pressing <F5> while inside CtrlP.
*'g:ctrlp_clear_cache_on_exit'*
@@ -208,6 +213,8 @@ Set the directory to store the cache files: >
Set this to 0 if you don't want CtrlP to scan for dotfiles and dotdirs: >
let g:ctrlp_dotfiles = 1
<
+Note: does not apply when a command defined with |g:ctrlp_user_command| is
+being used.
*'ctrlp-wildignore'*
You can use Vim's |'wildignore'| to exclude files and directories from the
@@ -230,10 +237,10 @@ CtrlP to not show. Use regexp to specify the patterns: >
let g:ctrlp_custom_ignore = ''
<
Examples: >
- let g:ctrlp_custom_ignore = '\v[\/](\.git|\.hg|\.svn)$'
+ let g:ctrlp_custom_ignore = '\v[\/]\.(git|hg|svn)$'
let g:ctrlp_custom_ignore = {
- \ 'dir': '\v[\/](\.git|\.hg|\.svn)$',
- \ 'file': '\.exe$\|\.so$\|\.dll$',
+ \ 'dir': '\v[\/]\.(git|hg|svn)$',
+ \ 'file': '\v\.(exe|so|dll)$',
\ 'link': 'SOME_BAD_SYMBOLIC_LINKS',
\ }
let g:ctrlp_custom_ignore = {
@@ -251,12 +258,15 @@ first or restart Vim to avoid the "E706: Variable type mismatch" error.
The maximum number of files to scan, set to 0 for no limit: >
let g:ctrlp_max_files = 10000
<
+Note: does not apply when a command defined with |g:ctrlp_user_command| is
+being used.
*'g:ctrlp_max_depth'*
The maximum depth of a directory tree to recurse into: >
let g:ctrlp_max_depth = 40
<
-Note: the larger these values, the more memory Vim uses.
+Note: does not apply when a command defined with |g:ctrlp_user_command| is
+being used.
*'g:ctrlp_user_command'*
Specify an external tool to use for listing files instead of using Vim's
@@ -330,14 +340,13 @@ Set to 0 to disable prompt's history. Browse the history with <c-n> and <c-p>.
*'g:ctrlp_open_new_file'*
Use this option to specify how the newly created file is to be opened when
-pressing <c-y>:
- t - in a new tab
- h - in a new horizontal split
- v - in a new vertical split
- r - in the current window
->
+pressing <c-y>: >
let g:ctrlp_open_new_file = 'v'
<
+ t - in a new tab.
+ h - in a new horizontal split.
+ v - in a new vertical split.
+ r - in the current window.
*'g:ctrlp_open_multiple_files'*
If non-zero, this will enable opening multiple files with <c-z> and <c-o>: >
@@ -358,7 +367,8 @@ For the letters:
i - all files as hidden buffers.
j - after opening, jump to the first opened tab or window.
r - open the first file in the current window, then the remaining files in
- new splits or new tabs depending on which of h, v and t is also present.
+ new splits or new tabs depending on which of "h", "v" and "t" is also
+ present.
*'g:ctrlp_arg_map'*
When this is set to 1, the <c-o> and <c-y> mappings will accept one extra key
@@ -384,6 +394,9 @@ If non-zero, CtrlP will follow symbolic links when listing files: >
1 - follow but ignore looped internal symlinks to avoid duplicates.
2 - follow all symlinks indiscriminately.
+Note: does not apply when a command defined with |g:ctrlp_user_command| is
+being used.
+
*'g:ctrlp_lazy_update'*
Set this to 1 to enable the lazy-update feature: only update the match window
after typing's been stopped for a certain amount of time: >
@@ -942,7 +955,7 @@ Available extensions:~
*:CtrlPTag*
* Tag mode:~
- Name: 'tag'
- - Command: ':CtrlPTag'
+ - Command: ":CtrlPTag"
- Search for a tag within a generated central tags file, and jump to the
definition. Use the Vim's option |'tags'| to specify the names and the
locations of the tags file(s).
@@ -952,21 +965,21 @@ Available extensions:~
*:CtrlPBufTagAll*
* Buffer Tag mode:~
- Name: 'buffertag'
- - Commands: ':CtrlPBufTag [buffer]',
- ':CtrlPBufTagAll'.
+ - Commands: ":CtrlPBufTag [buffer]",
+ ":CtrlPBufTagAll".
- Search for a tag within the current buffer or all listed buffers and jump
to the definition. Requires |exuberant_ctags| or compatible programs.
*:CtrlPQuickfix*
* Quickfix mode:~
- Name: 'quickfix'
- - Command: ':CtrlPQuickfix'
+ - Command: ":CtrlPQuickfix"
- Search for an entry in the current quickfix errors and jump to it.
*:CtrlPDir*
* Directory mode:~
- Name: 'dir'
- - Command: ':CtrlPDir [starting-directory]'
+ - Command: ":CtrlPDir [starting-directory]"
- Search for a directory and change the working directory to it.
- Mappings:
+ <cr> change the local working directory for CtrlP and keep it open.
@@ -978,42 +991,42 @@ Available extensions:~
*:CtrlPRTS*
* Runtime script mode:~
- Name: 'rtscript'
- - Command: ':CtrlPRTS'
+ - Command: ":CtrlPRTS"
- Search for files (vimscripts, docs, snippets...) in runtimepath.
*:CtrlPUndo*
* Undo mode:~
- Name: 'undo'
- - Command: ':CtrlPUndo'
+ - Command: ":CtrlPUndo"
- Browse undo history.
*:CtrlPLine*
* Line mode:~
- Name: 'line'
- - Command: ':CtrlPLine'
+ - Command: ":CtrlPLine"
- Search for a line in all listed buffers.
*:CtrlPChange*
*:CtrlPChangeAll*
* Change list mode:~
- Name: 'changes'
- - Commands: ':CtrlPChange [buffer]',
- ':CtrlPChangeAll'.
+ - Commands: ":CtrlPChange [buffer]",
+ ":CtrlPChangeAll".
- Search for and jump to a recent change in the current buffer or in all
listed buffers.
*:CtrlPMixed*
* Mixed mode:~
- Name: 'mixed'
- - Command: ':CtrlPMixed'
+ - Command: ":CtrlPMixed"
- Search in files, buffers and MRU files at the same time.
*:CtrlPBookmarkDir*
*:CtrlPBookmarkDirAdd*
* BookmarkDir mode:~
- Name: 'bookmarkdir'
- - Commands: ':CtrlPBookmarkDir',
- ':CtrlPBookmarkDirAdd [directory]'.
+ - Commands: ":CtrlPBookmarkDir",
+ ":CtrlPBookmarkDirAdd [directory]".
- Search for a bookmarked directory and change the working directory to it.
- Mappings:
+ <cr> change the local working directory for CtrlP, keep it open and

0 comments on commit af66338

Please sign in to comment.