bufexplorer-7.4.2

*bufexplorer.txt* Buffer Explorer Last Change: 22 Oct 2013 Buffer Explorer *buffer-explorer* *bufexplorer* Version 7.4.2 Plugin for easily exploring (or browsing) Vim|:buffers|. |bufexplorer-installation| Installation |bufexplorer-usage| Usage |bufexplorer-windowlayout| Window Layout |bufexplorer-customization| Customization |bufexplorer-changelog| Change Log |bufexplorer-todo| Todo |bufexplorer-credits| Credits |bufexplorer-copyright| Copyright For Vim version 7.0 and above. This plugin is only available if 'compatible' is not set. {Vi does not have any of this} ============================================================================== INSTALLATION *bufexplorer-installation* To install: - Download the bufexplorer.zip from one of the following places: https://github.com/jlanzarotta/bufexplorer http://www.vim.org/scripts/script.php?script_id=42 or use a package manager like Vundle. - Extract the zip archive into your runtime directory. The archive contains plugin/bufexplorer.vim, and doc/bufexplorer.txt. - Start Vim or goto an existing instance of Vim. - Execute the following command: > :helptag <your runtime directory>/doc < This will generate all the help tags for any file located in the doc directory. ============================================================================== USAGE *bufexplorer-usage* To start exploring in the current window, use: > \be or :BufExplorer or Your custom key mapping To start exploring in a newly split horizontal window, use: > \bs or :BufExplorerHorizontalSplit or Your custom key mapping To start exploring in a newly split vertical window, use: > \bv or :BufExplorerVerticalSplit or Your custom key mapping If you would like to use something other than '\', you may simply change the leader (see |mapleader|). Note: If the current buffer is modified when bufexplorer started, the current window is always split and the new bufexplorer is displayed in that new window. Commands to use once exploring: <F1> Toggle help information. <enter> Opens the buffer that is under the cursor into the current window. <leftmouse> Opens the buffer that is under the cursor into the current window. <shift-enter> Opens the buffer that is under the cursor in another tab. b Fast buffer switching with b<any bufnum>. B Works in association with the|ShowTabBuffer|option. If |ShowTabBuffer|is set to 1, this toggles if BufExplorer is to only store the most recent tab for this buffer or not. d |:delete|the buffer under the cursor from the list. The buffer's 'buflisted' is cleared. This allows for the buffer to be displayed again using the 'show unlisted' command. D |:wipeout|the buffer under the cursor from the list. When a buffers is wiped, it will not be shown when unlisted buffer are displayed. f Toggles whether you are taken to the active window when selecting a buffer or not. o Opens the buffer that is under the cursor into the current window. p Toggles the showing of a split filename/pathname. q Exit/Close bufexplorer. r Reverses the order the buffers are listed in. R Toggles relative path/absolute path. s Cycle thru how the buffers are listed. Either by buffer number, file name, file extension, most recently used (MRU), or full path. S Cycle thru how the buffers are listed, in reverse order. Either by buffer number, file name, file extension, most recently used (MRU), or full path. t Opens the buffer that is under the cursor in another tab. T Toggles to show only buffers for this tab or not. u Toggles the showing of "unlisted" buffers. Once invoked, Buffer Explorer displays a sorted list (MRU is the default sort method) of all the buffers that are currently opened. You are then able to move the cursor to the line containing the buffer's name you are wanting to act upon. Once you have selected the buffer you would like, you can then either open it, close it(delete), resort the list, reverse the sort, quit exploring and so on... =============================================================================== WINDOW LAYOUT *bufexplorer-windowlayout* ------------------------------------------------------------------------------- " Press <F1> for Help " Sorted by mru | Locate buffer | Absolute Split path "= 1 %a bufexplorer.txt C:\Vim\vimfiles\doc line 87 2 # bufexplorer.vim c:\Vim\vimfiles\plugin line 1 ------------------------------------------------------------------------------- | | | | | | | | | +-- Current Line #. | | | +-- Relative/Full Path | | +-- Buffer Name. | +-- Buffer Attributes. See|:buffers|for more information. +-- Buffer Number. See|:buffers|for more information. =============================================================================== CUSTOMIZATION *bufexplorer-customization* If you do not like the default key mappings of \be, \bs, and \bv, you can override bufexplorer's default mappings by setting up something like the following in your vimrc file: noremap <silent> <F11> :BufExplorer<CR> noremap <silent> <m-F11> :BufExplorerHorizontalSplit<CR> noremap <silent> <c-F11> :BufExplorerVerticalSplit<CR> *g:bufExplorerChgWin* If set, bufexplorer will bring up the selected buffer in the window specified by g:bufExplorerChgWin. *g:bufExplorerDefaultHelp* To control whether the default help is displayed or not, use: > let g:bufExplorerDefaultHelp=0 " Do not show default help. let g:bufExplorerDefaultHelp=1 " Show default help. The default is to show the default help. *g:bufExplorerDisableDefaultKeyMapping* To control whether the default key mappings are enabled or not, use: > let g:bufExplorerDisableDefaultKeyMapping=0 " Do not disable mapping. let g:bufExplorerDisableDefaultKeyMapping=1 " Disable mapping. The default is NOT to disable the default key mapping. *g:bufExplorerDetailedHelp* To control whether detailed help is display by, use: > let g:bufExplorerDetailedHelp=0 " Do not show detailed help. let g:bufExplorerDetailedHelp=1 " Show detailed help. The default is NOT to show detailed help. *g:bufExplorerFindActive* To control whether you are taken to the active window when selecting a buffer, use: > let g:bufExplorerFindActive=0 " Do not go to active window. let g:bufExplorerFindActive=1 " Go to active window. The default is to be taken to the active window. *g:bufExplorerFuncRef* When a buffer is selected, the functions specified either singly or as a list will be called. *g:bufExplorerReverseSort* To control whether to sort the buffer in reverse order or not, use: > let g:bufExplorerReverseSort=0 " Do not sort in reverse order. let g:bufExplorerReverseSort=1 " Sort in reverse order. The default is NOT to sort in revers