bgneal@7: *ctrlp.txt*       Fuzzy file, buffer, mru and tag finder. v1.7.6
bgneal@7: *CtrlP* *ControlP* *'ctrlp'* *'ctrl-p'*
bgneal@7: ===============================================================================
bgneal@7: #                                                                             #
bgneal@7: #          :::::::: ::::::::::: :::::::::  :::             :::::::::          #
bgneal@7: #         :+:    :+:    :+:     :+:    :+: :+:             :+:    :+:         #
bgneal@7: #         +:+           +:+     +:+    +:+ +:+             +:+    +:+         #
bgneal@7: #         +#+           +#+     +#++:++#:  +#+             +#++:++#+          #
bgneal@7: #         +#+           +#+     +#+    +#+ +#+             +#+                #
bgneal@7: #         #+#    #+#    #+#     #+#    #+# #+#             #+#                #
bgneal@7: #          ########     ###     ###    ### ##########      ###                #
bgneal@7: #                                                                             #
bgneal@7: ===============================================================================
bgneal@7: CONTENTS                                                       *ctrlp-contents*
bgneal@7: 
bgneal@7:     1. Intro........................................|ctrlp-intro|
bgneal@7:     2. Options......................................|ctrlp-options|
bgneal@7:     3. Commands.....................................|ctrlp-commands|
bgneal@7:     4. Mappings.....................................|ctrlp-mappings|
bgneal@7:     5. Input Formats................................|ctrlp-input-formats|
bgneal@7:     6. Extensions...................................|ctrlp-extensions|
bgneal@7: 
bgneal@7: ===============================================================================
bgneal@7: INTRO                                                             *ctrlp-intro*
bgneal@7: 
bgneal@7: Full path fuzzy file, buffer, mru and tag finder with an intuitive interface.
bgneal@7: Written in pure Vimscript for MacVim and Vim version 7.0+. Has full support for
bgneal@7: Vim’s |regexp| as search pattern, built-in MRU files monitoring, project’s root
bgneal@7: finder, and more.
bgneal@7: 
bgneal@7: To enable optional extensions (tag, dir, rtscript...), see |ctrlp-extensions|.
bgneal@7: 
bgneal@7: ===============================================================================
bgneal@7: OPTIONS                                                         *ctrlp-options*
bgneal@7: 
bgneal@7: Overview:~
bgneal@7: 
bgneal@7:   |loaded_ctrlp|                Disable the plugin.
bgneal@7:   |ctrlp_map|                   Default mapping.
bgneal@7:   |ctrlp_cmd|                   Default command used for the default mapping.
bgneal@7:   |ctrlp_by_filename|           Default to filename mode or not.
bgneal@7:   |ctrlp_regexp|                Default to regexp mode or not.
bgneal@7:   |ctrlp_match_window_bottom|   Where to show the match window.
bgneal@7:   |ctrlp_match_window_reversed| Sort order in the match window.
bgneal@7:   |ctrlp_max_height|            Max height of the match window.
bgneal@7:   |ctrlp_switch_buffer|         Jump to an open buffer if already opened.
bgneal@7:   |ctrlp_reuse_window|          Reuse special windows (help, quickfix, etc).
bgneal@7:   |ctrlp_working_path_mode|     How to set CtrlP’s local working directory.
bgneal@7:   |ctrlp_root_markers|          Additional, high priority root markers.
bgneal@7:   |ctrlp_use_caching|           Use per-session caching or not.
bgneal@7:   |ctrlp_clear_cache_on_exit|   Keep cache after exiting Vim or not.
bgneal@7:   |ctrlp_cache_dir|             Location of the cache directory.
bgneal@7:   |ctrlp_dotfiles|              Ignore dotfiles and dotdirs or not.
bgneal@7:   |ctrlp_custom_ignore|         Hide stuff when using |globpath()|.
bgneal@7:   |ctrlp_max_files|             Number of files to scan initially.
bgneal@7:   |ctrlp_max_depth|             Directory depth to recurse into when scanning.
bgneal@7:   |ctrlp_user_command|          Use an external scanner.
bgneal@7:   |ctrlp_max_history|           Number of entries saved in the prompt history.
bgneal@7:   |ctrlp_open_new_file|         How to open a file created by <c-y>.
bgneal@7:   |ctrlp_open_multiple_files|   How to open files selected by <c-z>.
bgneal@7:   |ctrlp_arg_map|               Intercept <c-y> and <c-o> or not.
bgneal@7:   |ctrlp_follow_symlinks|       Follow symbolic links or not.
bgneal@7:   |ctrlp_lazy_update|           Only update when typing has stopped.
bgneal@7:   |ctrlp_default_input|         Seed the prompt with an initial string.
bgneal@7:   |ctrlp_use_migemo|            Use Migemo patterns for Japanese filenames.
bgneal@7:   |ctrlp_prompt_mappings|       Change the mappings in the prompt.
bgneal@7: 
bgneal@7:   MRU mode:
bgneal@7:   |ctrlp_mruf_max|              Max MRU entries to remember.
bgneal@7:   |ctrlp_mruf_exclude|          Files that shouldn’t be remembered.
bgneal@7:   |ctrlp_mruf_include|          Files to be remembered.
bgneal@7:   |ctrlp_mruf_relative|         Show only MRU files in the working directory.
bgneal@7:   |ctrlp_mruf_default_order|    Disable sorting.
bgneal@7:   |ctrlp_mruf_case_sensitive|   MRU files are case sensitive or not.
bgneal@7: 
bgneal@7:   Advanced options:
bgneal@7:   |ctrlp_status_func|           Change CtrlP’s two statuslines.
bgneal@7:   |ctrlp_buffer_func|           Call custom functions in the CtrlP buffer.
bgneal@7:   |ctrlp_match_func|            Replace the built-in matching algorithm.
bgneal@7: 
bgneal@7: -------------------------------------------------------------------------------
bgneal@7: Detailed descriptions and default values:~
bgneal@7: 
bgneal@7:                                                                 *'g:ctrlp_map'*
bgneal@7: Use this option to change the mapping to invoke CtrlP in |Normal| mode: >
bgneal@7:   let g:ctrlp_map = '<c-p>'
bgneal@7: <
bgneal@7: 
bgneal@7:                                                                 *'g:ctrlp_cmd'*
bgneal@7: Set the default opening command to use when pressing the above mapping: >
bgneal@7:   let g:ctrlp_cmd = 'CtrlP'
bgneal@7: <
bgneal@7: 
bgneal@7:                                                              *'g:loaded_ctrlp'*
bgneal@7: Use this to disable the plugin completely: >
bgneal@7:   let g:loaded_ctrlp = 1
bgneal@7: <
bgneal@7: 
bgneal@7:                                                         *'g:ctrlp_by_filename'*
bgneal@7: Set this to 1 to set searching by filename (as opposed to full path) as the
bgneal@7: default: >
bgneal@7:   let g:ctrlp_by_filename = 0
bgneal@7: <
bgneal@7: Can be toggled on/off by pressing <c-d> inside the prompt.
bgneal@7: 
bgneal@7:                                                              *'g:ctrlp_regexp'*
bgneal@7: Set this to 1 to set regexp search as the default: >
bgneal@7:   let g:ctrlp_regexp = 0
bgneal@7: <
bgneal@7: Can be toggled on/off by pressing <c-r> inside the prompt.
bgneal@7: 
bgneal@7:                                                 *'g:ctrlp_match_window_bottom'*
bgneal@7: Set this to 0 to show the match window at the top of the screen: >
bgneal@7:   let g:ctrlp_match_window_bottom = 1
bgneal@7: <
bgneal@7: 
bgneal@7:                                               *'g:ctrlp_match_window_reversed'*
bgneal@7: Change the listing order of the files in the match window. The default setting
bgneal@7: (1) is from bottom to top: >
bgneal@7:   let g:ctrlp_match_window_reversed = 1
bgneal@7: <
bgneal@7: 
bgneal@7:                                                          *'g:ctrlp_max_height'*
bgneal@7: Set the maximum height of the match window: >
bgneal@7:   let g:ctrlp_max_height = 10
bgneal@7: <
bgneal@7: 
bgneal@7:                                                       *'g:ctrlp_switch_buffer'*
bgneal@7: When opening a file with <cr> or <c-t>, if the file’s already opened somewhere
bgneal@7: CtrlP will try to jump to it instead of opening a new instance: >
bgneal@7:   let g:ctrlp_switch_buffer = 2
bgneal@7: <
bgneal@7:   1 - only jump to the buffer if it’s opened in the current tab.
bgneal@7:   2 - jump tab as well if the buffer’s opened in another tab.
bgneal@7:   0 - disable this feature.
bgneal@7: 
bgneal@7:                                                        *'g:ctrlp_reuse_window'*
bgneal@7: When opening a file with <cr>, CtrlP avoids opening it in windows created by
bgneal@7: plugins, help and quickfix. Use this to setup some exceptions: >
bgneal@7:   let g:ctrlp_reuse_window = 'netrw'
bgneal@7: <
bgneal@7: Acceptable values are partial name, filetype or buftype of the special buffers.
bgneal@7: Use regexp to specify the pattern.
bgneal@7: Example: >
bgneal@7:   let g:ctrlp_reuse_window = 'netrw\|help\|quickfix'
bgneal@7: <
bgneal@7: 
bgneal@7:                                                   *'g:ctrlp_working_path_mode'*
bgneal@7: When starting up, CtrlP sets its local working directory according to this
bgneal@7: variable: >
bgneal@7:   let g:ctrlp_working_path_mode = 2
bgneal@7: <
bgneal@7:   1 - the parent directory of the current file.
bgneal@7:   2 - the nearest ancestor that contains one of these directories or files:
bgneal@7:       .git/ .hg/ .svn/ .bzr/ _darcs/
bgneal@7:   0 - don’t manage working directory.
bgneal@7: Note: you can use b:ctrlp_working_path_mode (a |b:var|) to set this option on a
bgneal@7: per buffer basis.
bgneal@7: 
bgneal@7:                                                        *'g:ctrlp_root_markers'*
bgneal@7: Use this to set your own root markers in addition to the default ones (.git/,
bgneal@7: .hg/, .svn/, .bzr/, and _darcs/). Your markers will take precedence: >
bgneal@7:   let g:ctrlp_root_markers = ['']
bgneal@7: <
bgneal@7: 
bgneal@7:                                                         *'g:ctrlp_use_caching'*
bgneal@7: Set this to 0 to disable per-session caching. When disabled, caching will still
bgneal@7: be enabled for directories that have more than 4000 files: >
bgneal@7:   let g:ctrlp_use_caching = 1
bgneal@7: <
bgneal@7: Note: you can quickly purge the cache by pressing <F5> while inside CtrlP.
bgneal@7: 
bgneal@7:                                                 *'g:ctrlp_clear_cache_on_exit'*
bgneal@7: Set this to 0 to enable cross-session caching by not deleting the cache files
bgneal@7: upon exiting Vim: >
bgneal@7:   let g:ctrlp_clear_cache_on_exit = 1
bgneal@7: <
bgneal@7: 
bgneal@7:                                                           *'g:ctrlp_cache_dir'*
bgneal@7: Set the directory to store the cache files: >
bgneal@7:   let g:ctrlp_cache_dir = $HOME.'/.cache/ctrlp'
bgneal@7: <
bgneal@7: 
bgneal@7:                                                            *'g:ctrlp_dotfiles'*
bgneal@7: Set this to 0 if you don’t want CtrlP to scan for dotfiles and dotdirs: >
bgneal@7:   let g:ctrlp_dotfiles = 1
bgneal@7: <
bgneal@7: You can use |'wildignore'| to exclude anything from the search.
bgneal@7: Examples: >
bgneal@7:   " Excluding version control directories
bgneal@7:   set wildignore+=*/.git/*,*/.hg/*,*/.svn/*  " Linux/MacOSX
bgneal@7:   set wildignore+=.git\*,.hg\*,.svn\*        " Windows
bgneal@7: <
bgneal@7: Note #1: the `*/` in front of each directory glob is required.
bgneal@7: 
bgneal@7: Note #2: |wildignore| influences the result of |expand()|, |globpath()| and
bgneal@7: |glob()| which many plugins use to find stuff on the system (e.g. VCS related
bgneal@7: plugins look for .git/, .hg/,... some other plugins look for external *.exe
bgneal@7: tools on Windows). So be a little mindful of what you put in your |wildignore|.
bgneal@7: 
bgneal@7:                                                       *'g:ctrlp_custom_ignore'*
bgneal@7: In addition to |'wildignore'|, use this for files and directories you want only
bgneal@7: CtrlP to not show. Use regexp to specify the patterns: >
bgneal@7:   let g:ctrlp_custom_ignore = ''
bgneal@7: <
bgneal@7: Examples: >
bgneal@7:   let g:ctrlp_custom_ignore = '\.git$\|\.hg$\|\.svn$'
bgneal@7:   let g:ctrlp_custom_ignore = {
bgneal@7:     \ 'dir':  '\.git$\|\.hg$\|\.svn$',
bgneal@7:     \ 'file': '\.exe$\|\.so$\|\.dll$',
bgneal@7:     \ 'link': 'SOME_BAD_SYMBOLIC_LINKS',
bgneal@7:     \ }
bgneal@7: <
bgneal@7: Note: ignoring only works when |globpath()| is used to scan for files.
bgneal@7: 
bgneal@7:                                                           *'g:ctrlp_max_files'*
bgneal@7: The maximum number of files to scan, set to 0 for no limit: >
bgneal@7:   let g:ctrlp_max_files = 10000
bgneal@7: <
bgneal@7: 
bgneal@7:                                                           *'g:ctrlp_max_depth'*
bgneal@7: The maximum depth of a directory tree to recurse into: >
bgneal@7:   let g:ctrlp_max_depth = 40
bgneal@7: <
bgneal@7: Note: the larger these values, the more memory Vim uses.
bgneal@7: 
bgneal@7:                                                        *'g:ctrlp_user_command'*
bgneal@7: Specify an external tool to use for listing files instead of using Vim’s
bgneal@7: |globpath()|. Use %s in place of the target directory: >
bgneal@7:   let g:ctrlp_user_command = ''
bgneal@7: <
bgneal@7: Examples: >
bgneal@7:   let g:ctrlp_user_command = 'find %s -type f'       " MacOSX/Linux
bgneal@7:   let g:ctrlp_user_command = 'dir %s /-n /b /s /a-d' " Windows
bgneal@7: <
bgneal@7: You can also use 'grep', 'findstr' or something else to filter the results.
bgneal@7: Examples: >
bgneal@7:   let g:ctrlp_user_command = 'find %s -type f | grep (?!tmp/.*)'
bgneal@7:   let g:ctrlp_user_command = 'dir %s /-n /b /s /a-d | findstr .*\.py$'
bgneal@7: <
bgneal@7: Use a version control listing command when inside a repository, this is faster
bgneal@7: when scanning large projects: >
bgneal@7:   let g:ctrlp_user_command = [root_marker, listing_command, fallback_command]
bgneal@7:   let g:ctrlp_user_command = {
bgneal@7:     \ 'types': {
bgneal@7:       \ 1: [root_marker_1, listing_command_1],
bgneal@7:       \ n: [root_marker_n, listing_command_n],
bgneal@7:       \ },
bgneal@7:     \ 'fallback': fallback_command
bgneal@7:     \ }
bgneal@7: <
bgneal@7: Examples: >
bgneal@7:   let g:ctrlp_user_command = ['.git/', 'cd %s && git ls-files']
bgneal@7:   let g:ctrlp_user_command = ['.hg/', 'hg --cwd %s locate -I .']
bgneal@7:   let g:ctrlp_user_command = {
bgneal@7:     \ 'types': {
bgneal@7:       \ 1: ['.git/', 'cd %s && git ls-files'],
bgneal@7:       \ 2: ['.hg/', 'hg --cwd %s locate -I .'],
bgneal@7:       \ },
bgneal@7:     \ 'fallback': 'find %s -type f'
bgneal@7:     \ }
bgneal@7: <
bgneal@7: If the fallback_command is empty or not defined, |globpath()| will then be used
bgneal@7: when searching outside a repo.
bgneal@7: 
bgneal@7:                                                         *'g:ctrlp_max_history'*
bgneal@7: The maximum number of input strings you want CtrlP to remember. The default
bgneal@7: value mirrors Vim’s global |'history'| option: >
bgneal@7:   let g:ctrlp_max_history = &history
bgneal@7: <
bgneal@7: Set to 0 to disable prompt’s history. Browse the history with <c-n> and <c-p>.
bgneal@7: 
bgneal@7:                                                       *'g:ctrlp_open_new_file'*
bgneal@7: Use this option to specify how the newly created file is to be opened when
bgneal@7: pressing <c-y>:
bgneal@7:   t - in a new tab
bgneal@7:   h - in a new horizontal split
bgneal@7:   v - in a new vertical split
bgneal@7:   r - in the current window
bgneal@7: >
bgneal@7:   let g:ctrlp_open_new_file = 'v'
bgneal@7: <
bgneal@7: 
bgneal@7:                                                 *'g:ctrlp_open_multiple_files'*
bgneal@7: If non-zero, this will enable opening multiple files with <c-z> and <c-o>: >
bgneal@7:   let g:ctrlp_open_multiple_files = 'v'
bgneal@7: <
bgneal@7: Example: >
bgneal@7:   let g:ctrlp_open_multiple_files = '2vr'
bgneal@7: <
bgneal@7: For the number:
bgneal@7:   - If given, it’ll be used as the maximum number of windows or tabs to create
bgneal@7:     when opening the files (the rest will be opened as hidden buffers).
bgneal@7:   - If not given, <c-o> will open all files, each in a new window or new tab.
bgneal@7: For the letters:
bgneal@7:   t - each file in a new tab.
bgneal@7:   h - each file in a new horizontal split.
bgneal@7:   v - each file in a new vertical split.
bgneal@7:   Reuse the current window:
bgneal@7:   tr,
bgneal@7:   hr,
bgneal@7:   vr - open the first file in the current window, then the remaining files in
bgneal@7:        new splits or new tabs just like with t, h, v.
bgneal@7: 
bgneal@7:                                                             *'g:ctrlp_arg_map'*
bgneal@7: When this is set to 1, the <c-o> and <c-y> mappings will accept one extra key
bgneal@7: as an argument to override their default behavior: >
bgneal@7:   let g:ctrlp_arg_map = 0
bgneal@7: <
bgneal@7: Pressing <c-o> or <c-y> will then prompt for a keypress. The key can be:
bgneal@7:   t - open in tab(s)
bgneal@7:   h - open in horizontal split(s)
bgneal@7:   v - open in vertical split(s)
bgneal@7:   r - open in current window (for <c-y> only)
bgneal@7:   <esc>, <c-c>, <c-g> - cancel and go back to the prompt.
bgneal@7:   <cr> - use the default behavior specified with |g:ctrlp_open_new_file| and
bgneal@7:   |g:ctrlp_open_multiple_files|.
bgneal@7: 
bgneal@7:                                                     *'g:ctrlp_follow_symlinks'*
bgneal@7: Set this to 1 to follow symbolic links when listing files: >
bgneal@7:   let g:ctrlp_follow_symlinks = 0
bgneal@7: <
bgneal@7: When enabled, looped internal symlinks will be ignored to avoid duplicates.
bgneal@7: 
bgneal@7:                                                         *'g:ctrlp_lazy_update'*
bgneal@7: Set this to 1 to enable the lazy-update feature: only update the match window
bgneal@7: after typing’s been stopped for a certain amount of time: >
bgneal@7:   let g:ctrlp_lazy_update = 0
bgneal@7: <
bgneal@7: If is 1, update after 250ms. If bigger than 1, the number will be used as the
bgneal@7: delay time in milliseconds.
bgneal@7: 
bgneal@7:                                                       *'g:ctrlp_default_input'*
bgneal@7: Set this to 1 to enable seeding the prompt with the current file’s relative
bgneal@7: path: >
bgneal@7:   let g:ctrlp_default_input = 0
bgneal@7: <
bgneal@7: 
bgneal@7:                                                          *'g:ctrlp_use_migemo'*
bgneal@7: Set this to 1 to use Migemo Pattern for Japanese filenames. Migemo Search only
bgneal@7: works in regexp mode. To split the pattern, separate words with space: >
bgneal@7:   let g:ctrlp_use_migemo = 0
bgneal@7: <
bgneal@7: 
bgneal@7:                                                     *'g:ctrlp_prompt_mappings'*
bgneal@7: Use this to customize the mappings inside CtrlP’s prompt to your liking. You
bgneal@7: only need to keep the lines that you’ve changed the values (inside []): >
bgneal@7:   let g:ctrlp_prompt_mappings = {
bgneal@7:     \ 'PrtBS()':              ['<bs>', '<c-]>'],
bgneal@7:     \ 'PrtDelete()':          ['<del>'],
bgneal@7:     \ 'PrtDeleteWord()':      ['<c-w>'],
bgneal@7:     \ 'PrtClear()':           ['<c-u>'],
bgneal@7:     \ 'PrtSelectMove("j")':   ['<c-j>', '<down>'],
bgneal@7:     \ 'PrtSelectMove("k")':   ['<c-k>', '<up>'],
bgneal@7:     \ 'PrtSelectMove("t")':   ['<Home>', '<kHome>'],
bgneal@7:     \ 'PrtSelectMove("b")':   ['<End>', '<kEnd>'],
bgneal@7:     \ 'PrtSelectMove("u")':   ['<PageUp>', '<kPageUp>'],
bgneal@7:     \ 'PrtSelectMove("d")':   ['<PageDown>', '<kPageDown>'],
bgneal@7:     \ 'PrtHistory(-1)':       ['<c-n>'],
bgneal@7:     \ 'PrtHistory(1)':        ['<c-p>'],
bgneal@7:     \ 'AcceptSelection("e")': ['<cr>', '<2-LeftMouse>'],
bgneal@7:     \ 'AcceptSelection("h")': ['<c-x>', '<c-cr>', '<c-s>'],
bgneal@7:     \ 'AcceptSelection("t")': ['<c-t>'],
bgneal@7:     \ 'AcceptSelection("v")': ['<c-v>', '<RightMouse>'],
bgneal@7:     \ 'ToggleFocus()':        ['<s-tab>'],
bgneal@7:     \ 'ToggleRegex()':        ['<c-r>'],
bgneal@7:     \ 'ToggleByFname()':      ['<c-d>'],
bgneal@7:     \ 'ToggleType(1)':        ['<c-f>', '<c-up>'],
bgneal@7:     \ 'ToggleType(-1)':       ['<c-b>', '<c-down>'],
bgneal@7:     \ 'PrtExpandDir()':       ['<tab>'],
bgneal@7:     \ 'PrtInsert("c")':       ['<MiddleMouse>', '<insert>'],
bgneal@7:     \ 'PrtInsert()':          ['<c-\>'],
bgneal@7:     \ 'PrtCurStart()':        ['<c-a>'],
bgneal@7:     \ 'PrtCurEnd()':          ['<c-e>'],
bgneal@7:     \ 'PrtCurLeft()':         ['<c-h>', '<left>', '<c-^>'],
bgneal@7:     \ 'PrtCurRight()':        ['<c-l>', '<right>'],
bgneal@7:     \ 'PrtClearCache()':      ['<F5>'],
bgneal@7:     \ 'PrtDeleteEnt()':       ['<F7>'],
bgneal@7:     \ 'CreateNewFile()':      ['<c-y>'],
bgneal@7:     \ 'MarkToOpen()':         ['<c-z>'],
bgneal@7:     \ 'OpenMulti()':          ['<c-o>'],
bgneal@7:     \ 'PrtExit()':            ['<esc>', '<c-c>', '<c-g>'],
bgneal@7:     \ }
bgneal@7: <
bgneal@7: Note: In some terminals, it’s not possible to remap <c-h> without also changing
bgneal@7: <bs> (|keycodes|). So if pressing <bs> moves the cursor to the left instead of
bgneal@7: deleting a char for you, add this to your |.vimrc| to disable the plugin’s
bgneal@7: default <c-h> mapping: >
bgneal@7:   let g:ctrlp_prompt_mappings = { 'PrtCurLeft()': ['<left>', '<c-^>'] }
bgneal@7: <
bgneal@7: 
bgneal@7: ----------------------------------------
bgneal@7: MRU mode options:~
bgneal@7: 
bgneal@7:                                                            *'g:ctrlp_mruf_max'*
bgneal@7: Specify the number of recently opened files you want CtrlP to remember: >
bgneal@7:   let g:ctrlp_mruf_max = 250
bgneal@7: <
bgneal@7: 
bgneal@7:                                                        *'g:ctrlp_mruf_exclude'*
bgneal@7: Files you don’t want CtrlP to remember. Use regexp to specify the patterns: >
bgneal@7:   let g:ctrlp_mruf_exclude = ''
bgneal@7: <
bgneal@7: Examples: >
bgneal@7:   let g:ctrlp_mruf_exclude = '/tmp/.*\|/temp/.*' " MacOSX/Linux
bgneal@7:   let g:ctrlp_mruf_exclude = '^C:\\dev\\tmp\\.*' " Windows
bgneal@7: <
bgneal@7: 
bgneal@7:                                                        *'g:ctrlp_mruf_include'*
bgneal@7: And if you want CtrlP to only remember some files, specify them here: >
bgneal@7:   let g:ctrlp_mruf_include = ''
bgneal@7: <
bgneal@7: Example: >
bgneal@7:   let g:ctrlp_mruf_include = '\.py$\|\.rb$'
bgneal@7: <
bgneal@7: 
bgneal@7:                                                       *'g:ctrlp_mruf_relative'*
bgneal@7: Set this to 1 to show only MRU files in the current working directory: >
bgneal@7:   let g:ctrlp_mruf_relative = 0
bgneal@7: <
bgneal@7: 
bgneal@7:                                                  *'g:ctrlp_mruf_default_order'*
bgneal@7: Set this to 1 to disable sorting when searching in MRU mode: >
bgneal@7:   let g:ctrlp_mruf_default_order = 0
bgneal@7: <
bgneal@7: 
bgneal@7:                                                 *'g:ctrlp_mruf_case_sensitive'*
bgneal@7: Match this with your file system case-sensitivity setting to avoid duplicate
bgneal@7: MRU entries: >
bgneal@7:   let g:ctrlp_mruf_case_sensitive = 1
bgneal@7: <
bgneal@7: 
bgneal@7: ----------------------------------------
bgneal@7: Advanced options:~
bgneal@7: 
bgneal@7:                                                         *'g:ctrlp_status_func'*
bgneal@7: Use this to customize the statuslines for the CtrlP window: >
bgneal@7:   let g:ctrlp_status_func = {}
bgneal@7: <
bgneal@7: Example: >
bgneal@7:   let g:ctrlp_status_func = {
bgneal@7:     \ 'main': 'Function_Name_1',
bgneal@7:     \ 'prog': 'Function_Name_2',
bgneal@7:     \ }
bgneal@7: <
bgneal@7: Structure of the functions: >
bgneal@7:   " Main statusline
bgneal@7:   function! Function_Name_1(focus, byfname, regex, prev, item, next, marked)
bgneal@7:     " Arguments:
bgneal@7:     " |
bgneal@7:     " +- a:focus   : The focus of the prompt: "prt" or "win".
bgneal@7:     " |
bgneal@7:     " +- a:byfname : In filename mode or in full path mode: "file" or "path".
bgneal@7:     " |
bgneal@7:     " +- a:regex   : In regex mode: 1 or 0.
bgneal@7:     " |
bgneal@7:     " +- a:prev    : The previous search mode.
bgneal@7:     " |
bgneal@7:     " +- a:item    : The current search mode.
bgneal@7:     " |
bgneal@7:     " +- a:next    : The next search mode.
bgneal@7:     " |
bgneal@7:     " +- a:marked  : The number of marked files, or a comma separated list of
bgneal@7:     "                the filenames.
bgneal@7: 
bgneal@7:     return full_statusline
bgneal@7:   endfunction
bgneal@7: 
bgneal@7:   " Progress statusline
bgneal@7:   function! Function_Name_2(str)
bgneal@7:     " a:str : Either the number of files scanned so far, or a string indicating
bgneal@7:     "         the current directory is being scanned with a user_command.
bgneal@7: 
bgneal@7:     return full_statusline
bgneal@7:   endfunction
bgneal@7: <
bgneal@7: See https://gist.github.com/1610859 for a working example.
bgneal@7: 
bgneal@7:                                                         *'g:ctrlp_buffer_func'*
bgneal@7: Specify the functions that will be called after entering and before exiting the
bgneal@7: CtrlP buffer: >
bgneal@7:   let g:ctrlp_buffer_func = {}
bgneal@7: <
bgneal@7: Example: >
bgneal@7:   let g:ctrlp_buffer_func = {
bgneal@7:     \ 'enter': 'Function_Name_1',
bgneal@7:     \ 'exit':  'Function_Name_2',
bgneal@7:     \ }
bgneal@7: <
bgneal@7: 
bgneal@7:                                                          *'g:ctrlp_match_func'*
bgneal@7: Set an external fuzzy matching function for CtrlP to use: >
bgneal@7:   let g:ctrlp_match_func = {}
bgneal@7: <
bgneal@7: Example: >
bgneal@7:   let g:ctrlp_match_func = { 'match': 'Function_Name' }
bgneal@7: <
bgneal@7: Structure of the function: >
bgneal@7:   function! Function_Name(items, str, limit, mmode, ispath, crfile, regex)
bgneal@7:     " Arguments:
bgneal@7:     " |
bgneal@7:     " +- a:items  : The full list of items to search in.
bgneal@7:     " |
bgneal@7:     " +- a:str    : The string entered by the user.
bgneal@7:     " |
bgneal@7:     " +- a:limit  : The max height of the match window. Can be used to limit
bgneal@7:     " |             the number of items to return.
bgneal@7:     " |
bgneal@7:     " +- a:mmode  : The match mode. Can be one of these strings:
bgneal@7:     " |             + "full-line": match the entire line.
bgneal@7:     " |             + "filename-only": match only the filename.
bgneal@7:     " |             + "first-non-tab": match until the first tab char.
bgneal@7:     " |             + "until-last-tab": match until the last tab char.
bgneal@7:     " |
bgneal@7:     " +- a:ispath : Is 1 when searching in file, buffer, mru, dir, and rtscript
bgneal@7:     " |             modes. Is 0 otherwise.
bgneal@7:     " |
bgneal@7:     " +- a:crfile : The file in the current window. Should be excluded from the
bgneal@7:     " |             results when a:ispath == 1.
bgneal@7:     " |
bgneal@7:     " +- a:regex  : In regex mode: 1 or 0.
bgneal@7: 
bgneal@7:     return list_of_matched_items
bgneal@7:   endfunction
bgneal@7: <
bgneal@7: 
bgneal@7: ===============================================================================
bgneal@7: COMMANDS                                                       *ctrlp-commands*
bgneal@7: 
bgneal@7:                                                                        *:CtrlP*
bgneal@7: :CtrlP [starting-directory]
bgneal@7:    Open CtrlP in find file mode.
bgneal@7: 
bgneal@7:    If no argument is given, the value of |g:ctrlp_working_path_mode| will be
bgneal@7:    used to determine the starting directory.
bgneal@7:    You can use <tab> to auto-complete the [starting-directory] when typing it.
bgneal@7: 
bgneal@7:                                                                  *:CtrlPBuffer*
bgneal@7: :CtrlPBuffer
bgneal@7:    Open CtrlP in find buffer mode.
bgneal@7: 
bgneal@7:                                                                     *:CtrlPMRU*
bgneal@7: :CtrlPMRU
bgneal@7:    Open CtrlP in find Most-Recently-Used file mode.
bgneal@7: 
bgneal@7:                                                                *:CtrlPLastMode*
bgneal@7: :CtrlPLastMode
bgneal@7:    Open CtrlP in the last mode used.
bgneal@7: 
bgneal@7:                                                                    *:CtrlPRoot*
bgneal@7: :CtrlPRoot
bgneal@7:     This acts like |:CtrlP| with |g:ctrlp_working_path_mode| = 2 (ignores its
bgneal@7:     current value).
bgneal@7: 
bgneal@7:                                                              *:CtrlPClearCache*
bgneal@7: :CtrlPClearCache
bgneal@7:    Flush the cache for the current working directory. The same as pressing <F5>
bgneal@7:    inside CtrlP.
bgneal@7:    To enable or disable caching, use the |g:ctrlp_use_caching| option.
bgneal@7: 
bgneal@7:                                                          *:CtrlPClearAllCaches*
bgneal@7: :CtrlPClearAllCaches
bgneal@7:    Delete all the cache files saved in |g:ctrlp_cache_dir|.
bgneal@7: 
bgneal@7: -------------------------------------------------------------------------------
bgneal@7: For commands provided by bundled extensions, see |ctrlp-extensions|.
bgneal@7: 
bgneal@7: ===============================================================================
bgneal@7: MAPPINGS                                                       *ctrlp-mappings*
bgneal@7: 
bgneal@7:                                                                 *'ctrlp-<c-p>'*
bgneal@7: <c-p>
bgneal@7:    Default |Normal| mode mapping to open the CtrlP prompt in find file mode.
bgneal@7: 
bgneal@7: Once inside the prompt:~
bgneal@7: 
bgneal@7:   <c-d>
bgneal@7:     Toggle between full-path search and filename only search.
bgneal@7:     Note: in filename mode, the prompt’s base is '>d>' instead of '>>>'
bgneal@7: 
bgneal@7:   <c-r>                                                    *'ctrlp-fullregexp'*
bgneal@7:     Toggle between the string mode and full regexp mode.
bgneal@7:     Note: in full regexp mode, the prompt’s base is 'r>>' instead of '>>>'
bgneal@7: 
bgneal@7:     See also |input-formats| (guide) and |g:ctrlp_regexp_search| (option).
bgneal@7: 
bgneal@7:   <c-f>, 'forward'
bgneal@7:   <c-up>
bgneal@7:     Scroll to the 'next' search mode in the sequence.
bgneal@7: 
bgneal@7:   <c-b>, 'backward'
bgneal@7:   <c-down>
bgneal@7:     Scroll to the 'previous' search mode in the sequence.
bgneal@7: 
bgneal@7:   <tab>
bgneal@7:     Auto-complete directory names under the current working directory inside
bgneal@7:     the prompt.
bgneal@7: 
bgneal@7:   <s-tab>
bgneal@7:     Toggle the focus between the match window and the prompt.
bgneal@7: 
bgneal@7:   <c-j>,
bgneal@7:   <down>
bgneal@7:     Move selection down.
bgneal@7: 
bgneal@7:   <c-k>,
bgneal@7:   <up>
bgneal@7:     Move selection up.
bgneal@7: 
bgneal@7:   <c-a>
bgneal@7:     Move the cursor to the 'start' of the prompt.
bgneal@7: 
bgneal@7:   <c-e>
bgneal@7:     Move the cursor to the 'end' of the prompt.
bgneal@7: 
bgneal@7:   <c-h>,
bgneal@7:   <left>,
bgneal@7:   <c-^>
bgneal@7:     Move the cursor one character to the 'left'.
bgneal@7: 
bgneal@7:   <c-l>,
bgneal@7:   <right>
bgneal@7:     Move the cursor one character to the 'right'.
bgneal@7: 
bgneal@7:   <c-]>,
bgneal@7:   <bs>
bgneal@7:     Delete the preceding character.
bgneal@7: 
bgneal@7:   <del>
bgneal@7:     Delete the current character.
bgneal@7: 
bgneal@7:   <c-w>
bgneal@7:     Delete a preceding inner word.
bgneal@7: 
bgneal@7:   <c-u>
bgneal@7:     Clear the input field.
bgneal@7: 
bgneal@7:   <cr>
bgneal@7:     Open selected file in the active window if possible.
bgneal@7: 
bgneal@7:   <c-t>
bgneal@7:     Open selected file in a new 'tab' after the last tabpage.
bgneal@7: 
bgneal@7:   <c-v>
bgneal@7:     Open selected file in a 'vertical' split.
bgneal@7: 
bgneal@7:   <c-x>,
bgneal@7:   <c-cr>,
bgneal@7:   <c-s>
bgneal@7:     Open selected file in a 'horizontal' split.
bgneal@7: 
bgneal@7:   <c-y>
bgneal@7:     Create a new file and its parent directories.
bgneal@7: 
bgneal@7:   <c-n>
bgneal@7:     Next string in the prompt’s history.
bgneal@7: 
bgneal@7:   <c-p>
bgneal@7:     Previous string in the prompt’s history.
bgneal@7: 
bgneal@7:   <c-z>
bgneal@7:     - Mark/unmark a file to be opened with <c-o>.
bgneal@7:     - Or mark/unmark a file to create a new file in its directory using <c-y>.
bgneal@7: 
bgneal@7:   <c-o>
bgneal@7:     Open files marked by <c-z>.
bgneal@7: 
bgneal@7:   <F5>
bgneal@7:     - Refresh the match window and purge the cache for the current directory.
bgneal@7:     - Or remove deleted files from the MRU list.
bgneal@7: 
bgneal@7:   <F7>
bgneal@7:     - Wipe the MRU list.
bgneal@7:     - Or delete MRU entries marked by <c-z>.
bgneal@7: 
bgneal@7:   <insert>
bgneal@7:     Insert the word under the cursor (in the current buffer) into the prompt.
bgneal@7: 
bgneal@7:   <esc>,
bgneal@7:   <c-c>,
bgneal@7:   <c-g>
bgneal@7:     Exit CtrlP.
bgneal@7:     Note: <c-c> can also be used to stop the scan if it’s taking too long.
bgneal@7: 
bgneal@7: Choose your own mappings with |g:ctrlp_prompt_mappings|.
bgneal@7: 
bgneal@7: When inside the match window (press <s-tab> to switch):~
bgneal@7: 
bgneal@7:   a-z
bgneal@7:   0-9
bgneal@7:   ~^-=;`',.+!@#$%&_(){}[]
bgneal@7:     Cycle through the lines with the first letter (of paths or filenames) that
bgneal@7:     matches that key.
bgneal@7: 
bgneal@7: ===============================================================================
bgneal@7: INPUT FORMATS                                             *ctrlp-input-formats*
bgneal@7: 
bgneal@7: Formats for inputting in the prompt:~
bgneal@7: 
bgneal@7: a)  Simple string.
bgneal@7: 
bgneal@7:     E.g. 'abc' is understood internally as 'a[^a]\{-}b[^b]\{-}c'
bgneal@7: 
bgneal@7: b)  When in regexp mode, the input string’s treated as a Vim’s regexp |pattern|
bgneal@7:     without any modification.
bgneal@7: 
bgneal@7:     E.g. 'abc\d*efg' will be read as 'abc\d*efg'.
bgneal@7: 
bgneal@7:     See |ctrlp-fullregexp| (keymap) and |g:ctrlp_regexp_search| (option) for
bgneal@7:     how to enable regexp mode.
bgneal@7: 
bgneal@7: c)  End the string with a colon ':' followed by a Vim command to execute that
bgneal@7:     command after opening the file. If you need to use ':' literally, escape it
bgneal@7:     with a backslash: '\:'. When opening multiple files, the command will be
bgneal@7:     executed on each opening file.
bgneal@7: 
bgneal@7:     E.g. 'abc:45' will open the selected file and jump to line 45.
bgneal@7: 
bgneal@7:          'abc:/any\:string' will open the selected file and jump to the first
bgneal@7:          instance of 'any:string'.
bgneal@7: 
bgneal@7:          'abc:+setf\ myfiletype|50' will open the selected file and set its
bgneal@7:          filetype to 'myfiletype', then jump to line 50.
bgneal@7: 
bgneal@7:          'abc:diffthis' will open the selected files and run |:diffthis| on the
bgneal@7:          first 4 files (if marked).
bgneal@7: 
bgneal@7:     See also Vim’s |++opt| and |+cmd|.
bgneal@7: 
bgneal@7: d)  Type exactly two dots '..' at the start of the prompt and press enter to go
bgneal@7:     backward in the directory tree by 1 level. If the parent directory is
bgneal@7:     large, this might be slow.
bgneal@7: 
bgneal@7: e)  Similarly, submit '/' or '\' to find and go to the project’s root. If the
bgneal@7:     project is large, using a VCS listing command to look for files might help
bgneal@7:     speeding up the intial scan (see |g:ctrlp_user_command| for more details).
bgneal@7: 
bgneal@7:     Note: e) and d) only work in find file mode and directory mode.
bgneal@7: 
bgneal@7: f)  Type the name of a non-existent file and press <c-y> to create it. Mark a
bgneal@7:     file with <c-z> to create the new file in the same directory as the marked
bgneal@7:     file.
bgneal@7: 
bgneal@7:     E.g. 'parentdir/newfile.txt' will create a directory named 'parentdir' as
bgneal@7:          well as 'newfile.txt'.
bgneal@7: 
bgneal@7:          If 'some/old/dirs/oldfile.txt' is marked with <c-z>, then 'parentdir'
bgneal@7:          and 'newfile.txt' will be created in 'some/old/dirs'. The final path
bgneal@7:          will then be 'some/old/dirs/parentdir/newfile.txt'.
bgneal@7: 
bgneal@7:          Use '\' in place of '/' on Windows (if |'ssl'| is not set).
bgneal@7: 
bgneal@7: g)  Submit ? to open this help file.
bgneal@7: 
bgneal@7: ===============================================================================
bgneal@7: EXTENSIONS                                                   *ctrlp-extensions*
bgneal@7: 
bgneal@7: Extensions are optional. To enable an extension, add its name to the variable
bgneal@7: g:ctrlp_extensions: >
bgneal@7:   let g:ctrlp_extensions = ['tag', 'buffertag', 'quickfix', 'dir', 'rtscript',
bgneal@7:                           \ 'undo', 'line', 'changes', 'mixed', 'bookmarkdir']
bgneal@7: <
bgneal@7: The order of the items will be the order they appear on the statusline and when
bgneal@7: using <c-f>, <c-b>.
bgneal@7: 
bgneal@7: Available extensions:~
bgneal@7: 
bgneal@7:                                                                     *:CtrlPTag*
bgneal@7:   * Tag mode:~
bgneal@7:     - Name: 'tag'
bgneal@7:     - Command: ':CtrlPTag'
bgneal@7:     - Search for a tag within a generated central tags file, and jump to the
bgneal@7:       definition. Use the Vim’s option |'tags'| to specify the names and the
bgneal@7:       locations of the tags file(s).
bgneal@7:       E.g. set tags+=doc/tags
bgneal@7: 
bgneal@7:                                                                  *:CtrlPBufTag*
bgneal@7:                                                               *:CtrlPBufTagAll*
bgneal@7:   * Buffer Tag mode:~
bgneal@7:     - Name: 'buffertag'
bgneal@7:     - Commands: ':CtrlPBufTag [buffer]',
bgneal@7:                 ':CtrlPBufTagAll'.
bgneal@7:     - Search for a tag within the current buffer or all listed buffers and jump
bgneal@7:       to the definition. Requires |exuberant_ctags| or compatible programs.
bgneal@7: 
bgneal@7:                                                                *:CtrlPQuickfix*
bgneal@7:   * Quickfix mode:~
bgneal@7:     - Name: 'quickfix'
bgneal@7:     - Command: ':CtrlPQuickfix'
bgneal@7:     - Search for an entry in the current quickfix errors and jump to it.
bgneal@7: 
bgneal@7:                                                                     *:CtrlPDir*
bgneal@7:   * Directory mode:~
bgneal@7:     - Name: 'dir'
bgneal@7:     - Command: ':CtrlPDir [starting-directory]'
bgneal@7:     - Search for a directory and change the working directory to it.
bgneal@7:     - Mappings:
bgneal@7:       + <cr> change the local working directory for CtrlP and keep it open.
bgneal@7:       + <c-t> change the global working directory (exit).
bgneal@7:       + <c-v> change the local working directory for the current window (exit).
bgneal@7:       + <c-x> change the global working directory to CtrlP’s current local
bgneal@7:         working directory (exit).
bgneal@7: 
bgneal@7:                                                                     *:CtrlPRTS*
bgneal@7:   * Runtime script mode:~
bgneal@7:     - Name: 'rtscript'
bgneal@7:     - Command: ':CtrlPRTS'
bgneal@7:     - Search for files (vimscripts, docs, snippets...) in runtimepath.
bgneal@7: 
bgneal@7:                                                                    *:CtrlPUndo*
bgneal@7:   * Undo mode:~
bgneal@7:     - Name: 'undo'
bgneal@7:     - Command: ':CtrlPUndo'
bgneal@7:     - Browse undo history.
bgneal@7: 
bgneal@7:                                                                    *:CtrlPLine*
bgneal@7:   * Line mode:~
bgneal@7:     - Name: 'line'
bgneal@7:     - Command: ':CtrlPLine'
bgneal@7:     - Search for a line in all listed buffers.
bgneal@7: 
bgneal@7:                                                                  *:CtrlPChange*
bgneal@7:                                                               *:CtrlPChangeAll*
bgneal@7:   * Change list mode:~
bgneal@7:     - Name: 'changes'
bgneal@7:     - Commands: ':CtrlPChange [buffer]',
bgneal@7:                 ':CtrlPChangeAll'.
bgneal@7:     - Search for and jump to a recent change in the current buffer or in all
bgneal@7:       listed buffers.
bgneal@7: 
bgneal@7:                                                                   *:CtrlPMixed*
bgneal@7:   * Mixed mode:~
bgneal@7:     - Name: 'mixed'
bgneal@7:     - Command: ':CtrlPMixed'
bgneal@7:     - Search in files, buffers and MRU files at the same time.
bgneal@7: 
bgneal@7:                                                             *:CtrlPBookmarkDir*
bgneal@7:                                                          *:CtrlPBookmarkDirAdd*
bgneal@7:   * BookmarkDir mode:~
bgneal@7:     - Name: 'bookmarkdir'
bgneal@7:     - Commands: ':CtrlPBookmarkDir',
bgneal@7:                 ':CtrlPBookmarkDirAdd [directory]'.
bgneal@7:     - Search for a bookmarked directory and change the working directory to it.
bgneal@7:     - Mappings:
bgneal@7:       + <cr> change the local working directory for CtrlP, keep it open and
bgneal@7:         switch to find file mode.
bgneal@7:       + <c-x> change the global working directory (exit).
bgneal@7:       + <c-v> change the local working directory for the current window (exit).
bgneal@7:       + <F7>
bgneal@7:         - Wipe bookmark list.
bgneal@7:         - Or delete entries marked by <c-z>.
bgneal@7: 
bgneal@7: ----------------------------------------
bgneal@7: Buffer Tag mode options:~
bgneal@7: 
bgneal@7:                                                    *'g:ctrlp_buftag_ctags_bin'*
bgneal@7: If ctags isn’t in your $PATH, use this to set its location: >
bgneal@7:   let g:ctrlp_buftag_ctags_bin = ''
bgneal@7: <
bgneal@7: 
bgneal@7:                                                    *'g:ctrlp_buftag_systemenc'*
bgneal@7: Match this with your OS’s encoding (not Vim’s). The default value mirrors Vim’s
bgneal@7: global |'encoding'| option: >
bgneal@7:   let g:ctrlp_buftag_systemenc = &encoding
bgneal@7: <
bgneal@7: 
bgneal@7:                                                        *'g:ctrlp_buftag_types'*
bgneal@7: Use this to set the arguments for ctags, jsctags... for a given filetype: >
bgneal@7:   let g:ctrlp_buftag_types = ''
bgneal@7: <
bgneal@7: Examples: >
bgneal@7:   let g:ctrlp_buftag_types = {
bgneal@7:     \ 'erlang'     : '--language-force=erlang --erlang-types=drmf',
bgneal@7:     \ 'javascript' : {
bgneal@7:       \ 'bin': 'jsctags',
bgneal@7:       \ 'args': '-f -',
bgneal@7:       \ },
bgneal@7:     \ }
bgneal@7: <
bgneal@7: 
bgneal@7: ===============================================================================
bgneal@7: CUSTOMIZATION                                             *ctrlp-customization*
bgneal@7: 
bgneal@7: Highlighting:~
bgneal@7:   * For the CtrlP buffer:
bgneal@7:     CtrlPNoEntries : the message when no match is found (Error)
bgneal@7:     CtrlPMatch     : the matched pattern (Identifier)
bgneal@7:     CtrlPLinePre   : the line prefix '>' in the match window
bgneal@7:     CtrlPPrtBase   : the prompt’s base (Comment)
bgneal@7:     CtrlPPrtText   : the prompt’s text (|hl-Normal|)
bgneal@7:     CtrlPPrtCursor : the prompt’s cursor when moving over the text (Constant)
bgneal@7: 
bgneal@7:   * In extensions:
bgneal@7:     CtrlPTabExtra  : the part of each line that’s not matched against (Comment)
bgneal@7:     CtrlPBufName   : the buffer name an entry belongs to (|hl-Directory|)
bgneal@7:     CtrlPTagKind   : the kind of the tag in buffer-tag mode (|hl-Title|)
bgneal@7:     CtrlPqfLineCol : the line and column numbers in quickfix mode (Comment)
bgneal@7:     CtrlPUndoT     : the elapsed time in undo mode (|hl-Directory|)
bgneal@7:     CtrlPUndoBr    : the square brackets [] in undo mode (Comment)
bgneal@7:     CtrlPUndoNr    : the undo number inside [] in undo mode (String)
bgneal@7:     CtrlPUndoSv    : the point where the file was saved (Comment)
bgneal@7:     CtrlPUndoPo    : the current position in the undo tree (|hl-Title|)
bgneal@7:     CtrlPBookmark  : the name of the bookmark (Identifier)
bgneal@7: 
bgneal@7: Statuslines:~
bgneal@7:   * Highlight groups:
bgneal@7:     CtrlPMode1 : 'prt' or 'win', also for 'regex' (Character)
bgneal@7:     CtrlPMode2 : 'file' or 'path', also for the local working dir (|hl-LineNr|)
bgneal@7:     CtrlPStats : the scanning status (Function)
bgneal@7: 
bgneal@7:   For rebuilding the statuslines, see |g:ctrlp_status_func|.
bgneal@7: 
bgneal@7: ===============================================================================
bgneal@7: MISCELLANEOUS CONFIGS                             *ctrlp-miscellaneous-configs*
bgneal@7: 
bgneal@7: * Use |wildignore| for |g:ctrlp_user_command|:
bgneal@7: >
bgneal@7:   function! s:wig2cmd()
bgneal@7:     " Change wildignore into space or | separated groups
bgneal@7:     " e.g. .aux .out .toc .jpg .bmp .gif
bgneal@7:     " or   .aux$\|.out$\|.toc$\|.jpg$\|.bmp$\|.gif$
bgneal@7:     let pats = ['[*\/]*\([?_.0-9A-Za-z]\+\)\([*\/]*\)\(\\\@<!,\|$\)','\\\@<!,']
bgneal@7:     let subs = has('win32') || has('win64') ? ['\1\3', ' '] : ['\1\2\3', '\\|']
bgneal@7:     let expr = substitute(&wig, pats[0], subs[0], 'g')
bgneal@7:     let expr = substitute(expr, pats[1], subs[1], 'g')
bgneal@7:     let expr = substitute(expr, '\\,', ',', 'g')
bgneal@7: 
bgneal@7:     " Set the user_command option
bgneal@7:     let g:ctrlp_user_command = has('win32') || has('win64')
bgneal@7:       \ ? 'dir %s /-n /b /s /a-d | findstr /V /l "'.expr.'"'
bgneal@7:       \ : 'find %s -type f | grep -v "'.expr .'"'
bgneal@7:   endfunction
bgneal@7: 
bgneal@7:   call s:wig2cmd()
bgneal@7: <
bgneal@7: (submitted by Rich Alesi <github.com/ralesi>)
bgneal@7: 
bgneal@7: * A standalone function to set the working directory to the project’s root, or
bgneal@7:   to the parent directory of the current file if a root can’t be found:
bgneal@7: >
bgneal@7:   function! s:setcwd()
bgneal@7:     let cph = expand('%:p:h', 1)
bgneal@7:     if match(cph, '\v^<.+>://') >= 0 | retu | en
bgneal@7:     for mkr in ['.git/', '.hg/', '.svn/', '.bzr/', '_darcs/', '.vimprojects']
bgneal@7:       let wd = call('find'.(mkr =~ '/$' ? 'dir' : 'file'), [mkr, cph.';'])
bgneal@7:       if wd != '' | let &acd = 0 | brea | en
bgneal@7:     endfo
bgneal@7:     exe 'lc!' fnameescape(wd == '' ? cph : substitute(wd, mkr.'$', '.', ''))
bgneal@7:   endfunction
bgneal@7: 
bgneal@7:   autocmd BufEnter * call s:setcwd()
bgneal@7: <
bgneal@7: (requires Vim 7.1.299+)
bgneal@7: 
bgneal@7: ===============================================================================
bgneal@7: CREDITS                                                         *ctrlp-credits*
bgneal@7: 
bgneal@7: Developed by Kien Nguyen <github.com/kien>.
bgneal@7: 
bgneal@7: Project’s homepage:   http://kien.github.com/ctrlp.vim
bgneal@7: Git repository:       https://github.com/kien/ctrlp.vim
bgneal@7: Mercurial repository: https://bitbucket.org/kien/ctrlp.vim
bgneal@7: 
bgneal@7: -------------------------------------------------------------------------------
bgneal@7: Thanks to everyone that has submitted ideas, bug reports or helped debugging on
bgneal@7: gibhub, bitbucket, and through email.
bgneal@7: 
bgneal@7: Special thanks:~
bgneal@7: 
bgneal@7:     * Woojong Koh <github.com/wjkoh>
bgneal@7:     * Simon Ruderich
bgneal@7:     * Yasuhiro Matsumoto <github.com/mattn>
bgneal@7:     * Ken Earley <github.com/kenearley>
bgneal@7:     * Kyo Nagashima <github.com/hail2u>
bgneal@7:     * Zak Johnson <github.com/zakj>
bgneal@7:     * Diego Viola <github.com/diegoviola>
bgneal@7:     * Piet Delport <github.com/pjdelport>
bgneal@7:     * Thibault Duplessis <github.com/ornicar>
bgneal@7:     * Kent Sibilev <github.com/datanoise>
bgneal@7:     * Tacahiroy <github.com/tacahiroy>
bgneal@7:     * Luca Pette <github.com/lucapette>
bgneal@7: 
bgneal@7: ===============================================================================
bgneal@7: CHANGELOG                                                     *ctrlp-changelog*
bgneal@7: 
bgneal@7:     + New option: |g:ctrlp_mruf_default_order|
bgneal@7:     + New feature: Bookmarked directories extension.
bgneal@7:     + New commands: |:CtrlPBookmarkDir|
bgneal@7:                     |:CtrlPBookmarkDirAdd|
bgneal@7: 
bgneal@7: Before 2012/04/15~
bgneal@7: 
bgneal@7:     + New option: |g:ctrlp_buffer_func|, callback functions for CtrlP buffer.
bgneal@7:     + Remove: g:ctrlp_mruf_last_entered, make it a default for MRU mode.
bgneal@7:     + New commands: |:CtrlPLastMode|, open CtrlP in the last mode used.
bgneal@7:                     |:CtrlPMixed|, search in files, buffers and MRU files.
bgneal@7: 
bgneal@7: Before 2012/03/31~
bgneal@7: 
bgneal@7:     + New options: |g:ctrlp_default_input|, default input when entering CtrlP.
bgneal@7:                    |g:ctrlp_match_func|, allow using a custom fuzzy matcher.
bgneal@7:     + Rename:
bgneal@7:         *ClearCtrlPCache* -> |CtrlPClearCache|
bgneal@7:         *ClearAllCtrlPCaches* -> |CtrlPClearAllCaches|
bgneal@7:         *ResetCtrlP* -> |CtrlPReload|
bgneal@7: 
bgneal@7: Before 2012/03/02~
bgneal@7: 
bgneal@7:     + Rename:
bgneal@7:         *g:ctrlp_regexp_search* -> |g:ctrlp_regexp|,
bgneal@7:         *g:ctrlp_dont_split* -> |g:ctrlp_reuse_window|,
bgneal@7:         *g:ctrlp_jump_to_buffer* -> |g:ctrlp_switch_buffer|.
bgneal@7:     + Rename and tweak:
bgneal@7:         *g:ctrlp_open_multi* -> |g:ctrlp_open_multiple_files|.
bgneal@7:     + Deprecate *g:ctrlp_highlight_match*
bgneal@7:     + Extend |g:ctrlp_user_command| to support multiple commands.
bgneal@7:     + New option: |g:ctrlp_mruf_last_entered| change MRU to Recently-Entered.
bgneal@7: 
bgneal@7: Before 2012/01/15~
bgneal@7: 
bgneal@7:     + New mapping: Switch <tab> and <s-tab>. <tab> is now used for completion
bgneal@7:                    of directory names under the current working directory.
bgneal@7:     + New options: |g:ctrlp_arg_map| for <c-y>, <c-o> to accept an argument.
bgneal@7:                    |g:ctrlp_status_func| custom statusline.
bgneal@7:                    |g:ctrlp_mruf_relative| show only MRU files inside cwd.
bgneal@7:     + Extend g:ctrlp_open_multi with new optional values: tr, hr, vr.
bgneal@7:     + Extend |g:ctrlp_custom_ignore| to specifically filter dir, file and link.
bgneal@7: 
bgneal@7: Before 2012/01/05~
bgneal@7: 
bgneal@7:     + New feature: Buffer Tag extension.
bgneal@7:     + New commands: |:CtrlPBufTag|, |:CtrlPBufTagAll|.
bgneal@7:     + New options: |g:ctrlp_cmd|,
bgneal@7:                    |g:ctrlp_custom_ignore|
bgneal@7: 
bgneal@7: Before 2011/11/30~
bgneal@7: 
bgneal@7:     + New features: Tag, Quickfix and Directory extensions.
bgneal@7:     + New commands: |:CtrlPTag|, |:CtrlPQuickfix|, |:CtrlPDir|.
bgneal@7:     + New options: |g:ctrlp_use_migemo|,
bgneal@7:                    |g:ctrlp_lazy_update|,
bgneal@7:                    |g:ctrlp_follow_symlinks|
bgneal@7: 
bgneal@7: Before 2011/11/13~
bgneal@7: 
bgneal@7:     + New special input: '/' and '\' find root (|ctrlp-input-formats| (e))
bgneal@7:     + Remove ctrlp#SetWorkingPath().
bgneal@7:     + Remove *g:ctrlp_mru_files* and make MRU mode permanent.
bgneal@7:     + Extend g:ctrlp_open_multi, add new ways to open files.
bgneal@7:     + New option: g:ctrlp_dont_split,
bgneal@7:                   |g:ctrlp_mruf_case_sensitive|
bgneal@7: 
bgneal@7: Before 2011/10/30~
bgneal@7: 
bgneal@7:     + New feature: Support for custom extensions.
bgneal@7:                    <F5> also removes non-existent files from MRU list.
bgneal@7:     + New option: g:ctrlp_jump_to_buffer
bgneal@7: 
bgneal@7: Before 2011/10/12~
bgneal@7: 
bgneal@7:     + New features: Open multiple files.
bgneal@7:                     Pass Vim’s |++opt| and |+cmd| to the opening file
bgneal@7:                     (|ctrlp-input-formats| (c))
bgneal@7:                     Auto-complete each dir for |:CtrlP| [starting-directory]
bgneal@7:     + New mappings: <c-z> mark/unmark a file to be opened with <c-o>.
bgneal@7:                     <c-o> open all marked files.
bgneal@7:     + New option: g:ctrlp_open_multi
bgneal@7:     + Remove *g:ctrlp_persistent_input* *g:ctrlp_live_update* and <c-^>.
bgneal@7: 
bgneal@7: Before 2011/09/29~
bgneal@7: 
bgneal@7:     + New mappings: <c-n>, <c-p> next/prev string in the input history.
bgneal@7:                     <c-y> create a new file and its parent dirs.
bgneal@7:     + New options: |g:ctrlp_open_new_file|,
bgneal@7:                    |g:ctrlp_max_history|
bgneal@7:     + Added a new open-in-horizontal-split mapping: <c-x>
bgneal@7: 
bgneal@7: Before 2011/09/19~
bgneal@7: 
bgneal@7:     + New command: ResetCtrlP
bgneal@7:     + New options: |g:ctrlp_max_files|,
bgneal@7:                    |g:ctrlp_max_depth|,
bgneal@7:                    g:ctrlp_live_update
bgneal@7:     + New mapping: <c-^>
bgneal@7: 
bgneal@7: Before 2011/09/12~
bgneal@7: 
bgneal@7:     + Ability to cycle through matched lines in the match window.
bgneal@7:     + Extend the behavior of g:ctrlp_persistent_input
bgneal@7:     + Extend the behavior of |:CtrlP|
bgneal@7:     + New options: |g:ctrlp_dotfiles|,
bgneal@7:                    |g:ctrlp_clear_cache_on_exit|,
bgneal@7:                    g:ctrlp_highlight_match,
bgneal@7:                    |g:ctrlp_user_command|
bgneal@7:     + New special input: '..' (|ctrlp-input-formats| (d))
bgneal@7:     + New mapping: <F5>.
bgneal@7:     + New commands: |:CtrlPCurWD|,
bgneal@7:                     |:CtrlPCurFile|,
bgneal@7:                     |:CtrlPRoot|
bgneal@7: 
bgneal@7:     + New feature: Search in most recently used (MRU) files
bgneal@7:     + New mapping: <c-b>.
bgneal@7:     + Extended the behavior of <c-f>.
bgneal@7:     + New options: g:ctrlp_mru_files,
bgneal@7:                    |g:ctrlp_mruf_max|,
bgneal@7:                    |g:ctrlp_mruf_exclude|,
bgneal@7:                    |g:ctrlp_mruf_include|
bgneal@7:     + New command: |:CtrlPMRU|
bgneal@7: 
bgneal@7: First public release: 2011/09/06~
bgneal@7: 
bgneal@7: ===============================================================================
bgneal@7: vim:ft=help:et:ts=2:sw=2:sts=2:norl