Update docs
This commit is contained in:
Kien N
parent
4645d04a3c
commit
4b9c014460
@ -1,6 +1,6 @@
|
||||
" =============================================================================
|
||||
" File: autoload/ctrlp.vim
|
||||
" Description: Fuzzy file, buffer, mru and tag finder.
|
||||
" Description: Fuzzy file, buffer, mru, tag, etc finder.
|
||||
" Author: Kien Nguyen <github.com/kien>
|
||||
" Version: 1.7.7
|
||||
" =============================================================================
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
*ctrlp.txt* Fuzzy file, buffer, mru and tag finder. v1.7.7
|
||||
*ctrlp.txt* Fuzzy file, buffer, mru, tag, ... finder. v1.7.7
|
||||
*CtrlP* *ControlP* *'ctrlp'* *'ctrl-p'*
|
||||
===============================================================================
|
||||
# #
|
||||
@ -23,10 +23,10 @@ CONTENTS *ctrlp-contents*
|
||||
===============================================================================
|
||||
INTRO *ctrlp-intro*
|
||||
|
||||
Full path fuzzy file, buffer, mru and tag 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, built-in MRU files monitoring, project's root
|
||||
finder, and more.
|
||||
Full path fuzzy file, buffer, mru, tag, ... finder with an intuitive interface.
|
||||
Written in pure Vimscript for MacVim, gVim and Vim version 7.0+. Has full
|
||||
support for Vim's |regexp| as search pattern, built-in MRU files monitoring,
|
||||
project's root finder, and more.
|
||||
|
||||
To enable optional extensions (tag, dir, rtscript...), see |ctrlp-extensions|.
|
||||
|
||||
@ -152,14 +152,14 @@ variable: >
|
||||
<
|
||||
1 - the directory of the current file.
|
||||
2 - the nearest ancestor that contains one of these directories or files:
|
||||
.git/ .hg/ .svn/ .bzr/ _darcs/
|
||||
.git .hg .svn .bzr _darcs
|
||||
0 - don't manage working directory.
|
||||
Note: you can use b:ctrlp_working_path_mode (a |b:var|) to set this option on a
|
||||
per buffer basis.
|
||||
|
||||
*'g:ctrlp_root_markers'*
|
||||
Use this to set your own root markers in addition to the default ones (.git/,
|
||||
.hg/, .svn/, .bzr/, and _darcs/). Your markers will take precedence: >
|
||||
Use this to set your own root markers in addition to the default ones (.git,
|
||||
.hg, .svn, .bzr, and _darcs). Your markers will take precedence: >
|
||||
let g:ctrlp_root_markers = ['']
|
||||
<
|
||||
|
||||
@ -751,8 +751,8 @@ c) End the string with a colon ':' followed by a Vim command to execute that
|
||||
|
||||
See also: Vim's |++opt| and |+cmd|.
|
||||
|
||||
d) Submit two dots '..' to go backward the directory tree by 1 level. To go
|
||||
backward multiple levels, use one extra dot for each extra level:
|
||||
d) Submit two dots '..' to go upward the directory tree by 1 level. To go up
|
||||
multiple levels, use one extra dot for each extra level:
|
||||
>
|
||||
Raw input Interpreted as
|
||||
.. ../
|
||||
@ -1029,11 +1029,10 @@ Special thanks:~
|
||||
===============================================================================
|
||||
CHANGELOG *ctrlp-changelog*
|
||||
|
||||
Before 2012/06/15~
|
||||
|
||||
+ New value for |g:ctrlp_open_multiple_files|: 'j'.
|
||||
+ Allow using <c-t>, <c-x>, <c-v> to open files marked by <c-z>.
|
||||
|
||||
Before 2012/05/15~
|
||||
|
||||
+ Extend '..' (|ctrlp-input-formats| (d))
|
||||
+ New input format: '@cd' (|ctrlp-input-formats| (d))
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
" =============================================================================
|
||||
" File: plugin/ctrlp.vim
|
||||
" Description: Fuzzy file, buffer, mru and tag finder.
|
||||
" Description: Fuzzy file, buffer, mru, tag, etc finder.
|
||||
" Author: Kien Nguyen <github.com/kien>
|
||||
" =============================================================================
|
||||
" GetLatestVimScripts: 3736 1 :AutoInstall: ctrlp.zip
|
||||
|
||||
94
readme.md
94
readme.md
@ -1,58 +1,69 @@
|
||||
# ctrlp.vim
|
||||
Full path fuzzy __file__, __buffer__, __mru__ and __tag__ finder for Vim.
|
||||
Fuzzy __file__, __buffer__, __mru__, __tag__, ... finder for Vim.
|
||||
|
||||
* Written in pure Vimscript for MacVim and Vim 7.0+.
|
||||
* Full support for Vim’s regexp as search pattern.
|
||||
* Written in pure Vimscript for MacVim, gVim and Vim 7.0+.
|
||||
* Full support for Vim's regexp as search patterns.
|
||||
* Built-in Most Recently Used (MRU) files monitoring.
|
||||
* Built-in project’s root finder.
|
||||
* Built-in project's root finder.
|
||||
* Open multiple files at once.
|
||||
* Create new files and directories.
|
||||
* [Extensible][3].
|
||||
* [Extensible][2].
|
||||
|
||||
![ctrlp][1]
|
||||
|
||||
## Basic Usage
|
||||
* 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 `:CtrlPMixed` to search in a mix of files, buffers and MRU files.
|
||||
## Installation
|
||||
1. Clone the plugin into a separate directory:
|
||||
|
||||
Once CtrlP is open:
|
||||
|
||||
* Press `<c-f>` and `<c-b>` to cycle between 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 it
|
||||
after opening the file:
|
||||
Use `:45` to jump to line 45.
|
||||
Use `:/any\:string` to jump to the first instance of `any:string`.
|
||||
Use `:difft` when opening multiple files to run `:difft` on the first 4 files.
|
||||
* Submit two or more dots `.` as the input string to go backward the directory
|
||||
tree by one or multiple levels.
|
||||
* 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>'
|
||||
```
|
||||
$ cd ~/.vim
|
||||
$ git clone https://github.com/kien/ctrlp.vim.git bundle/ctrlp.vim
|
||||
```
|
||||
|
||||
* When invoked, unless a starting directory is specified, CtrlP will
|
||||
automatically set its local working directory according to this variable:
|
||||
2. Add to your `~/.vimrc`:
|
||||
|
||||
```vim
|
||||
set runtimepath^=~/.vim/bundle/ctrlp.vim
|
||||
```
|
||||
|
||||
3. Run at Vim's command line:
|
||||
|
||||
```
|
||||
:helptags ~/.vim/bundle/ctrlp.vim/doc
|
||||
```
|
||||
|
||||
4. Restart Vim and start reading `:help ctrlp.txt` for usage and configuration details.
|
||||
|
||||
On Windows, use the `$HOME/vimfiles` or the `$VIM/vimfiles` directory instead of the `~/.vim` directory.
|
||||
|
||||
## Usage
|
||||
1. See `:help ctrlp-commands` and `:help ctrlp-extensions`.
|
||||
2. Once the prompt's open:
|
||||
* Press `<c-f>` and `<c-b>` to cycle between modes.
|
||||
* Press `<c-d>` to switch to filename only search instead of full path.
|
||||
* Press `<F5>` to purge the cache for the current directory and get new files.
|
||||
* Submit two or more dots `..` to go up the directory tree by one or multiple levels.
|
||||
* Use `<c-n>`, `<c-p>` to go to the next/previous string in the prompt's history.
|
||||
* 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.
|
||||
* End the input string with a colon `:` followed by a command to execute it on the opening file(s).
|
||||
|
||||
More at `:help ctrlp-mappings`.
|
||||
|
||||
## Configuration
|
||||
* Unless a starting directory is specified, the local working directory will be set according to this variable:
|
||||
|
||||
```vim
|
||||
let g:ctrlp_working_path_mode = 2
|
||||
```
|
||||
|
||||
0 - don’t manage working directory.
|
||||
0 - don't manage working directory.
|
||||
1 - the directory of the current file.
|
||||
2 - the nearest ancestor that contains one of these directories or files:
|
||||
`.git/` `.hg/` `.svn/` `.bzr/` `_darcs/`
|
||||
`.git` `.hg` `.svn` `.bzr` `_darcs`
|
||||
|
||||
* To exclude files or directories from the search, use the Vim’s option
|
||||
`wildignore` and/or the option `g:ctrlp_custom_ignore`:
|
||||
Define additional root markers with the `g:ctrlp_root_markers` option.
|
||||
|
||||
* Exclude files and directories:
|
||||
|
||||
```vim
|
||||
set wildignore+=*/tmp/*,*.so,*.swp,*.zip " MacOSX/Linux
|
||||
@ -73,14 +84,7 @@ automatically set its local working directory according to this variable:
|
||||
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._
|
||||
More at `:help ctrlp-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
|
||||
[2]: https://github.com/kien/ctrlp.vim/tree/extensions
|
||||
|
||||
Loading…
Reference in New Issue
Block a user