updated for version 7.1a

1 files changed, 58 insertions, 13 deletions

diff --git a/runtime/doc/pi_vimball.txt b/runtime/doc/pi_vimball.txt
index 1fefc7f906..75eae344a8 100644
--- a/runtime/doc/pi_vimball.txt
+++ b/runtime/doc/pi_vimball.txt
@@ -1,4 +1,4 @@
-*pi_vimball.txt*	For Vim version 7.0.  Last change: 2006 May 01
+*pi_vimball.txt*	For Vim version 7.1a.  Last change: 2007 Jan 03
 
 			       ----------------
 			       Vimball Archiver
@@ -13,10 +13,13 @@ Copyright: (c) 2004-2006 by Charles E. Campbell, Jr.	*Vimball-copyright*
 	   Use At-Your-Own-Risk!
 
 ==============================================================================
-1. Contents					*vimball* *vimball-contents*
+1. Contents				*vba* *vimball* *vimball-contents*
 
 	1. Contents......................................: |vimball-contents|
 	2. Vimball Manual................................: |vimball-manual|
+	   MkVimball.....................................: |:MkVimball|
+	   UseVimball....................................: |:UseVimball|
+	   RmVimball.....................................: |:RmVimball|
 	3. Vimball History...............................: |vimball-history|
 
 
@@ -24,19 +27,26 @@ Copyright: (c) 2004-2006 by Charles E. Campbell, Jr.	*Vimball-copyright*
 2. Vimball Manual					*vimball-manual*
 
 							*:MkVimball*
-		:[range]MkVimball[!] filename
+		:[range]MkVimball[!] filename [path]
 
-	This command takes lines holding a path to files to be included in
-	your vimball; as an example: >
+	The range is composed of lines holding paths to files to be included
+	in your new vimball.  As an example: >
 		plugin/something.vim
 		doc/something.txt
-<	using MkVimball on this range will create a file called "filename.vba"
-	which can be used by Vimball.vim to re-create these files.  If the
+<	using >
+		:[range]MkVimball filename
+<
+	on this range of lines will create a file called "filename.vba" which
+	can be used by Vimball.vim to re-create these files.  If the
 	"filename.vba" file already exists, then MkVimball will issue a
 	warning and not create the file.  Note that these paths are relative
 	to your .vim (vimfiles) directory, and the files should be in that
-	directory.  The vimball plugin uses the first |'runtimepath'|directory
-	that exists as a prefix; don't use absolute paths.
+	directory.  The vimball plugin normally uses the first |'runtimepath'|
+	directory that exists as a prefix; don't use absolute paths, unless
+	the user has specified such a path.
+							*g:vimball_home*
+	You may override the use of the |'runtimepath'| by specifying a
+	variable, g:vimball_home.
 
 	If you use the exclamation point (!), then MkVimball will create the
 	"filename.vba" file, overwriting it if it already exists.  This
@@ -52,22 +62,57 @@ Copyright: (c) 2004-2006 by Charles E. Campbell, Jr.	*Vimball-copyright*
 	file holds the "Vimball Archiver by Charles E. Campbell, Jr., Ph.D."
 	line.
 
-		:VimballList				*vimball-vimballlist*
+		:VimballList				*:VimballList*
 
 	This command will tell Vimball to list the files in the archive, along
 	with their lengths in lines.
 
+		:UseVimball [path]			*:UseVimball*
+
+	This command is contained within the vimball itself; it invokes the
+	vimball#Vimball() routine which is responsible for unpacking the
+	vimball.  One may choose to execute it by hand instead of sourcing
+	the vimball; one may also choose to specify a path for the
+	installation, thereby overriding the automatic choice of the first
+	existing directory on the |'runtimepath'|.
+
+		:RmVimball vimballfile [path]		*:RmVimball*
+
+	This command removes all files generated by the specified vimball
+	(but not any directories it may have made).  One may choose a path
+	for de-installation, too (see |'runtimepath'|); otherwise, the
+	default is the first existing directory on the |'runtimepath'|.
+	To implement this, a file (.VimballRecord) is made in that directory
+	containing a record of what files need to be removed for all vimballs
+	used thus far.
+
 
 ==============================================================================
 3. Vimball History					*vimball-history* {{{1
 
+	21 : Nov 27, 2006 * (tnx to Bill McCarthy) vimball had a header
+	                    handling problem and it now changes \s to /s
+	20 : Nov 20, 2006 * substitute() calls have all had the 'e' flag
+	                    removed.
+	18 : Aug 01, 2006 * vimballs now use folding to easily display their
+	                    contents.
+			  * if a user has AsNeeded/somefile, then vimball
+			    will extract plugin/somefile to the AsNeeded/
+			    directory
+	17 : Jun 28, 2006 * changes all \s to /s internally for Windows
+	16 : Jun 15, 2006 * A. Mechylynk's idea to allow users to specify
+			    installation root paths implemented for
+			    UseVimball, MkVimball, and RmVimball.
+			  * RmVimball implemented
+	15 : Jun 13, 2006 * bugfix
+	14 : May 26, 2006 * bugfixes
 	13 : May 01, 2006 * exists("&acd") used to determine if the acd
 			    option exists
 	12 : May 01, 2006 * bugfix - the |'acd'| option is not always defined
 	11 : Apr 27, 2006 * VimballList would create missing subdirectories that
-			    the vimball specified were needed.	Fixed.
+			    the vimball specified were needed.  Fixed.
 	10 : Apr 27, 2006 * moved all setting saving/restoration to a pair of
-			    functions.	Included some more settings in them
+			    functions.  Included some more settings in them
 			    which frequently cause trouble.
 	9  : Apr 26, 2006 * various changes to support Windows prediliction
 			    for backslashes and spaces in file and directory
@@ -80,7 +125,7 @@ Copyright: (c) 2004-2006 by Charles E. Campbell, Jr.	*Vimball-copyright*
 			    only fires once, so the "Source this file..."
 			    message is now issued only once.
 	3  : Mar 20, 2006 * removed query, now requires sourcing to be
-			    extracted (:so %).	Message to that effect
+			    extracted (:so %).  Message to that effect
 			    included.
 			  * :VimballList  now shows files that would be
 			    extracted.