dmenu.vim

dmenu functions for vim
git clone git://edryd.org/dmenu.vim
Log | Files | Refs

README.md (2477B)


      1 # dmenu.vim
      2 
      3 A small vim plugin which provides a few commands for dmenu use in vim.
      4 
      5 To open a file in vim with dmenu use the following, where the argument can be
      6 any vim command, such as e, sp, vsp, etc.
      7 
      8 	:DmenuFile "e"
      9 
     10 To switch to a currently open buffer use the following, with again any vim
     11 command.
     12 
     13 	:DmenuBuf "e"
     14 
     15 Run the following command to jump to a function or variable using ctags.
     16 Currently it creates a tags file every time you run it, but hopefully this is
     17 only temporary and it will simply create tags when needed in memory.
     18 
     19 	:DmenuTag
     20 
     21 ## Configuration
     22 
     23 To change the default dmenu command put the following in your `.vimrc`
     24 
     25 	let g:dmenu_cmd = 'dmenu -i -l 20'
     26 
     27 To change the default file list command put the following in your `.vimrc`
     28 
     29 	let g:dmenu_ls = 'find -type f -printf "%P\n" | tail -n +2'
     30 
     31 To change the default git file list command put the following in your `.vimrc`
     32 
     33 	let g:dmenu_git_ls = 'git ls-files'
     34 
     35 To change the default ctags command put the following in your `.vimrc`
     36 
     37 	let g:dmenu_ctags = 'ctags -f - --sort=no -R . | cut -f 1'
     38 
     39 ## Installation
     40 
     41 ### 1. Put Files Into Root of the `.vim` Directory (Not Recommended)
     42 
     43 Without a plug-in manger (like the ones below) you have to manually put each
     44 file/folder (plugin/, doc/, autoload/, etc.) into the root of your .vim folder.
     45 I highly recommend that you use one of the plug-in mangers below for less
     46 manual work and easier organization.
     47 
     48 ### 2. Pathogen, by tpope
     49 
     50 To use [Pathogen](https://github.com/tpope/vim-pathogen) you first have to
     51 install it. After the installation process, type the following command
     52 into a terminal, assuming you have `git` installed:
     53 
     54 	cd ~/.vim/bundle
     55 	git clone https://gitlab.com/edvb/dmenu.vim
     56 
     57 ### 3. Vundle, by gmarik
     58 
     59 To use [Vundle](https://github.com/gmarik/Vundle.vim) you first have to
     60 install it by following the instructions on the repository. After the
     61 installation process, insert the following into your `.vimrc` file:
     62 
     63 	Plugin 'edvb/dmenu.vim'
     64 
     65 And then type this while inside Vim:
     66 
     67 	:source %
     68 	:PluginInstall
     69 
     70 ### 4. NeoBundle, by Shougo
     71 
     72 To use [NeoBundle](https://github.com/Shougo/neobundle.vim) you first have to
     73 install it by following the instructions on the repository. After the
     74 installation process, insert the following into your `.vimrc` file:
     75 
     76 	NeoBundle 'edvb/dmenu.vim'
     77 
     78 And then type this while inside Vim:
     79 
     80 	:source %
     81 	:NeoBundleInstall
     82 
     83 ## Author
     84 
     85 Written by ED van Bruggen.
     86 
     87 ## Licence
     88 
     89 Vim License. See `:help license`
     90