Update documentation files.

1 files changed, 50 insertions, 20 deletions

diff --git a/runtime/doc/pi_vimball.txt b/runtime/doc/pi_vimball.txt
index 143396e01..885131e29 100644
--- a/runtime/doc/pi_vimball.txt
+++ b/runtime/doc/pi_vimball.txt
@@ -1,4 +1,4 @@
-*pi_vimball.txt*	For Vim version 7.2.  Last change: 2008 Jul 30
+*pi_vimball.txt*	For Vim version 7.2.  Last change: 2009 Dec 28
 
 			       ----------------
 			       Vimball Archiver
@@ -6,7 +6,7 @@
 
 Author:  Charles E. Campbell, Jr.  <NdrOchip@ScampbellPfamily.AbizM>
 	  (remove NOSPAM from Campbell's email first)
-Copyright: (c) 2004-2008 by Charles E. Campbell, Jr.	*Vimball-copyright*
+Copyright: (c) 2004-2009 by Charles E. Campbell, Jr.	*Vimball-copyright*
 	   The VIM LICENSE applies to Vimball.vim, and Vimball.txt
 	   (see |copyright|) except use "Vimball" instead of "Vim".
 	   No warranty, express or implied.
@@ -55,7 +55,7 @@ Copyright: (c) 2004-2008 by Charles E. Campbell, Jr.	*Vimball-copyright*
 ==============================================================================
 3. Vimball Manual					*vimball-manual*
 
-							*:MkVimball*
+MAKING A VIMBALL						*:MkVimball*
 		:[range]MkVimball[!] filename [path]
 
 	The range is composed of lines holding paths to files to be included
@@ -79,28 +79,33 @@ Copyright: (c) 2004-2008 by Charles E. Campbell, Jr.	*Vimball-copyright*
 	"filename.vba" file, overwriting it if it already exists.  This
 	behavior resembles that for |:w|.
 
-							*g:vimball_mkdir*
+	If you wish to force slashes into the filename, that can also be done
+	by using the exclamation mark (ie. :MkVimball! path/filename).
+
+	The tip at http://vim.wikia.com/wiki/Using_VimBall_with_%27Make%27
+	has a good idea on how to automate the production of vimballs using
+	make.
+
+
+MAKING DIRECTORIES VIA VIMBALLS				*g:vimball_mkdir*
+
 	First, the |mkdir()| command is tried (not all systems support it).
 
-	If it doesn't exist, then g:vimball_mkdir doesn't exist, it is set to:
+	If it doesn't exist, then if g:vimball_mkdir doesn't exist, it is set
+	as follows: >
 	  |g:netrw_local_mkdir|, if it exists
-	   "mkdir", if it is executable
-	   "makedir", if it is executable
-	   Otherwise, it is undefined.
-	One may explicitly specify the directory making command using
+	  "mkdir"              , if it is executable
+	  "makedir"            , if it is executable
+	  Otherwise            , it is undefined.
+<	One may explicitly specify the directory making command using
 	g:vimball_mkdir.  This command is used to make directories that
 	are needed as indicated by the vimball.
 
-							*g:vimball_home*
-	You may override the use of the |'runtimepath'| by specifying a
-	variable, g:vimball_home.
 
-	Path Preprocessing				*g:vimball_path_escape*
+CONTROLLING THE VIMBALL EXTRACTION DIRECTORY		*g:vimball_home*
 
-	Paths used in vimball are preprocessed by s:Path(); in addition,
-	certain characters are escaped (by prepending a backslash).  The
-	characters are in g:vimball_path_escape, and may be overridden by
-	the user in his/her .vimrc initialization script.
+	You may override the use of the |'runtimepath'| by specifying a
+	variable, g:vimball_home.
 
 							*vimball-extract*
 		vim filename.vba
@@ -112,12 +117,16 @@ Copyright: (c) 2004-2008 by Charles E. Campbell, Jr.	*Vimball-copyright*
 	file holds the "Vimball Archiver by Charles E. Campbell, Jr., Ph.D."
 	line.
 
-		:VimballList				*:VimballList*
+LISTING FILES IN A VIMBALL					*:VimballList*
+
+		:VimballList
 
 	This command will tell Vimball to list the files in the archive, along
 	with their lengths in lines.
 
-		:UseVimball [path]			*:UseVimball*
+MANUALLY INVOKING VIMBALL EXTRACTION				*:UseVimball*
+
+		:UseVimball [path]
 
 	This command is contained within the vimball itself; it invokes the
 	vimball#Vimball() routine which is responsible for unpacking the
@@ -126,7 +135,9 @@ Copyright: (c) 2004-2008 by Charles E. Campbell, Jr.	*Vimball-copyright*
 	installation, thereby overriding the automatic choice of the first
 	existing directory on the |'runtimepath'|.
 
-		:RmVimball vimballfile [path]		*:RmVimball*
+REMOVING A VIMBALL						*:RmVimball*
+
+		:RmVimball vimballfile [path]
 
 	This command removes all files generated by the specified vimball
 	(but not any directories it may have made).  One may choose a path
@@ -136,10 +147,29 @@ Copyright: (c) 2004-2008 by Charles E. Campbell, Jr.	*Vimball-copyright*
 	containing a record of what files need to be removed for all vimballs
 	used thus far.
 
+PREVENTING LOADING
+
+	If for some reason you don't want to be able to extract plugins
+	using vimballs: you may prevent the loading of vimball.vim by
+	putting the following two variables in your <.vimrc>: >
+
+		let g:loaded_vimballPlugin= 1
+		let g:loaded_vimball      = 1
+<
 
 ==============================================================================
 4. Vimball History					*vimball-history* {{{1
 
+	30 : Dec 08, 2008 * fnameescape() inserted to protect error
+			    messaging using corrupted filenames from
+			    causing problems
+			  * RmVimball supports filenames that would
+			    otherwise be considered to have "magic"
+			    characters (ie. Abc[1].vba)
+	     Feb 18, 2009 * s:Escape(), g:vimball_shq, and g:netrw_shq
+			    removed (shellescape() used directly)
+	     Oct 05, 2009 * (Nikolai Weibull) suggested that MkVimball
+			    be allowed to use slashes in the filename.
 	26 : May 27, 2008 * g:vimball_mkdir usage installed.  Makes the
 	                    $HOME/.vim (or $HOME\vimfiles) directory if
 			    necessary.