dotfiles: vim/vimfiles/doc/ctrlp.txt comparison

comparison vim/vimfiles/doc/ctrlp.txt @ 3:92af3257a261

Update to latest ctrlp.vim.

author	Brian Neal <bgneal@gmail.com>
date	Wed, 04 Jan 2012 19:37:22 -0600
parents	48859d9c82c5
children

comparison

equal deleted inserted replaced

-:611e13daeafb
+:92af3257a261
-*ctrlp.txt*       Fuzzy file, buffer, mru and tag finder. v1.6.4
+*ctrlp.txt*       Fuzzy file, buffer, mru and tag finder. v1.6.5
 *CtrlP* *ControlP* *'ctrlp'* *'ctrl-p'*
 ===============================================================================
 #                                                                             #
 #          :::::::: ::::::::::: :::::::::  :::             :::::::::          #
 #         :+:    :+:    :+:     :+:    :+: :+:             :+:    :+:         #
 6. Extensions...................................|ctrlp-extensions|
 ===============================================================================
 1. Intro                                                          *ctrlp-intro*
-Full path fuzzy file, buffer and MRU file finder with an intuitive interface.
+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 monitoring, project’s root
+Vim’s |regexp| as search pattern, built-in MRU files monitoring, project’s root
 finder, and more.
 To enable optional extensions (tag, quickfix, dir...), see |ctrlp-extensions|.
 ===============================================================================
 *'g:ctrlp_map'*
 Use this option to change the mapping to invoke |CtrlP| in |Normal| mode: >
 let g:ctrlp_map = '<c-p>'
 <
+*'g:ctrlp_cmd'*
+Set the default opening command to use when pressing the above mapping: >
+let g:ctrlp_cmd = 'CtrlP'
+<
 *'g:loaded_ctrlp'*
-Use this option to disable the plugin completely: >
+Use this 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: >
 Set the maximum height of the match window: >
 let g:ctrlp_max_height = 10
 <
 *'g:ctrlp_jump_to_buffer'*
-Set this to 0 to disable the jump-to-open-buffer feature. Set to 2 to also jump
+Set this to 0 to disable the jump-to-open-buffer feature.
-tab if the selected buffer’s opened in another tab: >
+Set to 2 to also jump tab if the selected buffer’s opened in another tab.
-let g:ctrlp_jump_to_buffer = 1
+Set to 1 to only jump to it if it’s opened in the current tab: >
+let g:ctrlp_jump_to_buffer = 2
 <
 *'g:ctrlp_working_path_mode'*
 When starting up the prompt, temporarily set the working directory (i.e. the
 |current-directory|) to:
 \ 'AcceptSelection("t")': ['<c-t>', '<MiddleMouse>'],
 \ 'AcceptSelection("v")': ['<c-v>', '<c-q>', '<RightMouse>'],
 \ 'ToggleFocus()':        ['<tab>'],
 \ 'ToggleRegex()':        ['<c-r>'],
 \ 'ToggleByFname()':      ['<c-d>'],
-\ 'ToggleType(1)':        ['<c-f>', '<c-up'],
+\ 'ToggleType(1)':        ['<c-f>', '<c-up>'],
 \ 'ToggleType(-1)':       ['<c-b>', '<c-down>'],
 \ 'PrtCurStart()':        ['<c-a>'],
 \ 'PrtCurEnd()':          ['<c-e>'],
 \ 'PrtCurLeft()':         ['<c-h>', '<left>'],
 \ 'PrtCurRight()':        ['<c-l>', '<right>'],
 *'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.
+You can use |'wildignore'| to exclude anything from the search.
-e.g. exclude version control directories from the results: >
+e.g. exclude version control directories: >
 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
+Note: the `*/` in front of each glob is required.
-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.
 Other note: |wildignore| influences the result of |expand()|, |globpath()| and
 |glob()| which many plugins use to find stuff on the system (e.g. fugitive.vim
 looks for .git/, some other plugins look for external exe tools on Windows).
 So be a little mindful of what you put in your |wildignore|.
