Mercurial > vim

comparison runtime/doc/getscript.txt @ 856:8cd729851562 v7.0g

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated for version 7.0g
author vimboss
date Sun, 30 Apr 2006 18:54:39 +0000
parents a209672376fd
children 4bac29d27e2f
comparison
equal deleted inserted replaced
855:d2a4f08396fe 856:8cd729851562
1 *getscript.txt* For Vim version 7.0f. Last change: 2006 Mar 24 1 *getscript.txt* For Vim version 7.0g. Last change: 2006 Apr 30
2 2
3 Get the Latest VimScripts 3 Get the Latest VimScripts
4 4
5 Authors: Charles E. Campbell, Jr. <NdrOchip@ScampbellPfamilyA.Mbiz> 5 Authors: Charles E. Campbell, Jr. <NdrOchip@ScampbellPfamilyA.Mbiz>
6 (remove NOSPAM from the email address) 6 (remove NOSPAM from the email address)
7 *GetLatestVimScripts-copyright* 7 *GetLatestVimScripts-copyright*
8 Copyright: (c) 2004-2005 by Charles E. Campbell, Jr. 8 Copyright: (c) 2004-2005 by Charles E. Campbell, Jr.
9 The VIM LICENSE applies to GetLatestVimScripts.vim and 9 The VIM LICENSE applies to GetLatestVimScripts.vim and
10 GetLatestVimScripts.txt (see |copyright|) except use 10 GetLatestVimScripts.txt (see |copyright|) except use
11 "GetLatestVimScripts" instead of "Vim". 11 "GetLatestVimScripts" instead of "Vim".
12 No warranty, express or implied. Use At-Your-Own-Risk. 12 No warranty, express or implied. Use At-Your-Own-Risk.
13 13
14 14
15 ============================================================================== 15 ==============================================================================
16 1. Contents *glvs-contents* 16 1. Contents *glvs-contents*
17 17
97 97
98 If a plugin author includes the following comment anywhere in their 98 If a plugin author includes the following comment anywhere in their
99 plugin, GetLatestVimScripts will find it and use it to build user's 99 plugin, GetLatestVimScripts will find it and use it to build user's
100 GetLatestVimScripts.dat files: 100 GetLatestVimScripts.dat files:
101 > 101 >
102 src_id 102 src_id
103 v 103 v
104 " GetLatestVimScripts: ### ### yourscriptname 104 " GetLatestVimScripts: ### ### yourscriptname
105 ^ 105 ^
106 scriptid 106 scriptid
107 < 107 <
108 As an author, you should include such a line in to refer to your own 108 As an author, you should include such a line in to refer to your own
109 script plus any additional lines describing any plugin dependencies it 109 script plus any additional lines describing any plugin dependencies it
110 may have. Same format, of course! 110 may have. Same format, of course!
111 111
112 If your command is auto-installable (see |glvs-autoinstall|), and most 112 If your command is auto-installable (see |glvs-autoinstall|), and most
144 GetLatestVimScripts now supports "AutoInstall". Not all scripts are 144 GetLatestVimScripts now supports "AutoInstall". Not all scripts are
145 supportive of auto-install, as they may have special things you need 145 supportive of auto-install, as they may have special things you need
146 to do to install them (please refer to the script's "install" 146 to do to install them (please refer to the script's "install"
147 directions). On the other hand, most scripts will be 147 directions). On the other hand, most scripts will be
148 auto-installable. 148 auto-installable.
149 149
150 To let GetLatestVimScripts do an autoinstall, the data file's comment 150 To let GetLatestVimScripts do an autoinstall, the data file's comment
151 field should begin with (surrounding blanks are ignored): 151 field should begin with (surrounding blanks are ignored):
152 152
153 :AutoInstall: 153 :AutoInstall:
154 154
155 Both colons are needed, and it should begin the comment 155 Both colons are needed, and it should begin the comment
156 (yourscriptname) field. 156 (yourscriptname) field.
157 157
158 One may prevent any autoinstalling by putting the following line 158 One may prevent any autoinstalling by putting the following line
159 in your <.vimrc>: 159 in your <.vimrc>:
160 > 160 >
161 let g:GetLatestVimScripts_allowautoinstall= 0 161 let g:GetLatestVimScripts_allowautoinstall= 0
162 < 162 <
163 163
164 With :AutoInstall: enabled, as it is by default, files which end with 164 With :AutoInstall: enabled, as it is by default, files which end with
165 165
166 ---.tar.bz2 : decompressed and untarred in [.vim|vimfiles] directory 166 ---.tar.bz2 : decompressed and untarred in [.vim|vimfiles] directory
167 ---.tar.gz : decompressed and untarred in [.vim|vimfiles] directory 167 ---.tar.gz : decompressed and untarred in [.vim|vimfiles] directory
168 ---.vim.bz2 : decompressed and moved to the .vim/plugin directory 168 ---.vim.bz2 : decompressed and moved to the .vim/plugin directory
169 ---.vim.gz : decompressed and moved to the .vim/plugin directory 169 ---.vim.gz : decompressed and moved to the .vim/plugin directory
170 ---.zip : unzipped in [.vim|vimfiles] directory 170 ---.zip : unzipped in [.vim|vimfiles] directory
171 ---.vim : moved to [.vim|vimfiles]/plugin directory 171 ---.vim : moved to [.vim|vimfiles]/plugin directory
172 172
173 and which merely need to have their components placed by the 173 and which merely need to have their components placed by the
174 untar/gunzip or move-to-plugin-directory process should be 174 untar/gunzip or move-to-plugin-directory process should be
175 auto-installable. 175 auto-installable.
176 176
177 When is a script not auto-installable? Let me give an example: 177 When is a script not auto-installable? Let me give an example:
184 http://vim.sourceforge.net/scripts/script.php?script_id=104 184 http://vim.sourceforge.net/scripts/script.php?script_id=104
185 < 185 <
186 Currently, vim's after/syntax only supports by-filetype scripts (in 186 Currently, vim's after/syntax only supports by-filetype scripts (in
187 blockhl.vim's case, that's after/syntax/c.vim). Hence, auto-install 187 blockhl.vim's case, that's after/syntax/c.vim). Hence, auto-install
188 would possibly overwrite the current user's after/syntax/c.vim file. 188 would possibly overwrite the current user's after/syntax/c.vim file.
189 189
190 In my own case, I use <aftersyntax.vim> (renamed to 190 In my own case, I use <aftersyntax.vim> (renamed to
191 after/syntax/c.vim) to allow a after/syntax/c/ directory: 191 after/syntax/c.vim) to allow a after/syntax/c/ directory:
192 > 192 >
193 http://vim.sourceforge.net/scripts/script.php?script_id=1023 193 http://vim.sourceforge.net/scripts/script.php?script_id=1023
194 < 194 <
219 The AutoInstall process will: 219 The AutoInstall process will:
220 220
221 Move the file from GetLatest/ to the following directory 221 Move the file from GetLatest/ to the following directory
222 Unix : $HOME/.vim 222 Unix : $HOME/.vim
223 Windows: $HOME\vimfiles 223 Windows: $HOME\vimfiles
224 224
225 if the downloaded file ends with ".bz2" 225 if the downloaded file ends with ".bz2"
226 bunzip2 it 226 bunzip2 it
227 else if the downloaded file ends with ".gz" 227 else if the downloaded file ends with ".gz"
228 gunzip it 228 gunzip it
229 if the resulting file ends with ".zip" 229 if the resulting file ends with ".zip"
236 236
237 ============================================================================== 237 ==============================================================================
238 7. GetLatestVimScripts History *getlatestvimscripts-history* *glvs-hist* 238 7. GetLatestVimScripts History *getlatestvimscripts-history* *glvs-hist*
239 239
240 v20 Dec 23, 2005 : * Eric Haarbauer found&fixed a bug with unzip use; 240 v20 Dec 23, 2005 : * Eric Haarbauer found&fixed a bug with unzip use;
241 unzip needs the -o flag to overwrite. 241 unzip needs the -o flag to overwrite.
242 v19 Nov 28, 2005 : * v18's GetLatestVimScript line accessed the wrong 242 v19 Nov 28, 2005 : * v18's GetLatestVimScript line accessed the wrong
243 script! Fixed. 243 script! Fixed.
244 v18 Mar 21, 2005 : * bugfix to automatic database construction 244 v18 Mar 21, 2005 : * bugfix to automatic database construction
245 * bugfix - nowrapscan caused an error 245 * bugfix - nowrapscan caused an error
246 (tnx to David Green for the fix) 246 (tnx to David Green for the fix)
247 Apr 01, 2005 * if shell is bash, "mv" instead of "ren" used in 247 Apr 01, 2005 * if shell is bash, "mv" instead of "ren" used in
248 :AutoInstall:s, even though its o/s is windows 248 :AutoInstall:s, even though its o/s is windows
249 Apr 01, 2005 * when downloading errors occurred, GLVS was 249 Apr 01, 2005 * when downloading errors occurred, GLVS was
250 terminating early. It now just goes on to trying 250 terminating early. It now just goes on to trying
251 the next script (after trying three times to 251 the next script (after trying three times to
252 download a script description page) 252 download a script description page)
253 Apr 20, 2005 * bugfix - when a failure to download occurred, 253 Apr 20, 2005 * bugfix - when a failure to download occurred,
254 GetLatestVimScripts would stop early and claim that 254 GetLatestVimScripts would stop early and claim that
255 everything was current. Fixed. 255 everything was current. Fixed.
256 v17 Aug 25, 2004 : * g:GetLatestVimScripts_allowautoinstall, which 256 v17 Aug 25, 2004 : * g:GetLatestVimScripts_allowautoinstall, which
257 defaults to 1, can be used to prevent all 257 defaults to 1, can be used to prevent all
258 :AutoInstall: 258 :AutoInstall:
259 v16 Aug 25, 2004 : * made execution of bunzip2/gunzip/tar/zip silent 259 v16 Aug 25, 2004 : * made execution of bunzip2/gunzip/tar/zip silent
260 * fixed bug with :AutoInstall: use of helptags 260 * fixed bug with :AutoInstall: use of helptags
261 v15 Aug 24, 2004 : * bugfix: the "0 0 comment" download prevention wasn't 261 v15 Aug 24, 2004 : * bugfix: the "0 0 comment" download prevention wasn't
262 always preventing downloads (just usually). Fixed. 262 always preventing downloads (just usually). Fixed.
263 v14 Aug 24, 2004 : * bugfix -- helptags was using dotvim, rather than 263 v14 Aug 24, 2004 : * bugfix -- helptags was using dotvim, rather than
264 s:dotvim. Fixed. 264 s:dotvim. Fixed.
265 v13 Aug 23, 2004 : * will skip downloading a file if its scriptid or srcid 265 v13 Aug 23, 2004 : * will skip downloading a file if its scriptid or srcid
266 is zero. Useful for script authors; that way their 266 is zero. Useful for script authors; that way their
267 own GetLatestVimScripts activity won't overwrite 267 own GetLatestVimScripts activity won't overwrite
268 their scripts. 268 their scripts.
269 v12 Aug 23, 2004 : * bugfix - a "return" got left in the distribution that 269 v12 Aug 23, 2004 : * bugfix - a "return" got left in the distribution that
270 was intended only for testing. Removed, now works. 270 was intended only for testing. Removed, now works.
271 * :AutoInstall: implemented 271 * :AutoInstall: implemented
272 v11 Aug 20, 2004 : * GetLatestVimScripts is now a plugin: 272 v11 Aug 20, 2004 : * GetLatestVimScripts is now a plugin:
273 * :GetLatestVimScripts command 273 * :GetLatestVimScripts command
274 * (runtimepath)/GetLatest/GetLatestVimScripts.dat 274 * (runtimepath)/GetLatest/GetLatestVimScripts.dat
275 now holds scripts that need updating 275 now holds scripts that need updating
276 v10 Apr 19, 2004 : * moved history from script to doc 276 v10 Apr 19, 2004 : * moved history from script to doc
277 v9 Jan 23, 2004 : windows (win32/win16/win95) will use 277 v9 Jan 23, 2004 : windows (win32/win16/win95) will use
278 double quotes ("") whereas other systems will use 278 double quotes ("") whereas other systems will use
279 single quotes ('') around the urls in calls via wget 279 single quotes ('') around the urls in calls via wget
280 v8 Dec 01, 2003 : makes three tries at downloading 280 v8 Dec 01, 2003 : makes three tries at downloading
281 v7 Sep 02, 2003 : added error messages if "Click on..." or "src_id=" 281 v7 Sep 02, 2003 : added error messages if "Click on..." or "src_id="
282 not found in downloaded webpage 282 not found in downloaded webpage
283 Uses t_ti, t_te, and rs to make progress visible 283 Uses t_ti, t_te, and rs to make progress visible
284 v6 Aug 06, 2003 : final status messages now display summary of work 284 v6 Aug 06, 2003 : final status messages now display summary of work
285 ( "Downloaded someqty scripts" or 285 ( "Downloaded someqty scripts" or
286 "Everything was current") 286 "Everything was current")
287 Now GetLatestVimScripts is careful about downloading 287 Now GetLatestVimScripts is careful about downloading
288 GetLatestVimScripts.vim itself! 288 GetLatestVimScripts.vim itself!
289 (goes to <NEW_GetLatestVimScripts.vim>) 289 (goes to <NEW_GetLatestVimScripts.vim>)
290 v5 Aug 04, 2003 : missing an endif near bottom 290 v5 Aug 04, 2003 : missing an endif near bottom
291 v4 Jun 17, 2003 : redraw! just before each "considering" message 291 v4 Jun 17, 2003 : redraw! just before each "considering" message
292 v3 May 27, 2003 : Protects downloaded files from errant shell 292 v3 May 27, 2003 : Protects downloaded files from errant shell
293 expansions with single quotes: '...' 293 expansions with single quotes: '...'
294 v2 May 14, 2003 : extracts name of item to be obtained from the 294 v2 May 14, 2003 : extracts name of item to be obtained from the
295 script file. Uses it instead of comment field 295 script file. Uses it instead of comment field
296 for output filename; comment is used in the 296 for output filename; comment is used in the
297 "considering..." line and is now just a comment! 297 "considering..." line and is now just a comment!
298 * Fixed a bug: a string-of-numbers is not the 298 * Fixed a bug: a string-of-numbers is not the
299 same as a number, so I added zero to them 299 same as a number, so I added zero to them
300 and they became numbers. Fixes comparison. 300 and they became numbers. Fixes comparison.
301 301
302 ============================================================================== 302 ==============================================================================
303 vim:tw=78:ts=8:ft=help 303 vim:tw=78:ts=8:ft=help