*bufexplorer.txt*  Buffer Explorer  December 17, 2001

Buffer Explorer                                *buffer-explorer* *bufexplorer*

Plugin for easilty exploring open buffers

|bufexplorer-usage|          Usage
|bufexplorer-customization|  Customization
|add-local-help|             How to add this help file to vim's help
|bufexplorer-changelog|      Change Log
|bufexplorer-todo|           Todo
|bufexplorer-credits|        Credits

==============================================================================
Usage                                                      *bufexplorer-usage*

To start exploring in the current window, use:
 \be  or  :BufExplorer
To start exploring in a newly split window, use:
 \be  or  :SBufExplorer

Note: If the current buffer is modified, the current window is always
      split.

Command to use once exploring:

 <cr> or       Opens the buffer that is under the cursor into the current
 <leftmouse>   window.
 d             Deletes the buffer from the list that is under the cursor.
 p             Toggles the showing of a split filename/pathname.
 q             Quit exploring.
 s             Selects the order the buffers are listed in. Either by their
               name, by their number or by most recently used.
 r             Reverses the order the buffers are listed in.
 ?             Displays help information.

Typically one would put bufexplorer.vim into the .vim/plugin directory
(vimfiles\plugin for Windows) where it becomes automatically available
for use. It sets up it's default keymaps to use \be and \bs. If you would
like to use something other than '\', you may simply change the leader
(see |mapleader|).

Once involked, Buffer Explorer display a sorted list 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 apone. 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 explorering
and so on...

You can avoid loading this plugin by setting the "loaded_bufexplorer"
variable:
  :let loaded_bufexplorer = 1

===============================================================================
Customization                                       *bufexplorer-customization*

                                                    *g:bufExplorerDetailedHelp*
To control whether detailed help is display by, use:
  let g:bufExplorerDetailedHelp=1
The default is not to show detailed help.
                                                    *g:bufExplorerSortBy*
To control what field the buffers are sorted by, use:
  let g:bufExplorerSortBy='number'     " Sort by the buffer's number.
  let g:bufExplorerSortBy='name'       " Sort by the buffer's name.
  let g:bufExplorerSortBy='mru'        " Sort by most recently used.
The default is to sort by number.
                                                    *g:bufExplorerSplitBelow*
To control where the new split window will be placed above or below the
current window, use:
  let g:bufExplorerSplitBelow=1        " Split new window below current.
  let g:bufExplorerSplitBelow=0        " Split new window above current.
The default it to use what ever is set by the global &splitbelow
variable.

To control whether to sort the buffers in forward or reverse order, use:
  let g:bufExplorerSortDirection=1     " Sort in forward order.
  let g:bufExplorerSortDirection=-1    " Sort in reverse order.

To control whether to split out the path and file name or not, use:
  let g:bufExplorerSplitOutPathName=1  " Split the path and file name.
  let g:bufExplorerSplitOutPathName=-1 " Don't split the path and file
                                       " name.

===============================================================================
Change Log                                              *bufexplorer-changelog*

6.0.9 - Added MRU (Most Recently Used) sort ordering.
6.0.8 - Was not resetting the showcmd command correctly.
        Added nifty help file.
6.0.7 - Thanks to Brett Carlane for some great enhancements. Some are added,
        some are not, yet. Added highlighting of current and alternate
        filenames. Added spliting of path/filename toggle. Reworked
        ShowBuffers().
        Changed my email address.
6.0.6 - Copyright notice added. Fixed problem with the SortListing() function
        failing when there was only one buffer to display.
6.0.5 - Fixed problems reported by David Pascoe, in that you where unable to
        hit 'd' on a buffer that belonged to a files that nolonger existed
        and that the 'yank' buffer was being overridden by the help text when
        the bufexplorer was opened.
6.0.4 - Thanks to Charles Campbell for making this plugin more plugin
        *compliant*, adding default keymappings of <Leader>be and <Leader>bs
        as well as fixing the 'w:sortDirLabel not being defined' bug.
6.0.3 - Added sorting capabilities. Sort taken from explorer.vim.
6.0.2 - Can't remember.

===============================================================================
Todo                                                         *bufexplorer-todo*

None at this time.

===============================================================================
Credits                                                   *bufexplorer-credits*

Author: Jeff Lanzarotta <jefflanzarotta@yahoo.com>

With help and suggestions from: Charles Campbell
                                Brett Carlane


vim:tw=78:ts=8:ft=help