+*'g:ctrlp_custom_ignore'*
+In addition to |'wildignore'|, use this for files and directories you want only
+|CtrlP| to not show. Use |regexp| to specify the pattern: >
+let g:ctrlp_custom_ignore = ''
+<
 *'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, 'Identifier']
 d)  Type exactly two dots '..' at the start of the prompt and press enter to go
 backward in the directory tree by 1 level. If the parent directory is
 large, this might be slow.
-e)  Similarly submit '/' or '\' to find and go to the project’s root. If the
+e)  Similarly, submit '/' or '\' to find and go to the project’s root. If the
 project is large, using a VCS listing command to look for files might help
 speeding up the intial scan (see |g:ctrlp_user_command| for more details).
 f)  Type the name of a non-existent file and press <c-y> to create it.
 e.g. 'parentdir/file.txt' will create a directory named 'parentdir' as well
 ===============================================================================
 6. Extensions                                              *g:ctrlp-extensions*
 Extensions are optional. To enable an extension, add its name to the variable
 g:ctrlp_extensions: >
-let g:ctrlp_extensions = ['tag', 'quickfix', 'dir']
+let g:ctrlp_extensions = ['tag', 'buffertag', 'quickfix', 'dir']
 <
 The order of the items will be the order they appear on the statusline and when
 using <c-f>, <c-b>.
 Available extensions:~
 - Name: 'tag'
 - 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). Example: `set tags+=tags/help,doc/tags`
+*:CtrlPBufTag*
+* Buffer Tag mode:~
+- Name: 'buffertag'
+- Command: ':CtrlPBufTag'
+- Search for a tag within the current buffer and jump to the definition.
+Requires |exuberant_ctags|.
 *:CtrlPQuickfix*
 * Quickfix mode:~
 - Name: 'quickfix'
 - Command: ':CtrlPQuickfix'
 + <c-t> change the global working directory (exit).
 + <c-v> change the local working directory for the current window (exit).
 + <c-x> change the global working directory to |CtrlP|’s current local
 working directory (exit).
+-------------------------------------------------------------------------------
+Buffer Tag mode options:~
+*'g:ctrlp_buftag_ctags_bin'*
+If ctags isn’t in your $PATH, use this to set its location: >
+let g:ctrlp_buftag_ctags_bin = ''
+<
+*'g:ctrlp_buftag_systemenc'*
+Match this with your OS’s encoding (not Vim’s). The default value mirrors Vim’s
+global |'encoding'| option: >
+let g:ctrlp_buftag_systemenc = &encoding
+<
+*'g:ctrlp_buftag_types'*
+Use this to set the arguments for ctags, jsctags... for a given filetype: >
+let g:ctrlp_buftag_types = ''
+<
+Examples: >
+let g:ctrlp_buftag_types = {
+\ 'erlang'     : '--language-force=erlang --erlang-types=drmf',
+\ 'javascript' : {
+\ 'bin': 'jsctags',
+\ 'args': '-f -',
+\ },
+\ }
+<
 ===============================================================================
 EXTENDING                                                     *ctrlp-extending*
 Extending |CtrlP| is very simple. Simply create a vim file following a short
 guidelines, place it in autoload/ctrlp/ and add its name to your .vimrc.
 * Yasuhiro Matsumoto <github.com/mattn>
 Added option to use Migemo for Japanese language.
 ===============================================================================
 CHANGELOG                                                     *ctrlp-changelog*
++ New feature: Buffer Tag extension.
++ New command: |:CtrlPBufTag|.
++ New options: |g:ctrlp_cmd|,
+|g:ctrlp_custom_ignore|
 Before 2011/11/30~
 + New features: Tag, Quickfix and Directory extensions.
 + New commands: |:CtrlPTag|, |:CtrlPQuickfix|, |:CtrlPDir|.

Mercurial > public > dotfiles

comparison vim/vimfiles/doc/ctrlp.txt @ 3:92af3257a261