1a2c3ee8d2
Use <c-z> to mark/unmark files and <c-o> to open them. You can enter new input strings and continue to mark more files. The list of marked files will be cleared upon exiting CtrlP.
529 lines
20 KiB
Plaintext
529 lines
20 KiB
Plaintext
*ctrlp.txt* Full path fuzzy file, buffer and MRU file finder. v1.5
|
||
*CtrlP* *ControlP* *'ctrlp'* *'ctrl-p'*
|
||
===============================================================================
|
||
# #
|
||
# :::::::: ::::::::::: ::::::::: ::: ::::::::: #
|
||
# :+: :+: :+: :+: :+: :+: :+: :+: #
|
||
# +:+ +:+ +:+ +:+ +:+ +:+ +:+ #
|
||
# +#+ +#+ +#++:++#: +#+ +#++:++#+ #
|
||
# +#+ +#+ +#+ +#+ +#+ +#+ #
|
||
# #+# #+# #+# #+# #+# #+# #+# #
|
||
# ######## ### ### ### ########## ### #
|
||
# #
|
||
===============================================================================
|
||
CONTENTS *ctrlp-contents*
|
||
|
||
1.Intro...................................|ctrlp-intro|
|
||
2.Options.................................|ctrlp-options|
|
||
3.Commands................................|ctrlp-commands|
|
||
4.Mappings................................|ctrlp-mappings|
|
||
5.Input Formats...........................|ctrlp-input-formats|
|
||
6.Credits.................................|ctrlp-credits|
|
||
|
||
===============================================================================
|
||
1. Intro *ctrlp-intro*
|
||
|
||
Full path fuzzy file, buffer and MRU file finder with an intuitive interface.
|
||
Written in pure Vimscript for MacVim and Vim version 7.0+. Has full support for
|
||
Vim’s |regexp| as search pattern, and more.
|
||
|
||
See also |ctrlp-input-formats| and |ctrlp-fullregexp|.
|
||
|
||
===============================================================================
|
||
2. Options *ctrlp-options*
|
||
|
||
Below are the available options and their default values.
|
||
|
||
*'g:ctrlp_map'*
|
||
Use this option to change the mapping to invoke |CtrlP| in |Normal| mode: >
|
||
let g:ctrlp_map = '<c-p>'
|
||
<
|
||
|
||
*'g:loaded_ctrlp'*
|
||
Use this option to disable the plugin completely: >
|
||
let g:loaded_ctrlp = 1
|
||
<
|
||
|
||
*'g:ctrlp_by_filename'*
|
||
Set this to 1 to set search by filename (not full path) as the default: >
|
||
let g:ctrlp_by_filename = 0
|
||
<
|
||
|
||
*'g:ctrlp_regexp_search'*
|
||
Set this to 1 to set full |regexp| search as the default mode: >
|
||
let g:ctrlp_regexp_search = 0
|
||
<
|
||
|
||
*'g:ctrlp_persistent_input'*
|
||
Remember the last input string:
|
||
1 - Remember the last input string.
|
||
2 - Also remember the position of the selection in the match window.
|
||
0 - Clear the input field each time CtrlP starts.
|
||
>
|
||
let g:ctrlp_persistent_input = 0
|
||
<
|
||
|
||
*'g:ctrlp_match_window_reversed'*
|
||
Reverse the sort order of the matched files in the match window. The default
|
||
setting is from bottom to top: >
|
||
let g:ctrlp_match_window_reversed = 1
|
||
<
|
||
|
||
*'g:ctrlp_max_height'*
|
||
Set the maximum height of the match window: >
|
||
let g:ctrlp_max_height = 10
|
||
<
|
||
|
||
*'g:ctrlp_split_window'*
|
||
Use this option to specify how the file is to be opened when pressing <cr>:
|
||
1 - in a new tab
|
||
2 - in a new horizontal split
|
||
3 - in a new vertical split
|
||
0 - in the current window/split
|
||
>
|
||
let g:ctrlp_split_window = 0
|
||
<
|
||
|
||
*'g:ctrlp_working_path_mode'*
|
||
*SetWorkingPath()*
|
||
When starting up the prompt, automatically set the working directory (i.e. the
|
||
|current-directory|) to:
|
||
1 - the parent directory of the current file.
|
||
2 - the nearest ancestor that contains one of these directories/files:
|
||
.git/
|
||
.hg/
|
||
.bzr/
|
||
_darcs/
|
||
root.dir
|
||
.vimprojects
|
||
0 - don’t manage working directory.
|
||
>
|
||
let g:ctrlp_working_path_mode = 1
|
||
<
|
||
You can use this functionality outside of |CtrlP| by adding the following line
|
||
to your |.vimrc|; the parameter is the same (1, 2 and 0): >
|
||
au BufEnter * cal ctrlp#SetWorkingPath(2)
|
||
<
|
||
|
||
*'g:ctrlp_root_markers'*
|
||
Use this to set your own root markers for the |SetWorkingPath()| function, in
|
||
addition to the default ones, your markers will take precedence: >
|
||
let g:ctrlp_root_markers = ['']
|
||
<
|
||
|
||
*'g:ctrlp_use_caching'*
|
||
Set this to 0 to disable per-session caching. When disabled, caching will still
|
||
be enabled for directories that have more than 4000 files: >
|
||
let g:ctrlp_use_caching = 1
|
||
<
|
||
Note: you can quickly purge the cache by pressing <F5>.
|
||
|
||
*'g:ctrlp_clear_cache_on_exit'*
|
||
Set this to 0 to enable cross-sessions caching by not deleting the caches upon
|
||
exiting Vim: >
|
||
let g:ctrlp_clear_cache_on_exit = 1
|
||
<
|
||
|
||
*'g:ctrlp_cache_dir'*
|
||
Set the parent directory for the '.ctrlp_cache' directory: >
|
||
let g:ctrlp_cache_dir = $HOME
|
||
<
|
||
|
||
*'g:ctrlp_prompt_mappings'*
|
||
Use this to customize the mappings inside |CtrlP|’s prompt to your liking. You
|
||
only need to keep the lines that you’ve changed the values (inside []): >
|
||
let g:ctrlp_prompt_mappings = {
|
||
\ 'PrtBS()': ['<bs>'],
|
||
\ 'PrtDelete()': ['<del>'],
|
||
\ 'PrtDeleteWord()': ['<c-w>'],
|
||
\ 'PrtClear()': ['<c-u>'],
|
||
\ 'PrtSelectMove("j")': ['<c-j>', '<down>'],
|
||
\ 'PrtSelectMove("k")': ['<c-k>', '<up>'],
|
||
\ 'PrtHistory(-1)': ['<c-n>'],
|
||
\ 'PrtHistory(1)': ['<c-p>'],
|
||
\ 'AcceptSelection("e")': ['<cr>'],
|
||
\ 'AcceptSelection("h")': ['<c-x>', '<c-cr>', '<c-s>'],
|
||
\ 'AcceptSelection("t")': ['<c-t>'],
|
||
\ 'AcceptSelection("v")': ['<c-v>'],
|
||
\ 'ToggleFocus()': ['<tab>'],
|
||
\ 'ToggleRegex()': ['<c-r>'],
|
||
\ 'ToggleByFname()': ['<c-d>'],
|
||
\ 'ToggleType(1)': ['<c-f>', '<c-up'],
|
||
\ 'ToggleType(-1)': ['<c-b>', '<c-down>'],
|
||
\ 'ForceUpdate()': ['<c-^>'],
|
||
\ 'PrtCurStart()': ['<c-a>'],
|
||
\ 'PrtCurEnd()': ['<c-e>'],
|
||
\ 'PrtCurLeft()': ['<c-h>', '<left>'],
|
||
\ 'PrtCurRight()': ['<c-l>', '<right>'],
|
||
\ 'PrtClearCache()': ['<F5>'],
|
||
\ 'CreateNewFile()': ['<c-y>'],
|
||
\ 'MarkToOpen()': ['<c-z>'],
|
||
\ 'OpenMulti()': ['<c-o>'],
|
||
\ 'BufOpen("ControlP", "del")': ['<esc>', '<c-c>', '<c-g>'],
|
||
\ }
|
||
<
|
||
|
||
*'g:ctrlp_mru_files'*
|
||
Set this to 0 to completely disable the Most Recently Used files feature: >
|
||
let g:ctrlp_mru_files = 1
|
||
<
|
||
|
||
*'g:ctrlp_mruf_max'*
|
||
Specify the number of recently opened files you want |CtrlP| to remember: >
|
||
let g:ctrlp_mruf_max = 50
|
||
<
|
||
|
||
*'g:ctrlp_mruf_exclude'*
|
||
Files you don’t want |CtrlP| to remember; use |regexp| to specify the patterns:
|
||
>
|
||
let g:ctrlp_mruf_exclude = ''
|
||
<
|
||
Examples: >
|
||
let g:ctrlp_mruf_exclude = '/tmp/.*\|/temp/.*' " MacOSX/Linux
|
||
let g:ctrlp_mruf_exclude = '^C:\\dev\\tmp\\.*' " Windows
|
||
<
|
||
|
||
*'g:ctrlp_mruf_include'*
|
||
And if you want |CtrlP| to only remember some files, specify them here: >
|
||
let g:ctrlp_mruf_include = ''
|
||
<
|
||
Example: >
|
||
let g:ctrlp_mruf_include = '\.py$\|\.rb$'
|
||
<
|
||
|
||
*'g:ctrlp_dotfiles'*
|
||
Set this to 0 if you don’t want |CtrlP| to search for dotfiles and dotdirs: >
|
||
let g:ctrlp_dotfiles = 1
|
||
<
|
||
You can also use |'wildignore'| to exclude anything from the search.
|
||
e.g. exclude version control directories from the results: >
|
||
set wildignore+=*/.git/*,*/.hg/*,*/.svn/* " Linux/MacOSX
|
||
set wildignore+=.git\*,.hg\*,.svn\* " Windows
|
||
<
|
||
Note: the `*/` in front of each dotfile glob is required for the dotfiles
|
||
search feature to work correctly along side with |wildignore|. If you’ve
|
||
disabled dotfiles search (set |g:ctrlp_dotfiles| to 0), then you can ignore
|
||
this.
|
||
|
||
*'g:ctrlp_highlight_match'*
|
||
Use this to enable/disable highlighting of the matched patterns and to specify
|
||
the highlight group that’ll be used: >
|
||
let g:ctrlp_highlight_match = [1, 'Function']
|
||
<
|
||
|
||
*'g:ctrlp_max_files'*
|
||
The maximum number of files to scan, set to 0 for no limit: >
|
||
let g:ctrlp_max_files = 20000
|
||
<
|
||
|
||
*'g:ctrlp_max_depth'*
|
||
The maximum depth of a directory tree to recurse into: >
|
||
let g:ctrlp_max_depth = 40
|
||
<
|
||
Note: the larger the value, the more memory Vim uses.
|
||
|
||
*'g:ctrlp_live_update'*
|
||
Set to 0 to disable the update-as-you-type functionality; press <c-^> to force
|
||
an update: >
|
||
let g:ctrlp_live_update = 1
|
||
<
|
||
|
||
*'g:ctrlp_user_command'*
|
||
Specify an external tool to use for indexing files instead of Vim’s globpath().
|
||
Use %s in place of the target directory: >
|
||
let g:ctrlp_user_command = ''
|
||
<
|
||
Examples: >
|
||
let g:ctrlp_user_command = 'find %s -type f' " MacOSX/Linux
|
||
let g:ctrlp_user_command = 'dir %s /-n /b /s /a-d' " Windows
|
||
<
|
||
You can also use 'grep', 'findstr' or something else to filter the results.
|
||
Examples: >
|
||
let g:ctrlp_user_command = 'find %s -type f | grep (?!tmp/.*)'
|
||
let g:ctrlp_user_command = 'dir %s /-n /b /s /a-d | findstr .*\.py$'
|
||
<
|
||
|
||
*'g:ctrlp_open_new_file'*
|
||
Use this option to specify how the newly created file is to be opened when
|
||
pressing <c-y>:
|
||
1 - in a new tab
|
||
2 - in a new horizontal split
|
||
3 - in a new vertical split
|
||
0 - in the current window/split
|
||
>
|
||
let g:ctrlp_open_new_file = 3
|
||
<
|
||
|
||
*'g:ctrlp_max_history'*
|
||
The maximum number of input strings you want |CtrlP| to remember. The default
|
||
value mirrors Vim’s global |'history'| option. E.g. `set history=50`: >
|
||
let g:ctrlp_max_history = &history
|
||
<
|
||
Set to 0 to disable prompt’s history.
|
||
|
||
*'g:ctrlp_open_multi'*
|
||
If non-zero this will enable opening multiple files with <c-z> and <c-o>: >
|
||
let g:ctrlp_open_multi = 0
|
||
<
|
||
If bigger than 1, it’ll be used as the maximum number of windows to create when
|
||
opening the files (the rest will be hidden buffers). If is 1, it’ll open all
|
||
files, each in a vertical split.
|
||
|
||
===============================================================================
|
||
3. Commands *ctrlp-commands*
|
||
|
||
*:CtrlP*
|
||
:CtrlP [starting-directory]
|
||
Open the |CtrlP| prompt in find files mode.
|
||
If no argument is given, the value of |g:ctrlp_working_path_mode| will be
|
||
used to determine the starting directory.
|
||
|
||
*:CtrlPBuffer*
|
||
:CtrlPBuffer
|
||
Open the |CtrlP| prompt in find buffers mode.
|
||
|
||
*:CtrlPMRUFiles*
|
||
:CtrlPMRUFiles
|
||
Open the |CtrlP| prompt in find Most-Recently-Used files mode.
|
||
|
||
*:ClearCtrlPCache*
|
||
:ClearCtrlPCache
|
||
Flush the cache for the current working directory. Same as pressing <F5>.
|
||
|
||
*:ClearAllCtrlPCaches*
|
||
:ClearAllCtrlPCaches
|
||
Delete all the cache files saved in |ctrlp_cache_dir|.
|
||
|
||
*:ResetCtrlP*
|
||
:ResetCtrlP
|
||
Reset all options, take in new values of the option variables (section 2).
|
||
|
||
The following commands ignore the value of |g:ctrlp_working_path_mode|:
|
||
|
||
*:CtrlPCurWD*
|
||
:CtrlPCurWD
|
||
Find files in the |current-directory| (without changing it).
|
||
|
||
*:CtrlPCurFile*
|
||
:CtrlPCurFile
|
||
Find files in the same directory as the current file, regardless of what the
|
||
|current-directory| is.
|
||
|
||
*:CtrlPRoot*
|
||
:CtrlPRoot
|
||
Same as |:CtrlPCurFile| but start from the project’s root.
|
||
Check |g:ctrlp_working_path_mode| to see how |CtrlP| finds a root.
|
||
|
||
===============================================================================
|
||
4. Mappings *ctrlp-mappings*
|
||
|
||
*'ctrlp-<c-p>'*
|
||
<c-p>
|
||
Default |Normal| mode mapping to open the |CtrlP| prompt.
|
||
|
||
Once inside the prompt:
|
||
|
||
<c-r> *'ctrlp-fullregexp'*
|
||
Toggle between the string mode (section 5.a & b) and full |regexp| mode.
|
||
(note: in full |regexp| mode, the prompt’s base is 'r>>' instead of '>>>')
|
||
|
||
See also |input-formats| and |g:ctrlp_regexp_search|.
|
||
|
||
<c-d>
|
||
Toggle between full path search and filename only search.
|
||
(note: in filename mode, the prompt’s base is '>d>' instead of '>>>')
|
||
|
||
<c-f>, 'forward'
|
||
<c-up>
|
||
Toggle between searching files and searching buffers. Or switch to the
|
||
'next' search type in the sequence; currently files, buffers and most
|
||
recently used files (MRU Files) are available.
|
||
|
||
<c-b>, 'backward'
|
||
<c-down>
|
||
Toggle between searching files and searching buffers. Or switch to the
|
||
'previous' search type in the sequence.
|
||
|
||
<tab>
|
||
Toggle the focus between the match window and the prompt.
|
||
|
||
<c-j>,
|
||
<down>
|
||
Move selection down
|
||
|
||
<c-k>,
|
||
<up>
|
||
Move selection up
|
||
|
||
<c-a>
|
||
Move the cursor to the 'start' of the prompt
|
||
|
||
<c-e>
|
||
Move the cursor to the 'end' of the prompt
|
||
|
||
<c-h>,
|
||
<left>
|
||
Move the cursor one character to the 'left'
|
||
|
||
<c-l>,
|
||
<right>
|
||
Move the cursor one character to the 'right'
|
||
|
||
<c-w>
|
||
Delete a preceding inner word
|
||
|
||
<c-u>
|
||
Clear the input field
|
||
|
||
<cr>
|
||
Open selected file with the method specified with |g:ctrlp_split_window|
|
||
|
||
<c-t>
|
||
Open selected file in a new 'tab'
|
||
|
||
<c-v>
|
||
Open selected file in a 'vertical' split
|
||
|
||
<c-cr>,
|
||
<c-s>,
|
||
<c-x>
|
||
Open selected file in a 'horizontal' split
|
||
|
||
<c-y>
|
||
Create a new file and its parent directories.
|
||
|
||
<c-n>
|
||
'Next' string in the prompt’s history (of accepted input strings)
|
||
|
||
<c-p>
|
||
'Previous' string in the prompt’s history
|
||
|
||
<c-z>
|
||
Mark/unmark a file to be opened with <c-o>.
|
||
|
||
<c-o>
|
||
Open files marked by <c-z>.
|
||
|
||
<F5>
|
||
Refresh the match window and purge the cache for the current directory.
|
||
|
||
<c-^>
|
||
Force update the match window.
|
||
You only need to use this if |g:ctrlp_live_update| has been set to 0.
|
||
|
||
<esc>,
|
||
<c-c>,
|
||
<c-g>
|
||
Exit |CtrlP|. <c-c> can also be used to stop the files scan.
|
||
|
||
Chose your own mappings with |g:ctrlp_prompt_mappings|.
|
||
|
||
When inside the match window (press <tab> to switch):
|
||
|
||
a-z
|
||
0-9
|
||
~^-=;`',.+!@#$%&_(){}[]
|
||
Cycle through the lines with the first letter (of paths or filenames) that
|
||
matches that key.
|
||
|
||
===============================================================================
|
||
5. Input Formats *ctrlp-input-formats*
|
||
|
||
*ctrlp-prompt-input-formats*
|
||
Formats for inputting in the prompt:
|
||
|
||
a) Simple string. e.g. 'abc' is understood internally as 'a[^a]\{-}b[^b]\{-}c'
|
||
|
||
b) Vim |regexp|. If the input string contains '*' or '|', it’ll be treated as
|
||
a Vim’s |regexp| |pattern| without any modification.
|
||
e.g. 'abc\d*efg' will be read as 'abc\d*efg'.
|
||
|
||
See also |ctrlp-fullregexp| and |g:ctrlp_regexp_search|.
|
||
|
||
c) End the string with a colon ':' followed by a Vim command to execute that
|
||
command after opening the file. If you need to use ':' in the command,
|
||
escape it with a backslash: '\:'.
|
||
e.g. 'abc:45' will open the selected file and jump to line 45.
|
||
'abc:/my\:function' will open the selected file and jump to the first
|
||
instance of 'my:function'.
|
||
'abc:+setf\ myfiletype|50' will open the selected file and set its
|
||
filetype to 'myfiletype' then jump to line 50.
|
||
|
||
See also |++opt| and |+cmd|.
|
||
|
||
d) Type exactly two dots (..) at the start of the line and press enter to go
|
||
backward in the directory tree by 1 level. If the parent directory is
|
||
large, this might be slow.
|
||
|
||
e) Type the name of a non-existed file and press <c-y> to create it.
|
||
e.g. 'parentdir/file.txt' will create a directory named 'parentdir' as well
|
||
as 'file.txt'. Use '\' in place of '/' on Windows (if |'ssl'| is not set).
|
||
|
||
===============================================================================
|
||
6. Credits *ctrlp-credits*
|
||
|
||
Developed by Kien Nguyen (github.com/kien), based on the Command-T and the
|
||
LustyExplorer plugins. No code was taken from these plugins, but I did clone
|
||
the majority of their (awesome) interfaces and the way they work.
|
||
|
||
This was originally written as a module for a would-be larger plugin called
|
||
AutoDoc.vim which I’ve stopped developing because of lost of interest. I really
|
||
liked the way Command-T and LustyExplorer deal with user’s input, so I wrote a
|
||
pure Vimscript version of their prompt window, intended to use it for the
|
||
aforementioned plugin.
|
||
|
||
Git repository: https://github.com/kien/ctrlp.vim
|
||
Mercurial repository: https://bitbucket.org/kien/ctrlp.vim
|
||
|
||
===============================================================================
|
||
CHANGELOG
|
||
|
||
+ New features: Open multiple files.
|
||
Pass Vim’s ++opt and +cmd to the opening file (section 5.c)
|
||
+ New mappings: <c-z> mark/unmark a file to be opened with <c-o>.
|
||
<c-o> open all marked files.
|
||
+ New option: |g:ctrlp_open_multi|
|
||
|
||
Before 2011/09/29
|
||
|
||
+ New mappings: <c-n>, <c-p> next/prev string in the input history.
|
||
<c-y> create new file and its parent dirs.
|
||
+ New options: |g:ctrlp_open_new_file|,
|
||
|g:ctrlp_max_history|
|
||
+ Added a new open-in-horizontal-split mapping: <c-x>
|
||
|
||
Before 2011/09/19
|
||
|
||
+ New command: |ResetCtrlP|
|
||
+ New options: |g:ctrlp_max_files|,
|
||
|g:ctrlp_max_depth|,
|
||
|g:ctrlp_live_update|
|
||
+ New mapping: <c-^>
|
||
|
||
Before 2011/09/12
|
||
|
||
+ Ability to cycle through matched lines in the match window.
|
||
+ Extended the behavior of |g:ctrlp_persistent_input|
|
||
+ Extended the behavior of |:CtrlP|
|
||
+ New options: |g:ctrlp_dotfiles|,
|
||
|g:ctrlp_clear_cache_on_exit|,
|
||
|g:ctrlp_highlight_match|,
|
||
|g:ctrlp_user_command|
|
||
+ New input format: '..' (section 5.d)
|
||
+ New mapping: <F5>.
|
||
+ New commands: |:CtrlPCurWD|,
|
||
|:CtrlPCurFile|,
|
||
|:CtrlPRoot|
|
||
|
||
+ New feature: Search in most recently used (MRU) files
|
||
+ New mapping: <c-b>.
|
||
+ Extended the behavior of <c-f>.
|
||
+ New options: |g:ctrlp_mru_files|,
|
||
|g:ctrlp_mruf_max|,
|
||
|g:ctrlp_mruf_exclude|,
|
||
|g:ctrlp_mruf_include|
|
||
+ New command: |:CtrlPMRUFiles|
|
||
|
||
===============================================================================
|
||
vim:et:ts=2:sw=2:sts=2
|