/
neobundle.txt
1769 lines (1479 loc) · 55.3 KB
/
neobundle.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
*neobundle.txt* Next generation Vim package manager
Version: 3.0
Author: Shougo <Shougo.Matsu at gmail.com>
Copyright (C) 2010 http://github.com/gmarik
License: MIT license {{{
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
}}}
CONTENTS *neobundle-contents*
Introduction |neobundle-introduction|
Usage |neobundle-usage|
Install |neobundle-install|
Interface |neobundle-interface|
Functions |neobundle-functions|
Commands |neobundle-commands|
Variables |neobundle-variables|
Options |neobundle-options|
Configuration Examples |neobundle-examples|
Migrating from Pathogen |neobundle-migrate-from-pathogen|
Unite sources |neobundle-unite-sources|
Recipe |neobundle-recipe|
FAQ |neobundle-faq|
==============================================================================
INTRODUCTION *neobundle-introduction*
*neobundle* is the next generation Vim package manager. This plugin is based on
Vundle (https://github.com/gmarik/vundle), but I renamed and added tons of
features. Because, Vundle's author does not want to add huge features in
Vundle.
Note: Neobundle is not a stable plugin manager. If you want a stable plugin
manager, you should use Vundle plugin. It well works widely and it is more
tested. If you want to use extended features, you can use neobundle.
Vundle features: Stable, simple, good for beginners
Neobundle features: Early development (may break compatibility), very complex,
good for plugin power users (for example, 50+ plugins and over 1000 lines
.vimrc, ...)
Neobundle features:
* Uses |vimproc| if available
* |unite.vim| interface
* Revision lock
* Supports svn/Mercurial repositories besides Git
* Can use a different base path
* Vundle like syntax
==============================================================================
USAGE *neobundle-usage*
Refer to the example:
|neobundle-examples|
Run this command to update your bundled plugins:
>
:NeoBundleUpdate
<
Note: To use the unite.vim interface, run this command (requires |unite.vim|):
>
:Unite neobundle/update
<
Settings for this plugin are compatible with Vundle.vim :-)
You can search popular plugins and add neobundle settings at Vimpusher
(registration required):
http://www.vimpusher.com/
Or at vim-scripts.org:
http://vim-scripts.org/
Neobundle now features a plugin search for vim.org scripts (requires
|unite.vim|)
>
:Unite neobundle/search
<
==============================================================================
INSTALL *neobundle-install*
Requirements:
* Vim 7.2.051 or above.
* "git" command in $PATH (if you want to install github or vim.org plugins)
First of all, git clone the repository.
Note: You need to have git installed.
>
$ mkdir -p ~/.vim/bundle
$ git clone git://github.com/Shougo/neobundle.vim ~/.vim/bundle/neobundle.vim
<
And set up a path to the repository directory.
>
set runtimepath+={path to neobundle directory}
<
Example:
>
set runtimepath+=~/.vim/bundle/neobundle.vim
<
Now configure your bundles. (Refer to |neobundle-examples|)
Run the |:NeoBundleInstall| command to install your plugins.
>
$ vim +NeoBundleInstall +q
or
>
$ . ~/.vim/bundle/neobundle.vim/bin/neoinstall
<
Note: To use neoinstall in Windows, Vim command must be in $PATH. >
> .vim/bundle/neobundle.vim/bin/neoinstall
Note: To update and build vimproc in Windows, you can use
"neoinstall_novimproc" command. >
> .vim/bundle/neobundle.vim/bin/neoinstall_novimproc vimproc.vim
neoinstall can take arguments (install/update plugin names).
>
# Build vimproc before install plugins
$ . ~/.vim/bundle/neobundle.vim/bin/neoinstall vimproc.vim
<
==============================================================================
INTERFACE *neobundle-interface*
------------------------------------------------------------------------------
FUNCTIONS *neobundle-functions*
neobundle#begin([{base-path}]) *neobundle#begin()*
Initializes neobundle.vim. {base-path} is where your
downloaded plugins will be placed.
If {base-path} is omitted, neobundle looks for a "bundle"
directory in the default 'runtimepath'.
Note: It executes ":filetype off" automatically.
Note: You must not call the function inside a
"has('vim_starting')" block.
>
if has('vim_starting')
if &compatible
set nocompatible
endif
set runtimepath+={path to neobundle directory}
endif
call neobundle#begin(expand('~/.vim/bundle'))
NeoBundle 'git://github.com/Shougo/neocomplcache.git'
...
call neobundle#end()
filetype plugin indent on
<
neobundle#end() *neobundle#end()*
Finalize neobundle.vim. If you use |neobundle#begin()|, you
must call it after neobundle bundles configuration.
neobundle#rc([{base-path}]) *neobundle#rc()*
Note: It is deprecated interface.
neobundle#source({bundle-names}) *neobundle#source()*
Same as |:NeoBundleSource|.
{bundle-names} is a list of bundle names.
*neobundle#exists_not_installed_bundles()*
neobundle#exists_not_installed_bundles()
Checks if there are any bundles that are not installed.
*neobundle#get_not_installed_bundle_names()*
neobundle#get_not_installed_bundle_names()
Returns the names of bundles that are not installed.
*neobundle#is_installed()*
neobundle#is_installed({bundle-name})
Checks if bundle {bundle-name} is installed.
*neobundle#is_sourced()*
neobundle#is_sourced({bundle-name})
Checks if bundle {bundle-name} is loaded.
*neobundle#local()*
neobundle#local({directory}, [{options}, [{names}]])
Adds the subdirectories in {directory} to
'runtimepath', like |pathogen| does. See |neobundle-options|
for keys to set in {options}.
If {names} is given, {names} directories are only loaded.
Note: |:NeoBundleLocal| is a shortcut for this function.
>
" Load plugin from "~/.vim/bundle".
call neobundle#local("~/.vim/bundle", {})
" Load plugin1 and plugin2 from "~/.vim/bundle".
call neobundle#local("~/.vim/bundle",
\ {}, ['plugin1', 'plugin2'])
<
*neobundle#load_toml()*
neobundle#load_toml({filename}, [{options}])
Load TOML plugin configurations from {filename}. See
|neobundle-options| for keys to set in {options}.
Note: TOML parser is slow. You should use neobundle cache
feature.
TOML file format specification:
https://github.com/toml-lang/toml
Note: Original TOML parser is created by kamichidu.
https://github.com/kamichidu
>
" Load toml from "~/.vim/bundle.toml".
call neobundle#load_toml("~/.vim/bundle.toml", {})
<
TOML file sample is here:
>
# TOML sample
[[plugins]]
# repository name is required.
repository = 'kana/vim-niceblock'
mappings = '<Plug>'
[[plugins]]
repository = 'Shougo/neosnippet.vim'
depends = ['Shougo/neosnippet-snippets',
'Shougo/context_filetype.vim']
insert = 1
filetypes = 'snippet'
unite_sources = [ 'neosnippet',
'neosnippet/user', 'neosnippet/runtime']
[[plugins]]
repository = 'Shougo/vimproc.vim'
[plugins.build]
windows = 'tools\\update-dll-mingw'
cygwin = 'make -f make_cygwin.mak'
mac = 'make -f make_mac.mak'
unix = 'make -f make_unix.mak'
<
neobundle#get({bundle-name}) *neobundle#get()*
Get the neobundle options dictionary for {bundle-name}.
Useful for setting hooks.
Example:
>
NeoBundleLazy 'tyru/open-browser.vim', '', 'same', { 'autoload' : {
\ 'mappings' : '<Plug>',
\ }}
nmap gs <Plug>(open-browser-wwwsearch)
let bundle = neobundle#get('open-browser.vim')
function! bundle.hooks.on_source(bundle)
nnoremap <Plug>(open-browser-wwwsearch)
\ :<C-u>call <SID>www_search()<CR>
function! s:www_search()
let search_word = input('Please input search word: ', '',
\ 'customlist,wwwsearch#cmd_Wwwsearch_complete')
if search_word != ''
execute 'OpenBrowserSearch' escape(search_word, '"')
endif
endfunction
endfunction
<
neobundle#get_hooks({bundle-name}) *neobundle#get_hooks()*
Get the neobundle "hooks" dictionary for {bundle-name}.
Useful for setting hooks.
neobundle#call_hook({hook-name}) *neobundle#call_hook()*
Calls the hook {hook-name}.
Note: If {hook-name} is "on_source", neobundle will call
"on_source" hooks in sourced bundles.
neobundle#bundle({repository}, [{options}]) *neobundle#bundle()*
Initialize a bundle.
If {repository} is list, you can initialize options in
multiple bundles.
Note: You can use this function instead of |:NeoBundle|
command.
neobundle#config({bundle-name}, {options}) *neobundle#config()*
neobundle#config({options})
Change bundle options for {bundle-name}.
Note: To lazy-load a plugin, you can set the "lazy" flag after
calling |:NeoBundle| or |:NeoBundleLocal|.
It you omit {bundle-name}, it uses |neobundle#tapped|
variable.
If {bundle-name} is list, you can change options in multiple
bundles.
If {bundle-name} is not configured, it will print error
messages.
>
NeoBundle 'Shougo/neocomplcache'
call neobundle#config('neocomplcache', {
\ 'lazy' : 1,
\ 'autoload' : {
\ 'insert' : 1,
\ }})
" Use neobundle#tap()
NeoBundle 'Shougo/neocomplete'
if neobundle#tap('neocomplete')
" Some settings...
function! neobundle#hooks.on_source(bundle)
" Some settings...
endfunction
call neobundle#untap()
endif
<
neobundle#tap({bundle-name}) *neobundle#tap()*
Initialize |neobundle#tapped| and |neobundle#hooks| variable
as {bundle-name} bundle.
It returns non-zero if {bundle-name} is exists.
neobundle#untap() *neobundle#untap()*
Clear current |neobundle#tapped| and |neobundle#hooks| variable.
neobundle#has_cache() *neobundle#has_cache()*
Checks if a cache file is available.
You can optimize the .vimrc loading time by using it
together with |:NeoBundleLoadCache|.
The default cache location can be overridden through
|g:neobundle#cache_file|.
Note: to clear the cache use |:NeoBundleClearCache|,
or use |neobundle#commands#has_fresh_cache()| when
checking for it.
>
if neobundle#has_cache()
NeoBundleLoadCache
else
" My Bundles here:
" ...
NeoBundleSaveCache
endif
<
neobundle#has_fresh_cache([{vimrc}]) *neobundle#has_fresh_cache()*
Similar to |neobundle#has_cache|, but compares the
modification time of the cache file to your configuration file
({vimrc} or |$MYVIMRC|).
------------------------------------------------------------------------------
COMMANDS *neobundle-commands*
*:NeoBundle*
:NeoBundle {repository} [[,{revision}] [,{options}]]
:NeoBundle {repository} ,{revision}, {default} [,{options}]]
Initialize a bundle.
{repository} is the repository URI. {revision} is the desired
revision or branch name. If omitted, the current latest
revision will be used. {default} is a "default options
name" (See |g:neobundle#default_options|).
Note: Don't set neobundle setting in .gvimrc!
Note: If you omit the protocol (ex: git or https) for a git
repo, |g:neobundle_default_git_protocol| is used.
Note: If you manage bundle by neobundle, it may be error
occurred when update bundles.
See |neobundle-options| for what to set in {options}.
:NeoBundleInstall [{name}...] *:NeoBundleInstall*
Installs plugins specified by {name}. {name} is
fuzzy-searched. If {name} is omitted, all configured plugins
are installed. Note: {name}s are plugin names like
"neobundle.vim", not "Shougo/neobundle.vim".
:NeoBundleInstall! [{name}...] *:NeoBundleInstall!*
Same as |:NeoBundleUpdate|.
:NeoBundleUpdate [{name}...] *:NeoBundleUpdate*
Installs and updates plugins specified by {name}. {name} is
fuzzy-searched. If {name} is omitted, all configured plugins
are installed and updated, except if they are outdated or have
the "stay_same" option set.
Note: {name}s are plugin names like "neobundle.vim", not
"Shougo/neobundle.vim".
:NeoBundleUpdate! [{name}...] *:NeoBundleUpdate!*
Same as |:NeoBundleUpdate|, except that it disregards the
"stay_same" option.
:NeoBundleClean [{bang} [{name}...]] *:NeoBundleClean*
Removes non-configured bundles that still exist in the bundle
path from the filesystem. If {bang} is added, force remove
them. If {name}s are added, remove bundles specified by
{name}s.
:NeoBundleReinstall [{name}...] *:NeoBundleReinstall*
Reinstalls the bundles specified by {name}.
:NeoBundleList *:NeoBundleList*
Prints a list of configured bundles.
:NeoBundleLog *:NeoBundleLog*
Prints all previous install logs.
:NeoBundleUpdatesLog *:NeoBundleUpdatesLog*
Prints previous update logs.
:NeoBundleLocal {base-directory-path} *:NeoBundleLocal*
Registers a bundle from the directories in
{base-directory-path} like pathogen does.
Note: If you want to use neobundle like pathogen.vim, you
should set a different base path from the standard neobundle
bundles path.
>
NeoBundleLocal ~/.vim/bundle
<
*:NeoBundleLazy*
:NeoBundleLazy {repository} [[,{revision}] [,{options}]]
:NeoBundleLazy {repository} ,{revision}, {default} [,{options}]]
Registers a bundle, but doesn't add it to 'runtimepath'.
>
NeoBundleLazy 'The-NERD-tree', {'augroup' : 'NERDTree'}
NeoBundleSource The-NERD-tree
<
You can use it to load plugins for specific filetypes.
>
NeoBundleLazy 'Rip-Rip/clang_complete'
autocmd FileType c,cpp NeoBundleSource clang_complete
<
:NeoBundleSource [{name}...] *:NeoBundleSource*
|:source| the bundles specified by {name}.
If {name} is omitted, |:source| all lazy bundles.
Note: This command is used to load the bundles configured with
|:NeoBundleLazy|.
:NeoBundleFetch {repository} [, {options}] *:NeoBundleFetch*
Registers a bundle, but doesn't add it to 'runtimepath'.
Unlike |:NeoBundleLazy|, you cannot load the bundle with
|:NeoBundleSource|. This command is useful for managing
non-Vim plugins using neobundle.
>
NeoBundleFetch 'davidhalter/jedi'
<
:NeoBundleDocs *:NeoBundleDocs*
Execute |:helptags| for all bundles manually.
*:NeoBundleDirectInstall*
:NeoBundleDirectInstall {repository} [, {options}]
Registers a bundle, and installs it directly.
Note: The settings are saved in "extra_bundles.vim" in
|neobundle#begin()| directory.
Note: To uninstall direct installed bundles, you must delete
plugin settings manually in "extra_bundles.vim" in
|neobundle#begin()| directory and execute |:NeoBundleClean|
command.
>
NeoBundleDirectInstall 'Shougo/neocomplcache'
<
*:NeoBundleExtraEdit*
:NeoBundleExtraEdit
Edit extra bundles configuration easily.
:NeoBundleDisable {name}... *:NeoBundleDisable*
Disables bundles specified by {name}. If a bundle is
disabled, its path will be removed from 'runtimepath'.
Note: This command must be executed before neobundle loads
the plugins(after |neobundle#end()|).
:NeoBundleCheck *:NeoBundleCheck*
Check plugins installation. If plugins are not installed, it
will execute |:NeoBundleInstall| automatically. This command
also check documentation directories and will execute
|:NeoBundleDocs| automatically.
:NeoBundleCheckUpdate [{name}...] *:NeoBundleCheckUpdate*
Check plugins update specified by {name}. If updates are
available, it will execute |:NeoBundleUpdate| automatically.
Note: It is supported in git type only.
*:NeoBundleRecipe*
:NeoBundleRecipe {recipe-name} [, {options}]
Registers a bundle from "recipes/{recipe-name}.vimrecipe" file
in 'runtimepath'. This command is useful if you don't want to
set bundle options.
Note: You must install recipes (|neobundle-recipe|) before
executing it.
>
NeoBundleRecipe 'vimproc.vim'
<
*:NeoBundleCount*
:NeoBundleCount
Show bundles count. You can know how many bundles you have.
*:NeoBundleGC*
:NeoBundleGC [{bundle-names}]
Execute Garbage Collect commands in bundles.
If {bundle-name} is omit, all bundles will be GCed.
*:NeoBundleSaveCache*
:NeoBundleSaveCache
Save plugin configuration in the cache file.
Note: It cannot save functions for example "hooks" member.
Note: It is available when loading .vimrc.
*:NeoBundleLoadCache*
:NeoBundleLoadCache
Load plugin configuration from the cache file,
which is located in `neobundle#get_rtp_dir() . '/cache'`.
*:NeoBundleClearCache*
:NeoBundleClearCache
Clear the configuration cache file.
*:NeoBundleRollback*
:NeoBundleRollback {bundle-name}
Rollback {bundle-name} plugin version to previous updated
version.
Note: If you rollbacked the plugin, you cannot update it by
|:NeoBundleUpdate| command. If you want to update it, you
must reinstall the plugin by |:NeoBundleReinstall| command.
------------------------------------------------------------------------------
VARIABLES *neobundle-variables*
g:neobundle#cache_file *g:neobundle#cache_file*
The cache file to use.
The default is provided through
neobundle#commands#get_default_cache_file():
>
neobundle#get_rtp_dir() . '/cache'
<
neobundle#tapped *neobundle#tapped*
Current bundle variable set by |neobundle#tap()|.
neobundle#hooks *neobundle#hooks*
Current bundle hooks variable set by |neobundle#tap()|.
g:neobundle#default_site *g:neobundle#default_site*
The default repository site if "site" option is omitted.
*g:neobundle_default_site*
Note: |g:neobundle_default_site| is obsolete.
Defaults to "github".
g:neobundle#log_filename *g:neobundle#log_filename*
The log filename. Set it to "" to disable logging.
*g:neobundle_log_filename*
Note: |g:neobundle_log_filename| is obsolete.
Defaults to "".
*g:neobundle#enable_name_conversion*
g:neobundle#enable_name_conversion
If you set to 1 and omit bundle name,
|neobundle-options-regular_name| is used as bundle name.
It is useful for absorbing difference of repository name.
g:neobundle#rm_command *g:neobundle#rm_command*
The command used to remove files for |:NeoBundleClean|.
*g:neobundle_rm_command*
Note: |g:neobundle_rm_command| is obsolete.
Defaults to "rmdir /S /Q" on Windows or "rm -rf" in
others.
*g:neobundle#install_max_processes*
g:neobundle#install_max_processes
The max number of processes used for neobundle/install source
asynchronous update.
*g:unite_source_neobundle_install_max_processes*
Note: |g:unite_source_neobundle_install_max_processes| is
obsolete.
Defaults to "4".
*g:neobundle#install_process_timeout*
g:neobundle#install_process_timeout
The time of timeout seconds when updating/installing bundles.
Note: This feature is available if you installed |vimproc|.
Defaults to "120".
g:neobundle#default_options *g:neobundle#default_options*
A dictionary of preconfigured sets of options to use when
options are omitted for individual commands or functions.
Keys are arbitrary names for the option sets, and values are
dictionaries themselves that store option keys and values.
Use the special key "_" to store a "default default options".
Example:
>
let g:neobundle#default_options =
\ { 'rev' : {'rev' : 'ver.8'} }
NeoBundle 'Shougo/neocomplcache', '', 'rev'
<
Defaults to "{}".
*g:neobundle#types#raw#calc_hash_command*
g:neobundle#types#raw#calc_hash_command
The hash command to use in raw repositories.
Defaults to "sha1sum" or "md5sum".
*g:neobundle#types#git#command_path*
g:neobundle#types#git#command_path
The "git" command path used for git type.
Defaults to "git".
*g:neobundle#types#git#default_protocol*
g:neobundle#types#git#default_protocol
The default protocol used for git (github).
Note: If you need to use neobundle in proxy or firewall, you
must use it in "https".
*g:neobundle_default_git_protocol*
Note: |g:neobundle_default_git_protocol| is obsolete.
Defaults to "https".
*g:neobundle#types#git#enable_submodule*
g:neobundle#types#git#enable_submodule
If it is non-zero, neobundle enables git submodule support.
But it may be slow in Windows environment.
Defaults to 1.
*g:neobundle#types#git#clone_depth*
g:neobundle#types#git#clone_depth
The default history depth for "git clone".
If it is 1, neobundle use shallow clone feature.
See |neobundle-options-type__depth|.
Defaults to 0.
*g:neobundle#types#git#pull_command*
g:neobundle#types#git#pull_command
The git command used to pull updates.
The previous default has been "pull --rebase".
Defaults to "pull --ff --ff-only".
*g:neobundle#types#hg#command_path*
g:neobundle#types#hg#command_path
The "hg" command path used for hg type.
Defaults to "hg".
*g:neobundle#types#hg#default_protocol*
g:neobundle#types#hg#default_protocol
The default protocol used for hg (bitbucket).
*g:neobundle#types#svn#command_path*
g:neobundle#types#svn#command_path
The "svn" command path used for svn type.
Defaults to "svn".
*g:neobundle_default_hg_protocol*
Note: |g:neobundle_default_git_protocol| is obsolete.
Defaults to "https".
------------------------------------------------------------------------------
OPTIONS *neobundle-options*
The {options} in neobundle commands accept the following keys:
*neobundle-options-name*
name (String)
Specify the name of the bundle. This is used for neobundle
management and other commands (like |:NeoBundleUpdate|). If
omitted, the tail of the repository name will be used.
Note: Must be unique across all bundles. If a bundle name
conflicts with another bundle, neobundle will overwrite the
previous settings with the new one. If a repo tail is bound to
conflict, you can set the "name" option manually to prevent
overwriting an existing bundle setting.
Example:
>
NeoBundle 'git://github.com/Shougo/unite.vim.git',
\ {'name' : 'unite'}
NeoBundle 'git://github.com/foo/foo.git',
\ {'name' : 'foo-foo'}
NeoBundle 'git://github.com/bar/foo.git',
\ {'name' : 'bar-foo'}
NeoBundle 'git://git.code.sf.net/p/atp-vim/code',
\ {'name': 'atp-vim'}
<
*neobundle-options-regular_name*
regular_name (String)
Specify the normalized name of the bundle. This is used for
neobundle management to detect dependencies. If omitted,
neobundle will normalize the tail of the repository name.
Note: Must be unique across all bundles.
Normalized name example:
name : normalized name
>
unite.vim unite
vim-quickrun quickrun
<
description (String)
Plugin description.
rev (String)
Specify a revision number or branch/tag name.
Note: If the type is "raw", rev is hash number.
Example:
>
NeoBundle 'Shougo/vimshell', { 'rev' : '3787e5' }
<
*neobundle-options-default*
default (String)
Specify a default option name. (See |g:neobundle#default_options|).
*neobundle-options-directory*
directory (String)
Specify relative directory path from the base directory (set
by |neobundle#begin()| or "base" option). If omitted, the "name"
option will be used.
Note: If you set rev "foo" when the name key is "neobundle",
the directory key is "neobundle_foo".
Example:
>
NeoBundle 'git://github.com/Shougo/unite.vim.git',
\ {'directory' : 'unite'}
<
*neobundle-options-recipe*
recipe (String)
Use default options from the "recipes/{recipe-name}.vimrecipe"
file in 'runtimepath'. (See |:NeoBundleRecipe|).
Example:
>
NeoBundle 'Shougo/unite.vim', {'recipe' : 'unite'}
<
*neobundle-options-base_path*
base (String)
Directory base path to use. If omitted, the path specified
with |neobundle#begin()| will be used. It is useful for
loading scripts from a different path.
Example:
*neobundle-options-type*
type (String)
Specify the repository type. If omitted, a guess is made
based on {repository}.
Available types:
"nosync" : No synchronous
"raw" : Raw plugin file ("script_type" attribute is
needed)
"git" : Git
"hg" : Mercurial
"svn" : Subversion
Example:
>
NeoBundle 'git://host/path/repo.git', {'type': 'hg'}
NeoBundle 'thinca/vim-localrc', {'type' : 'svn'}
<
*neobundle-options-script_type*
script_type (String)
Specify the script type. It is useful for non-official
categorized plugins.
For example: "indent", "plugin", "ftplugin", ...
Note: You must not specify it for categorized plugins.
Example:
>
NeoBundle 'https://raw.github.com/m2ym/rsense/master/etc/rsense.vim',
\ {'script_type' : 'plugin'}
NeoBundle 'https://github.com/bronzehedwick/impactjs-colorscheme',
\ {'script_type' : 'colorscheme'}
<
*neobundle-options-site*
site (String)
Specify the repository site. If you omit both the repository
URL and the "site" option, |g:neobundle#default_site| will be
used.
Note: You can specify site by "{site-name}:{path}".
For example: "github:Shougo/vimshell"
Available sites:
"github" or "gh" : github.com (git)
"bitbucket" or "bb" : bitbucket.org (hg)
"gist" : gist.github.com (git)
*neobundle-options-rtp*
rtp (String)
Specify runtime path.
Use this option when the repository has the Vim plugin
in a subdirectory.
For example: https://github.com/rstacruz/sparkup
Example:
>
NeoBundle 'rstacruz/sparkup', {'rtp': 'vim'}
NeoBundle 'https://code.google.com/p/vimwiki/', {
\ 'rtp': "~/.vim/bundle/vimwiki/src",
\ }
<
*neobundle-options-depends*
depends (List or String)
Specify a list of plugins a plugin depends on.
List items are '{plugin-name}' or ['{plugin-name}', {args}].
Those specified in the list are installed automatically. If
the {plugin-name} needs options, specify them with {args}.
Note: Type String is syntax sugar for List of {plugin-name}.
Example:
>
NeoBundle 'Shougo/vimfiler', {'depends' : 'Shougo/unite.vim' }
NeoBundle 'Shougo/neocomplcache', {'depends' :
\ [ 'Shougo/neosnippet.git',
\ ['rstacruz/sparkup', {'rtp': 'vim'}],
\ ]}
<
*neobundle-options-build*
build (Dictionary)
Specify the build script.
You may use this option if the plugin has to be built before
use. If the build script requires external commands, see
|neobundle-options-build_commands|.
This command is executed by |system()| or |vimproc#system()|
in plugin runtimepath.
For example: |vimproc|
This dictionary accepts the following keys:
windows (String)
Specify Windows environment build script.
mac (String)
Specify Mac OS X environment build script.
cygwin (String)
Specify Cygwin environment build script.
linux (String)
Specify Linux environment build script.
Note: It is detected if "gmake" command is not
executable.
unix (String)
Specify Unix environment build script.
others (String)
Specify others environment build script.
If you don't specify other keys, it means "all".
Example:
>
NeoBundle 'Shougo/vimproc.vim', {
\ 'build' : {
\ 'windows' : 'tools\\update-dll-mingw',
\ 'cygwin' : 'make -f make_cygwin.mak',
\ 'mac' : 'make -f make_mac.mak',
\ 'linux' : 'make',
\ 'unix' : 'gmake',
\ },
\ }
<
*neobundle-options-augroup*
augroup (String)
Specify an augroup name that the plugin uses for |VimEnter| or
|GUIEnter| autocmd events.
Neobundle will call their |VimEnter| or |GUIEnter| autocmds
automatically when |:NeoBundleSource| is executed.
Note: You'll want to set this option because some plugins
rely on autocmds defined for |VimEnter| or |GUIEnter|, but by
using |:NeoBundleSource| after loading .vimrc, those autocmds
may get skipped. Some examples are, "fugitive", "NERDTree",
and "session.vim".
Examples:
>
" NERDTree uses augroup NERDTreeHijackNetrw.
NeoBundle 'scrooloose/nerdtree', { 'augroup' : 'NERDTreeHijackNetrw'}
" fugitive uses augroup fugitive.
NeoBundle 'tpope/vim-fugitive', { 'augroup' : 'fugitive'}
<
This option is also valid in |:NeoBundleLazy|.
*neobundle-options-external_commands*
external_commands (Dictionary or List or String)
Specify a list of external commands that the plugin depends
on. List items are '{command-name}' or ['{command-name}',
...] or { {dictionary} }.
The commands are checked when loading the plugin.
Note: Type String is syntax sugar for list of {command-name}s.
The {dictionary} has following keys:
windows (String)
Specify Windows environment external commands.
mac (String)
Specify Mac OS X environment external commands.
cygwin (String)
Specify Cygwin environment external commands.
unix (String)
Specify Unix environment external commands.
others (String)
Specify others environment external commands.
Example:
>
NeoBundle 'ujihisa/neco-ghc', { 'external_commands' : 'ghc-mod' }
<
*neobundle-options-build_commands*
build_commands (Dictionary or List or String)
Specify a list of external commands that are required for
building the plugin. If any of these commands are not
installed, the bundle will not be built. The list is the same
format as |neobundle-options-external_commands|.
Example:
>
NeoBundle 'Valloric/YouCompleteMe', { 'build_commands' : 'cmake' }
<
*neobundle-options-stay_same*
stay_same (Number)
If set to 1, neobundle doesn't update it automatically when
|:NeoBundleUpdate| or ":Unite neobundle/update" is called with
no arguments. It is useful for outdated plugins that can no
longer be updated.
>
NeoBundle 'Shougo/neobundle', { 'stay_same' : 1 }
<
*neobundle-options-lazy*
lazy (Number)
If set to 1, neobundle doesn't add the path to user
runtimepath.
*neobundle-options-force*
force (Number)
If set to 1, neobundle will load plugin files in the plugin
repository forcedly.
Note: It is useful for using Bundle within bundle.
https://github.com/Shougo/neobundle.vim/issues/199
*neobundle-options-overwrite*
overwrite (Number)
If set to 1, neobundle doesn't overwrite the path to user
runtimepath.
*neobundle-options-resettable*
resettable (Number)
If set to 0, neobundle doesn't reset the path in
|neobundle#begin()|.
*neobundle-options-gui*
gui (Number)
If set 1, neobundle will only load the plugin in GUI Vim.
Example: >
NeoBundleLazy 'tyru/restart.vim', '', 'same', {
\ 'gui' : 1,
\ 'autoload' : {
\ 'commands' : 'Restart'
\ }}
<
*neobundle-options-terminal*
terminal (Number)
If set to 1, neobundle will only load the plugin in Terminal
Vim.
*neobundle-options-vim_version*
vim_version (String)
Minimal vim version of the plugin supported.
It accepts some version formats such as "7" and "7.3" and
"7.3.885".
*neobundle-options-disabled*
disabled (Number)
If set to 1, neobundle will disable the plugin.
Note: Disabled plugins are not ignored when install/update
plugins.
Example: >
" neocomplete requires Vim 7.3.885 or above.
NeoBundle 'Shougo/neocomplete', {
\ 'depends' : 'Shougo/context_filetype.vim',
\ 'disabled' : !has('lua'),
\ 'vim_version' : '7.3.885'
\ }
<
*neobundle-options-focus*