Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kien committed May 10, 2012
1 parent 3e83d62 commit 9c9e120
Showing 1 changed file with 19 additions and 12 deletions.
31 changes: 19 additions & 12 deletions readme.md
Expand Up @@ -5,26 +5,27 @@ Full path fuzzy __file__, __buffer__, __mru__ and __tag__ finder for Vim.
* Full support for Vim’s regexp as search pattern.
* Built-in Most Recently Used (MRU) files monitoring.
* Built-in project’s root finder.
* Open Multiple Files.
* Open multiple files at once.
* Create new files and directories.
* [Extensible][3].

![ctrlp][1]

## Basic Usage
* Press `<c-p>` or run `:CtrlP` to invoke CtrlP in find file mode.
* 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.
* Or run `:CtrlPMixed` to search in a mix of files, buffers and MRU files.
* Run `:CtrlPMixed` to search in a mix of files, buffers and MRU files.

Once CtrlP is open:

* Press `<c-f>` and `<c-b>` to switch between find file, buffer, and MRU file
modes.
* Press `<c-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 after
opening the file.
e.g. `abc:45` will open the file matched the pattern and jump to line 45.
* End the input string with a colon `:` followed by a command to execute it after
opening the file:
Use `:45` to open selected file and jump to line 45.
Use `:difft` to open the marked files and run `:difft` on the first 4 files.
* Submit two dots `..` as the input string to go backward the directory tree by
1 level.
* Use `<c-y>` to create a new file and its parent dirs.
Expand All @@ -37,15 +38,15 @@ e.g. `abc:45` will open the file matched the pattern and jump to line 45.
let g:ctrlp_map = '<c-p>'
```

* When CtrlP is invoked, it automatically sets its local working directory
according to this variable:
* When invoked, unless a path is specified, CtrlP will automatically set its
local working directory according to this variable:

```vim
let g:ctrlp_working_path_mode = 2
```

0 - don’t manage working directory.
1 - the parent directory of the current file.
1 - the directory of the current file.
2 - the nearest ancestor that contains one of these directories or files:
`.git/` `.hg/` `.svn/` `.bzr/` `_darcs/`

Expand All @@ -64,13 +65,19 @@ option `wildignore` and/or the option `g:ctrlp_custom_ignore`. Examples:
\ }
```

* Use a custom file listing command with:
* Use a custom file listing command:

```vim
let g:ctrlp_user_command = 'find %s -type f' " MacOSX/Linux
let g:ctrlp_user_command = 'dir %s /-n /b /s /a-d' " Windows
```

* Define an external matcher:

```vim
let g:ctrlp_match_func = {}
```

_Check [the docs][2] for more mappings, commands and options._

[1]: http://i.imgur.com/yIynr.png
Expand Down

0 comments on commit 9c9e120

Please sign in to comment.