summaryrefslogtreecommitdiffstats
path: root/runtime/doc/pi_getscript.txt
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2011-06-19 05:09:16 +0200
committerBram Moolenaar <Bram@vim.org>2011-06-19 05:09:16 +0200
commit251e19127170e7387da1f10b9c99c957b16477fc (patch)
treeb286383f88539796b7ce8d724cf9872f8910bf72 /runtime/doc/pi_getscript.txt
parentd6761c3cdf9d15c0f64253dcd8049ff9f25aa987 (diff)
Updated runtime files.
Diffstat (limited to 'runtime/doc/pi_getscript.txt')
-rw-r--r--runtime/doc/pi_getscript.txt46
1 files changed, 36 insertions, 10 deletions
diff --git a/runtime/doc/pi_getscript.txt b/runtime/doc/pi_getscript.txt
index 8d4e4719c0..86e3cdd0ce 100644
--- a/runtime/doc/pi_getscript.txt
+++ b/runtime/doc/pi_getscript.txt
@@ -1,11 +1,11 @@
-*pi_getscript.txt* For Vim version 7.3. Last change: 2009 Oct 14
+*pi_getscript.txt* For Vim version 7.0. Last change: 2011 May 31
>
GETSCRIPT REFERENCE MANUAL by Charles E. Campbell, Jr.
<
Authors: Charles E. Campbell, Jr. <NdrOchip@ScampbellPfamilyA.Mbiz>
(remove NOSPAM from the email address)
*GetLatestVimScripts-copyright*
-Copyright: (c) 2004-2009 by Charles E. Campbell, Jr. *glvs-copyright*
+Copyright: (c) 2004-2010 by Charles E. Campbell, Jr. *glvs-copyright*
The VIM LICENSE applies to getscript.vim and
pi_getscript.txt (see |copyright|) except use
"getscript" instead of "Vim". No warranty, express or implied.
@@ -77,7 +77,9 @@ Your computer needs to have wget or curl for GetLatestVimScripts to do its work.
3. GetLatestVimScripts Usage *glvs-usage* *:GLVS*
Unless it has been defined elsewhere, >
+
:GLVS
+
will invoke GetLatestVimScripts(). If some other plugin has defined that
command, then you may type
>
@@ -127,7 +129,8 @@ click on the script's link, you'll see a line resembling
http://vim.sourceforge.net/scripts/script.php?script_id=40
The "40" happens to be a ScriptID that GetLatestVimScripts needs to
-download the associated page.
+download the associated page, and is assigned by vim.sf.net itself
+during initial uploading of the plugin.
The second number on each line gives the script's SourceID. The SourceID
records the count of uploaded scripts as determined by vim.sf.net; hence it
@@ -151,19 +154,39 @@ This comment line tells getscript.vim to check vimscript #884 and that the
script is automatically installable. Getscript will also use this line to
help build the GetLatestVimScripts.dat file, by including a line such as: >
- 884 1 AutoAlign.vim
+ 884 1 :AutoInstall: AutoAlign.vim
<
-in it an AutoAlign.vim line isn't already in GetLatestVimScripts.dat file.
+assuming that such a line isn't already in GetLatestVimScripts.dat file.
See |glvs-plugins| for more. Thus, GetLatestVimScripts thus provides a
comprehensive ability to keep your plugins up-to-date!
+In summary:
+
+ * Optionally tell getscript that it is allowed to build/append a
+ GetLatestVimScripts.dat file based upon already installed plugins: >
+ let g:GetLatestVimScripts_allowautoinstall=1
+<
+ * A line such as >
+ " GetLatestVimScripts: 884 1 :AutoInstall: AutoAlign.vim
+< in an already-downloaded plugin constitutes the concurrence of the
+ plugin author that getscript may do AutoInstall. Not all plugins
+ may be AutoInstall-able, and the plugin's author is best situated
+ to know whether or not his/her plugin will AutoInstall properly.
+
+ * A line such as >
+ 884 1 :AutoInstall: AutoAlign.vim
+< in your GetLatestVimScripts.dat file constitutes your permission
+ to getscript to do AutoInstall. AutoInstall requires both your
+ and the plugin author's permission. See |GetLatestVimScripts_dat|.
+
+
*GetLatestVimScripts_dat*
As an example of a <GetLatestVimScripts.dat> file:
>
ScriptID SourceID Filename
--------------------------
- 294 1 Align.vim
- 120 2 decho.vim
+ 294 1 :AutoInstall: Align.vim
+ 120 2 Decho.vim
40 3 DrawIt.tar.gz
451 4 EasyAccents.vim
195 5 engspchk.vim
@@ -201,8 +224,8 @@ are, then you may include :AutoInstall: just before "yourscriptname":
^
scriptid
<
-NOTE: :AutoInstall: is a plugin-author option, not a GetLatestVimScripts.dat~
- entry!~
+NOTE: The :AutoInstall: feature requires both the plugin author's and~
+ the user's permission to operate!~
GetLatestVimScripts commands for those scripts are then appended, if not
already present, to the user's GetLatest/GetLatestVimScripts.dat file. It is
@@ -210,7 +233,7 @@ a relatively painless way to automate the acquisition of any scripts your
plugins depend upon.
Now, as an author, you probably don't want GetLatestVimScripts to download
-your own scripts for you yourself, thereby overwriting your not-yet-released
+your own scripts atop your own copy, thereby overwriting your not-yet-released
hard work. GetLatestVimScripts provides a solution for this: put
>
0 0 yourscriptname
@@ -351,6 +374,9 @@ The AutoInstall process will:
==============================================================================
9. GetLatestVimScripts History *getscript-history* *glvs-hist* {{{1
+v33 May 31, 2011 : * using fnameescape() instead of escape()
+ * *.xz support
+v32 Jun 19, 2010 : * (Jan Steffens) added support for xz compression
v31 Jun 29, 2008 : * (Bill McCarthy) fixed having hls enabled with getscript
* (David Schaefer) the acd option interferes with vimballs
Solution: bypass the acd option