Browse Source

added documentation for Bundle options to docs

Added a section on passing options to the Bundle command.
pull/187/head
C.D. Clark III 14 years ago
parent
commit
165d398a1a
1 changed files with 12 additions and 0 deletions
  1. +12
    -0
      doc/vundle.txt

+ 12
- 0
doc/vundle.txt View File

@ -79,6 +79,18 @@ in order to install/search [all available vim scripts]
" or
" filetype plugin on " to not use the indentation settings set by plugins
Options
Options can specified by passing a dictionary to the second argument of the Bundle command. In the
example above, the 'rtp' option, which specifies the directory that a bundles runtime files are located
in relative to the bundle's top directory, is passed to the 'rstacruz/sparkup' bundle. Options can be
used to override the default parameters that are extracted from the bundle name. Note, multiple options
are passed through a *single* dictionary. Options that can be set:
rtp : The directory (relative to the bundle's main directory) that contains the plugin's runtime files.
uri : The bundle's uri for a 'git clone'. This can be used to specify a ssh:// uri, which vundle does not support directly
name : The bundle's name, the bundle will be cloned into a subdirectory of the bundle directory with this name
3) Install configured bundles:
Launch `vim`, run >


Loading…
Cancel
Save