From 165d398a1ab541d43133ae9a52d8da4a45e0fd6a Mon Sep 17 00:00:00 2001 From: "C.D. Clark III" Date: Thu, 21 Jun 2012 20:35:20 -0500 Subject: [PATCH] added documentation for Bundle options to docs Added a section on passing options to the Bundle command. --- doc/vundle.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/vundle.txt b/doc/vundle.txt index 57e7260..0d09349 100644 --- a/doc/vundle.txt +++ b/doc/vundle.txt @@ -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 >