Mercurial > vim

comparison runtime/doc/pi_getscript.txt @ 2908:fd09a9c8468e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated runtime files.
author Bram Moolenaar <bram@vim.org>
date Sun, 19 Jun 2011 05:09:16 +0200
parents 073ff46fe397
children af1e8a1714c2
comparison
equal deleted inserted replaced
2907:ea75da0af64d 2908:fd09a9c8468e
1 *pi_getscript.txt* For Vim version 7.3. Last change: 2009 Oct 14 1 *pi_getscript.txt* For Vim version 7.0. Last change: 2011 May 31
2 > 2 >
3 GETSCRIPT REFERENCE MANUAL by Charles E. Campbell, Jr. 3 GETSCRIPT REFERENCE MANUAL by Charles E. Campbell, Jr.
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-2009 by Charles E. Campbell, Jr. *glvs-copyright* 8 Copyright: (c) 2004-2010 by Charles E. Campbell, Jr. *glvs-copyright*
9 The VIM LICENSE applies to getscript.vim and 9 The VIM LICENSE applies to getscript.vim and
10 pi_getscript.txt (see |copyright|) except use 10 pi_getscript.txt (see |copyright|) except use
11 "getscript" instead of "Vim". No warranty, express or implied. 11 "getscript" instead of "Vim". No warranty, express or implied.
12 Use At-Your-Own-Risk. 12 Use At-Your-Own-Risk.
13 13
75 75
76 ============================================================================== 76 ==============================================================================
77 3. GetLatestVimScripts Usage *glvs-usage* *:GLVS* 77 3. GetLatestVimScripts Usage *glvs-usage* *:GLVS*
78 78
79 Unless it has been defined elsewhere, > 79 Unless it has been defined elsewhere, >
80
80 :GLVS 81 :GLVS
82
81 will invoke GetLatestVimScripts(). If some other plugin has defined that 83 will invoke GetLatestVimScripts(). If some other plugin has defined that
82 command, then you may type 84 command, then you may type
83 > 85 >
84 :GetLatestVimScripts 86 :GetLatestVimScripts
85 < 87 <
125 click on the script's link, you'll see a line resembling 127 click on the script's link, you'll see a line resembling
126 128
127 http://vim.sourceforge.net/scripts/script.php?script_id=40 129 http://vim.sourceforge.net/scripts/script.php?script_id=40
128 130
129 The "40" happens to be a ScriptID that GetLatestVimScripts needs to 131 The "40" happens to be a ScriptID that GetLatestVimScripts needs to
130 download the associated page. 132 download the associated page, and is assigned by vim.sf.net itself
133 during initial uploading of the plugin.
131 134
132 The second number on each line gives the script's SourceID. The SourceID 135 The second number on each line gives the script's SourceID. The SourceID
133 records the count of uploaded scripts as determined by vim.sf.net; hence it 136 records the count of uploaded scripts as determined by vim.sf.net; hence it
134 serves to indicate "when" a script was uploaded. Setting the SourceID to 1 137 serves to indicate "when" a script was uploaded. Setting the SourceID to 1
135 insures that GetLatestVimScripts will assume that the script it has is 138 insures that GetLatestVimScripts will assume that the script it has is
149 152
150 This comment line tells getscript.vim to check vimscript #884 and that the 153 This comment line tells getscript.vim to check vimscript #884 and that the
151 script is automatically installable. Getscript will also use this line to 154 script is automatically installable. Getscript will also use this line to
152 help build the GetLatestVimScripts.dat file, by including a line such as: > 155 help build the GetLatestVimScripts.dat file, by including a line such as: >
153 156
154 884 1 AutoAlign.vim 157 884 1 :AutoInstall: AutoAlign.vim
155 < 158 <
156 in it an AutoAlign.vim line isn't already in GetLatestVimScripts.dat file. 159 assuming that such a line isn't already in GetLatestVimScripts.dat file.
157 See |glvs-plugins| for more. Thus, GetLatestVimScripts thus provides a 160 See |glvs-plugins| for more. Thus, GetLatestVimScripts thus provides a
158 comprehensive ability to keep your plugins up-to-date! 161 comprehensive ability to keep your plugins up-to-date!
159 162
163 In summary:
164
165 * Optionally tell getscript that it is allowed to build/append a
166 GetLatestVimScripts.dat file based upon already installed plugins: >
167 let g:GetLatestVimScripts_allowautoinstall=1
168 <
169 * A line such as >
170 " GetLatestVimScripts: 884 1 :AutoInstall: AutoAlign.vim
171 < in an already-downloaded plugin constitutes the concurrence of the
172 plugin author that getscript may do AutoInstall. Not all plugins
173 may be AutoInstall-able, and the plugin's author is best situated
174 to know whether or not his/her plugin will AutoInstall properly.
175
176 * A line such as >
177 884 1 :AutoInstall: AutoAlign.vim
178 < in your GetLatestVimScripts.dat file constitutes your permission
179 to getscript to do AutoInstall. AutoInstall requires both your
180 and the plugin author's permission. See |GetLatestVimScripts_dat|.
181
182
160 *GetLatestVimScripts_dat* 183 *GetLatestVimScripts_dat*
161 As an example of a <GetLatestVimScripts.dat> file: 184 As an example of a <GetLatestVimScripts.dat> file:
162 > 185 >
163 ScriptID SourceID Filename 186 ScriptID SourceID Filename
164 -------------------------- 187 --------------------------
165 294 1 Align.vim 188 294 1 :AutoInstall: Align.vim
166 120 2 decho.vim 189 120 2 Decho.vim
167 40 3 DrawIt.tar.gz 190 40 3 DrawIt.tar.gz
168 451 4 EasyAccents.vim 191 451 4 EasyAccents.vim
169 195 5 engspchk.vim 192 195 5 engspchk.vim
170 642 6 GetLatestVimScripts.vim 193 642 6 GetLatestVimScripts.vim
171 489 7 Manpageview.vim 194 489 7 Manpageview.vim
199 v 222 v
200 " GetLatestVimScripts: ### ### :AutoInstall: yourscriptname 223 " GetLatestVimScripts: ### ### :AutoInstall: yourscriptname
201 ^ 224 ^
202 scriptid 225 scriptid
203 < 226 <
204 NOTE: :AutoInstall: is a plugin-author option, not a GetLatestVimScripts.dat~ 227 NOTE: The :AutoInstall: feature requires both the plugin author's and~
205 entry!~ 228 the user's permission to operate!~
206 229
207 GetLatestVimScripts commands for those scripts are then appended, if not 230 GetLatestVimScripts commands for those scripts are then appended, if not
208 already present, to the user's GetLatest/GetLatestVimScripts.dat file. It is 231 already present, to the user's GetLatest/GetLatestVimScripts.dat file. It is
209 a relatively painless way to automate the acquisition of any scripts your 232 a relatively painless way to automate the acquisition of any scripts your
210 plugins depend upon. 233 plugins depend upon.
211 234
212 Now, as an author, you probably don't want GetLatestVimScripts to download 235 Now, as an author, you probably don't want GetLatestVimScripts to download
213 your own scripts for you yourself, thereby overwriting your not-yet-released 236 your own scripts atop your own copy, thereby overwriting your not-yet-released
214 hard work. GetLatestVimScripts provides a solution for this: put 237 hard work. GetLatestVimScripts provides a solution for this: put
215 > 238 >
216 0 0 yourscriptname 239 0 0 yourscriptname
217 < 240 <
218 into your <GetLatestVimScripts.dat> file and GetLatestVimScripts will skip 241 into your <GetLatestVimScripts.dat> file and GetLatestVimScripts will skip
349 372
350 373
351 ============================================================================== 374 ==============================================================================
352 9. GetLatestVimScripts History *getscript-history* *glvs-hist* {{{1 375 9. GetLatestVimScripts History *getscript-history* *glvs-hist* {{{1
353 376
377 v33 May 31, 2011 : * using fnameescape() instead of escape()
378 * *.xz support
379 v32 Jun 19, 2010 : * (Jan Steffens) added support for xz compression
354 v31 Jun 29, 2008 : * (Bill McCarthy) fixed having hls enabled with getscript 380 v31 Jun 29, 2008 : * (Bill McCarthy) fixed having hls enabled with getscript
355 * (David Schaefer) the acd option interferes with vimballs 381 * (David Schaefer) the acd option interferes with vimballs
356 Solution: bypass the acd option 382 Solution: bypass the acd option
357 v30 Jun 13, 2008 : * GLVS now checks for existence of fnameescape() and will 383 v30 Jun 13, 2008 : * GLVS now checks for existence of fnameescape() and will
358 issue an error message if it is not supported 384 issue an error message if it is not supported