annotate runtime/doc/pi_getscript.txt @ 18486:9d887cad7315

Added tag v8.1.2237 for changeset 63ee3c2b140fe1b4801389872a8e47aec19d028b
author Bram Moolenaar <Bram@vim.org>
date Thu, 31 Oct 2019 20:00:04 +0100
parents 2f7e67dd088c
children af69c9335223
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13963
1174611ad715 Vim 8.1 release
Christian Brabandt <cb@256bit.org>
parents: 11914
diff changeset
1 *pi_getscript.txt* For Vim version 8.1. Last change: 2017 Aug 01
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
2 >
4339
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
3 GETSCRIPT REFERENCE MANUAL by Charles E. Campbell
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
4 <
4339
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
5 Authors: Charles E. Campbell <NdrOchip@ScampbellPfamilyA.Mbiz>
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
6 (remove NOSPAM from the email address)
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
7 *GetLatestVimScripts-copyright*
4339
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
8 Copyright: (c) 2004-2012 by Charles E. Campbell *glvs-copyright*
3281
af1e8a1714c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
9 The VIM LICENSE (see |copyright|) applies to the files in this
af1e8a1714c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
10 package, including getscriptPlugin.vim, getscript.vim,
af1e8a1714c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
11 GetLatestVimScripts.dist, and pi_getscript.txt, except use "getscript"
11473
bd6ff5246c71 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 5618
diff changeset
12 instead of "Vim". Like anything else that's free, getscript and its
3281
af1e8a1714c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
13 associated files are provided *as is* and comes with no warranty of
af1e8a1714c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
14 any kind, either expressed or implied. No guarantees of
af1e8a1714c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
15 merchantability. No guarantees of suitability for any purpose. By
af1e8a1714c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
16 using this plugin, you agree that in no event will the copyright
af1e8a1714c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
17 holder be liable for any damages resulting from the use of this
af1e8a1714c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
18 software. Use at your own risk!
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
19
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
20 Getscript is a plugin that simplifies retrieval of the latest versions of the
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
21 scripts that you yourself use! Typing |:GLVS| will invoke getscript; it will
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
22 then use the <GetLatestVimScripts.dat> (see |GetLatestVimScripts_dat|) file to
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
23 get the latest versions of scripts listed therein from http://vim.sf.net/.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
24
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
25 ==============================================================================
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
26 1. Contents *glvs-contents* *glvs* *getscript*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
27 *GetLatestVimScripts*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
28
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
29 1. Contents........................................: |glvs-contents|
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
30 2. GetLatestVimScripts -- Getting Started..........: |glvs-install|
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
31 3. GetLatestVimScripts Usage.......................: |glvs-usage|
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
32 4. GetLatestVimScripts Data File...................: |glvs-data|
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
33 5. GetLatestVimScripts Friendly Plugins............: |glvs-plugins|
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
34 6. GetLatestVimScripts AutoInstall.................: |glvs-autoinstall|
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
35 7. GetLatestViMScripts Options.....................: |glvs-options|
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
36 8. GetLatestVimScripts Algorithm...................: |glvs-alg|
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
37 9. GetLatestVimScripts History.....................: |glvs-hist|
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
38
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
39
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
40 ==============================================================================
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
41 2. GetLatestVimScripts -- Getting Started *getscript-start*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
42 *getlatestvimscripts-install*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
43
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
44 VERSION FROM VIM DISTRIBUTION *glvs-dist-install*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
45
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
46 Vim 7.0 does not include the GetLatestVimScripts.dist file which
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
47 serves as an example and a template. So, you'll need to create
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
48 your own! See |GetLatestVimScripts_dat|.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
49
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
50 VERSION FROM VIM SF NET *glvs-install*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
51
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
52 NOTE: The last step, that of renaming/moving the GetLatestVimScripts.dist
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
53 file, is for those who have just downloaded GetLatestVimScripts.tar.bz2 for
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
54 the first time.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
55
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
56 The GetLatestVimScripts.dist file serves as an example and a template for your
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
57 own personal list. Feel free to remove all the scripts mentioned within it;
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
58 the "important" part of it is the first two lines.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
59
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
60 Your computer needs to have wget or curl for GetLatestVimScripts to do its work.
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
61
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
62 1. if compressed: gunzip getscript.vba.gz
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
63 2. Unix:
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
64 vim getscript.vba
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
65 :so %
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
66 :q
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
67 cd ~/.vim/GetLatest
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
68 mv GetLatestVimScripts.dist GetLatestVimScripts.dat
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
69 (edit GetLatestVimScripts.dat to install your own personal
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
70 list of desired plugins -- see |GetLatestVimScripts_dat|)
11473
bd6ff5246c71 Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 5618
diff changeset
71
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
72 3. Windows:
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
73 vim getscript.vba
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
74 :so %
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
75 :q
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
76 cd **path-to-vimfiles**/GetLatest
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
77 mv GetLatestVimScripts.dist GetLatestVimScripts.dat
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
78 (edit GetLatestVimScripts.dat to install your own personal
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
79 list of desired plugins -- see |GetLatestVimScripts_dat|)
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
80
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
81
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
82 ==============================================================================
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
83 3. GetLatestVimScripts Usage *glvs-usage* *:GLVS*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
84
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
85 Unless it has been defined elsewhere, >
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
86
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
87 :GLVS
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
88
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
89 will invoke GetLatestVimScripts(). If some other plugin has defined that
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
90 command, then you may type
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
91 >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
92 :GetLatestVimScripts
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
93 <
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
94 The script will attempt to update and, if permitted, will automatically
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
95 install scripts from http://vim.sourceforge.net/. To do so it will peruse a
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
96 file,
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
97 >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
98 .vim/GetLatest/GetLatestVimScripts.dat (unix)
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
99 <
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
100 or >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
101 ..wherever..\vimfiles\GetLatest\GetLatestVimScripts.dat (windows)
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
102 (see |glvs-data|), and examine plugins in your [.vim|vimfiles]/plugin
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
103 directory (see |glvs-plugins|).
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
104
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
105 Scripts which have been downloaded will appear in the
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
106 ~/.vim/GetLatest (unix) or ..wherever..\vimfiles\GetLatest (windows)
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
107 subdirectory. GetLatestVimScripts will attempt to automatically
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
108 install them if you have the following line in your <.vimrc>: >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
109
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
110 let g:GetLatestVimScripts_allowautoinstall=1
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
111
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
112 The <GetLatestVimScripts.dat> file will be automatically be updated to
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
113 reflect the latest version of script(s) so downloaded.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
114 (also see |glvs-options|)
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
115
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
116
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
117 ==============================================================================
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
118 4. GetLatestVimScripts Data File *getscript-data* *glvs-data*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
119 *:GetLatestVimScripts_dat*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
120 The data file <GetLatestVimScripts.dat> must have for its first two lines
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
121 the following text:
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
122 >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
123 ScriptID SourceID Filename
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
124 --------------------------
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
125 <
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
126 Following those two lines are three columns; the first two are numeric
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
127 followed by a text column. The GetLatest/GetLatestVimScripts.dist file
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
128 contains an example of such a data file. Anything following a #... is
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
129 ignored, so you may embed comments in the file.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
130
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
131 The first number on each line gives the script's ScriptID. When you're about
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
132 to use a web browser to look at scripts on http://vim.sf.net/, just before you
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
133 click on the script's link, you'll see a line resembling
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
134
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
135 http://vim.sourceforge.net/scripts/script.php?script_id=40
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
136
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
137 The "40" happens to be a ScriptID that GetLatestVimScripts needs to
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
138 download the associated page, and is assigned by vim.sf.net itself
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
139 during initial uploading of the plugin.
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
140
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
141 The second number on each line gives the script's SourceID. The SourceID
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
142 records the count of uploaded scripts as determined by vim.sf.net; hence it
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
143 serves to indicate "when" a script was uploaded. Setting the SourceID to 1
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
144 insures that GetLatestVimScripts will assume that the script it has is
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
145 out-of-date.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
146
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
147 The SourceID is extracted by GetLatestVimScripts from the script's page on
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
148 vim.sf.net; whenever it is greater than the one stored in the
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
149 GetLatestVimScripts.dat file, the script will be downloaded
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
150 (see |GetLatestVimScripts_dat|).
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
151
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
152 If your script's author has included a special comment line in his/her plugin,
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
153 the plugin itself will be used by GetLatestVimScripts to build your
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
154 <GetLatestVimScripts.dat> file, including any dependencies on other scripts it
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
155 may have. As an example, consider: >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
156
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
157 " GetLatestVimScripts: 884 1 :AutoInstall: AutoAlign.vim
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
158
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
159 This comment line tells getscript.vim to check vimscript #884 and that the
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
160 script is automatically installable. Getscript will also use this line to
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
161 help build the GetLatestVimScripts.dat file, by including a line such as: >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
162
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
163 884 1 :AutoInstall: AutoAlign.vim
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
164 <
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
165 assuming that such a line isn't already in GetLatestVimScripts.dat file.
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
166 See |glvs-plugins| for more. Thus, GetLatestVimScripts thus provides a
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
167 comprehensive ability to keep your plugins up-to-date!
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
168
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
169 In summary:
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
170
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
171 * Optionally tell getscript that it is allowed to build/append a
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
172 GetLatestVimScripts.dat file based upon already installed plugins: >
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
173 let g:GetLatestVimScripts_allowautoinstall=1
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
174 <
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
175 * A line such as >
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
176 " GetLatestVimScripts: 884 1 :AutoInstall: AutoAlign.vim
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
177 < in an already-downloaded plugin constitutes the concurrence of the
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
178 plugin author that getscript may do AutoInstall. Not all plugins
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
179 may be AutoInstall-able, and the plugin's author is best situated
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
180 to know whether or not his/her plugin will AutoInstall properly.
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
181
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
182 * A line such as >
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
183 884 1 :AutoInstall: AutoAlign.vim
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
184 < in your GetLatestVimScripts.dat file constitutes your permission
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
185 to getscript to do AutoInstall. AutoInstall requires both your
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
186 and the plugin author's permission. See |GetLatestVimScripts_dat|.
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
187
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
188
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
189 *GetLatestVimScripts_dat*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
190 As an example of a <GetLatestVimScripts.dat> file:
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
191 >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
192 ScriptID SourceID Filename
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
193 --------------------------
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
194 294 1 :AutoInstall: Align.vim
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
195 120 2 Decho.vim
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
196 40 3 DrawIt.tar.gz
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
197 451 4 EasyAccents.vim
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
198 195 5 engspchk.vim
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
199 642 6 GetLatestVimScripts.vim
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
200 489 7 Manpageview.vim
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
201 <
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
202 Note: the first two lines are required, but essentially act as comments.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
203
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
204
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
205 ==============================================================================
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
206 5. GetLatestVimScripts Friendly Plugins *getscript-plugins* *glvs-plugins*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
207
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
208 (this section is for plugin authors)~
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
209
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
210 If a plugin author includes the following comment anywhere in their plugin,
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
211 GetLatestVimScripts will find it and use it to automatically build the user's
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
212 GetLatestVimScripts.dat files:
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
213 >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
214 src_id
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
215 v
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
216 " GetLatestVimScripts: ### ### yourscriptname
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
217 ^
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
218 scriptid
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
219 <
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
220 As an author, you should include such a line in to refer to your own script
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
221 plus any additional lines describing any plugin dependencies it may have.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
222 Same format, of course!
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
223
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
224 If your command is auto-installable (see |glvs-autoinstall|), and most scripts
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
225 are, then you may include :AutoInstall: just before "yourscriptname":
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
226 >
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
227 src_id
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
228 v
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
229 " GetLatestVimScripts: ### ### :AutoInstall: yourscriptname
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
230 ^
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
231 scriptid
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
232 <
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
233 NOTE: The :AutoInstall: feature requires both the plugin author's and~
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
234 the user's permission to operate!~
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
235
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
236 GetLatestVimScripts commands for those scripts are then appended, if not
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
237 already present, to the user's GetLatest/GetLatestVimScripts.dat file. It is
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
238 a relatively painless way to automate the acquisition of any scripts your
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
239 plugins depend upon.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
240
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
241 Now, as an author, you probably don't want GetLatestVimScripts to download
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
242 your own scripts atop your own copy, thereby overwriting your not-yet-released
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
243 hard work. GetLatestVimScripts provides a solution for this: put
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
244 >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
245 0 0 yourscriptname
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
246 <
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
247 into your <GetLatestVimScripts.dat> file and GetLatestVimScripts will skip
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
248 examining the "yourscriptname" scripts for those GetLatestVimScripts comment
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
249 lines. As a result, those lines won't be inadvertently installed into your
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
250 <GetLatestVimScripts.dat> file and subsequently used to download your own
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
251 scripts. This is especially important to do if you've included the
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
252 :AutoInstall: option.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
253
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
254 Be certain to use the same "yourscriptname" in the "0 0 yourscriptname" line
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
255 as you've used in your GetLatestVimScripts comment!
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
256
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
257
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
258 ==============================================================================
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
259 6. GetLatestVimScripts AutoInstall *getscript-autoinstall*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
260 *glvs-autoinstall*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
261
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
262 GetLatestVimScripts now supports "AutoInstall". Not all scripts are
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
263 supportive of auto-install, as they may have special things you need to do to
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
264 install them (please refer to the script's "install" directions). On the
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
265 other hand, most scripts will be auto-installable.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
266
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
267 To let GetLatestVimScripts do an autoinstall, the data file's comment field
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
268 should begin with (surrounding blanks are ignored): >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
269
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
270 :AutoInstall:
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
271 <
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
272 Both colons are needed, and it should begin the comment (yourscriptname)
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
273 field.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
274
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
275 One may prevent any autoinstalling by putting the following line in your
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
276 <.vimrc>: >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
277
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
278 let g:GetLatestVimScripts_allowautoinstall= 0
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
279 <
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
280 With :AutoInstall: enabled, as it is by default, files which end with
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
281
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
282 ---.tar.bz2 : decompressed & untarred in .vim/ directory
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
283 ---.vba.bz2 : decompressed in .vim/ directory, then vimball handles it
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
284 ---.vim.bz2 : decompressed & moved into .vim/plugin directory
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
285 ---.tar.gz : decompressed & untarred in .vim/ directory
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
286 ---.vba.gz : decompressed in .vim/ directory, then vimball handles it
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
287 ---.vim.gz : decompressed & moved into .vim/plugin directory
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
288 ---.vba : unzipped in .vim/ directory
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
289 ---.vim : moved to .vim/plugin directory
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
290 ---.zip : unzipped in .vim/ directory
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
291
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
292 and which merely need to have their components placed by the untar/gunzip or
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
293 move-to-plugin-directory process should be auto-installable. Vimballs, of
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
294 course, should always be auto-installable.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
295
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
296 When is a script not auto-installable? Let me give an example:
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
297
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
298 .vim/after/syntax/blockhl.vim
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
299
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
300 The <blockhl.vim> script provides block highlighting for C/C++ programs; it is
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
301 available at:
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
302
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
303 http://vim.sourceforge.net/scripts/script.php?script_id=104
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
304
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
305 Currently, vim's after/syntax only supports by-filetype scripts (in
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
306 blockhl.vim's case, that's after/syntax/c.vim). Hence, auto-install would
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
307 possibly overwrite the current user's after/syntax/c.vim file.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
308
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
309 In my own case, I use <aftersyntax.vim> (renamed to after/syntax/c.vim) to
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
310 allow a after/syntax/c/ directory:
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
311
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
312 http://vim.sourceforge.net/scripts/script.php?script_id=1023
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
313
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
314 The script allows multiple syntax files to exist separately in the
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
315 after/syntax/c subdirectory. I can't bundle aftersyntax.vim in and build an
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
316 appropriate tarball for auto-install because of the potential for the
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
317 after/syntax/c.vim contained in it to overwrite a user's c.vim.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
318
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
319
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
320 ==============================================================================
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
321 7. GetLatestVimScripts Options *glvs-options*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
322 >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
323 g:GetLatestVimScripts_wget
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
324 < default= "wget"
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
325 This variable holds the name of the command for obtaining
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
326 scripts.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
327 >
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
328 g:GetLatestVimScripts_options
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
329 < default= "-q -O"
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
330 This variable holds the options to be used with the
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
331 g:GetLatestVimScripts_wget command.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
332 >
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
333 g:GetLatestVimScripts_allowautoinstall
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
334 < default= 1
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
335 This variable indicates whether GetLatestVimScripts is allowed
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
336 to attempt to automatically install scripts. Furthermore, the
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
337 plugin author has to have explicitly indicated that his/her
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
338 plugin is automatically installable (via the :AutoInstall:
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
339 keyword in the GetLatestVimScripts comment line).
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
340 >
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
341 g:GetLatestVimScripts_autoinstalldir
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
342 < default= $HOME/.vim (linux)
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
343 default= $HOME/vimfiles (windows)
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
344 Override where :AutoInstall: scripts will be installed.
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
345 Doesn't override vimball installation.
4339
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
346 >
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
347 g:GetLatestVimScripts_scriptaddr
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
348 < default='http://vim.sourceforge.net/script.php?script_id='
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
349 Override this if your system needs
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
350 ... ='http://vim.sourceforge.net/script/script.php?script_id='
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
351
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
352 ==============================================================================
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
353 8. GetLatestVimScripts Algorithm *glvs-algorithm* *glvs-alg*
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
354
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
355 The Vim sourceforge page dynamically creates a page by keying off of the
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
356 so-called script-id. Within the webpage of
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
357
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
358 http://vim.sourceforge.net/scripts/script.php?script_id=40
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
359
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
360 is a line specifying the latest source-id (src_id). The source identifier
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
361 numbers are always increasing, hence if the src_id is greater than the one
1201
4d2585cf5950 updated for version 7.1b
vimboss
parents: 1121
diff changeset
362 recorded for the script in GetLatestVimScripts then it's time to download a
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
363 newer copy of that script.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
364
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
365 GetLatestVimScripts will then download the script and update its internal
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
366 database of script ids, source ids, and scriptnames.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
367
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
368 The AutoInstall process will:
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
369
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
370 Move the file from GetLatest/ to the following directory
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
371 Unix : $HOME/.vim
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
372 Windows: $HOME\vimfiles
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
373 if the downloaded file ends with ".bz2"
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
374 bunzip2 it
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
375 else if the downloaded file ends with ".gz"
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
376 gunzip it
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
377 if the resulting file ends with ".zip"
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
378 unzip it
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
379 else if the resulting file ends with ".tar"
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
380 tar -oxvf it
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
381 else if the resulting file ends with ".vim"
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
382 move it to the plugin subdirectory
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
383
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
384
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
385 ==============================================================================
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
386 9. GetLatestVimScripts History *getscript-history* *glvs-hist* {{{1
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
387
5618
350272cbf1fd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
388 v36 Apr 22, 2013 : * (glts) suggested use of plugin/**/*.vim instead of
350272cbf1fd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
389 plugin/*.vim in globpath() call.
350272cbf1fd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
390 * (Andy Wokula) got warning message when setting
350272cbf1fd Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 5294
diff changeset
391 g:loaded_getscriptPlugin
11914
4f7081eb1e26 Updated runtime files
Christian Brabandt <cb@256bit.org>
parents: 11473
diff changeset
392 v35 Apr 07, 2012 : * (MengHuan Yu) pointed out that the script URL has
4339
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
393 changed (somewhat). However, it doesn't work, and
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
394 the original one does (under Linux). I'll make it
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
395 yet-another-option.
22fa3049e934 Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 3281
diff changeset
396 v34 Jun 23, 2011 : * handles additional decompression options for tarballs
3281
af1e8a1714c2 Update runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2908
diff changeset
397 (tgz taz tbz txz)
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
398 v33 May 31, 2011 : * using fnameescape() instead of escape()
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
399 * *.xz support
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2577
diff changeset
400 v32 Jun 19, 2010 : * (Jan Steffens) added support for xz compression
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
401 v31 Jun 29, 2008 : * (Bill McCarthy) fixed having hls enabled with getscript
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
402 * (David Schaefer) the acd option interferes with vimballs
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
403 Solution: bypass the acd option
1668
0b796e045c42 updated for version 7.2b-000
vimboss
parents: 1620
diff changeset
404 v30 Jun 13, 2008 : * GLVS now checks for existence of fnameescape() and will
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
405 issue an error message if it is not supported
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1247
diff changeset
406 v29 Jan 07, 2008 : * Bram M pointed out that cpo is a global option and that
73fe8baea242 updated for version 7.2a
vimboss
parents: 1247
diff changeset
407 getscriptPlugin.vim was setting it but not restoring it.
73fe8baea242 updated for version 7.2a
vimboss
parents: 1247
diff changeset
408 v28 Jan 02, 2008 : * improved shell quoting character handling, cygwin
73fe8baea242 updated for version 7.2a
vimboss
parents: 1247
diff changeset
409 interface, register-a bypass
73fe8baea242 updated for version 7.2a
vimboss
parents: 1247
diff changeset
410 Oct 29, 2007 * Bill McCarthy suggested a change to getscript that avoids
73fe8baea242 updated for version 7.2a
vimboss
parents: 1247
diff changeset
411 creating pop-up windows
1201
4d2585cf5950 updated for version 7.1b
vimboss
parents: 1121
diff changeset
412 v24 Apr 16, 2007 : * removed save&restore of the fo option during script
4d2585cf5950 updated for version 7.1b
vimboss
parents: 1121
diff changeset
413 loading
1121
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
414 v23 Nov 03, 2006 : * ignores comments (#...)
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
415 * handles vimballs
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
416 v22 Oct 13, 2006 : * supports automatic use of curl if wget is not
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
417 available
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
418 v21 May 01, 2006 : * now takes advantage of autoloading.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
419 v20 Dec 23, 2005 : * Eric Haarbauer found&fixed a bug with unzip use;
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
420 unzip needs the -o flag to overwrite.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
421 v19 Nov 28, 2005 : * v18's GetLatestVimScript line accessed the wrong
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
422 script! Fixed.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
423 v18 Mar 21, 2005 : * bugfix to automatic database construction
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
424 * bugfix - nowrapscan caused an error
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
425 (tnx to David Green for the fix)
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
426 Apr 01, 2005 * if shell is bash, "mv" instead of "ren" used in
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
427 :AutoInstall:s, even though its o/s is windows
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
428 Apr 01, 2005 * when downloading errors occurred, GLVS was
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
429 terminating early. It now just goes on to trying
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
430 the next script (after trying three times to
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
431 download a script description page)
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
432 Apr 20, 2005 * bugfix - when a failure to download occurred,
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
433 GetLatestVimScripts would stop early and claim that
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
434 everything was current. Fixed.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
435 v17 Aug 25, 2004 : * g:GetLatestVimScripts_allowautoinstall, which
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
436 defaults to 1, can be used to prevent all
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
437 :AutoInstall:
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
438 v16 Aug 25, 2004 : * made execution of bunzip2/gunzip/tar/zip silent
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
439 * fixed bug with :AutoInstall: use of helptags
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
440 v15 Aug 24, 2004 : * bugfix: the "0 0 comment" download prevention wasn't
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
441 always preventing downloads (just usually). Fixed.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
442 v14 Aug 24, 2004 : * bugfix -- helptags was using dotvim, rather than
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
443 s:dotvim. Fixed.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
444 v13 Aug 23, 2004 : * will skip downloading a file if its scriptid or srcid
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
445 is zero. Useful for script authors; that way their
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
446 own GetLatestVimScripts activity won't overwrite
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
447 their scripts.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
448 v12 Aug 23, 2004 : * bugfix - a "return" got left in the distribution that
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
449 was intended only for testing. Removed, now works.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
450 * :AutoInstall: implemented
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
451 v11 Aug 20, 2004 : * GetLatestVimScripts is now a plugin:
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
452 * :GetLatestVimScripts command
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
453 * (runtimepath)/GetLatest/GetLatestVimScripts.dat
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
454 now holds scripts that need updating
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
455 v10 Apr 19, 2004 : * moved history from script to doc
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
456 v9 Jan 23, 2004 : windows (win32/win16/win95) will use
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
457 double quotes ("") whereas other systems will use
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
458 single quotes ('') around the urls in calls via wget
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
459 v8 Dec 01, 2003 : makes three tries at downloading
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
460 v7 Sep 02, 2003 : added error messages if "Click on..." or "src_id="
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
461 not found in downloaded webpage
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
462 Uses t_ti, t_te, and rs to make progress visible
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
463 v6 Aug 06, 2003 : final status messages now display summary of work
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
464 ( "Downloaded someqty scripts" or
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
465 "Everything was current")
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
466 Now GetLatestVimScripts is careful about downloading
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
467 GetLatestVimScripts.vim itself!
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
468 (goes to <NEW_GetLatestVimScripts.vim>)
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
469 v5 Aug 04, 2003 : missing an endif near bottom
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
470 v4 Jun 17, 2003 : redraw! just before each "considering" message
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
471 v3 May 27, 2003 : Protects downloaded files from errant shell
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
472 expansions with single quotes: '...'
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
473 v2 May 14, 2003 : extracts name of item to be obtained from the
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
474 script file. Uses it instead of comment field
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
475 for output filename; comment is used in the
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
476 "considering..." line and is now just a comment!
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
477 * Fixed a bug: a string-of-numbers is not the
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
478 same as a number, so I added zero to them
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
479 and they became numbers. Fixes comparison.
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
480
e63691e7c504 updated for version 7.1a
vimboss
parents:
diff changeset
481 ==============================================================================
14421
2f7e67dd088c Update runtime files.
Christian Brabandt <cb@256bit.org>
parents: 13963
diff changeset
482 vim:tw=78:ts=8:noet:ft=help:fdm=marker