runtime/doc/pi_vimball.txt

   1 *pi_vimball.txt*        For Vim version 7.1.  Last change: 2008 Apr 01
   2
   3                                ----------------
   4                                Vimball Archiver
   5                                ----------------
   6
   7 Author:  Charles E. Campbell, Jr.  <NdrOchip@ScampbellPfamily.AbizM>
   8           (remove NOSPAM from Campbell's email first)
   9 Copyright: (c) 2004-2007 by Charles E. Campbell, Jr.    *Vimball-copyright*
  10            The VIM LICENSE applies to Vimball.vim, and Vimball.txt
  11            (see |copyright|) except use "Vimball" instead of "Vim".
  12            No warranty, express or implied.
  13            Use At-Your-Own-Risk!
  14
  15 ==============================================================================
  16 1. Contents                             *vba* *vimball* *vimball-contents*
  17
  18         1. Contents......................................: |vimball-contents|
  19         2. Vimball Manual................................: |vimball-manual|
  20            MkVimball.....................................: |:MkVimball|
  21            UseVimball....................................: |:UseVimball|
  22            RmVimball.....................................: |:RmVimball|
  23         3. Vimball History...............................: |vimball-history|
  24
  25
  26 ==============================================================================
  27 2. Vimball Manual                                       *vimball-manual*
  28
  29                                                         *:MkVimball*
  30                 :[range]MkVimball[!] filename [path]
  31
  32         The range is composed of lines holding paths to files to be included
  33         in your new vimball, omitting the portion of the paths that is
  34         normally specified by the runtimepath (|'rtp'|).  As an example: >
  35                 plugin/something.vim
  36                 doc/something.txt
  37 <       using >
  38                 :[range]MkVimball filename
  39 <
  40         on this range of lines will create a file called "filename.vba" which
  41         can be used by Vimball.vim to re-create these files.  If the
  42         "filename.vba" file already exists, then MkVimball will issue a
  43         warning and not create the file.  Note that these paths are relative
  44         to your .vim (vimfiles) directory, and the files should be in that
  45         directory.  The vimball plugin normally uses the first |'runtimepath'|
  46         directory that exists as a prefix; don't use absolute paths, unless
  47         the user has specified such a path.
  48
  49         If you use the exclamation point (!), then MkVimball will create the
  50         "filename.vba" file, overwriting it if it already exists.  This
  51         behavior resembles that for |:w|.
  52                                                         *g:vimball_home*
  53         You may override the use of the |'runtimepath'| by specifying a
  54         variable, g:vimball_home.
  55
  56         Path Preprocessing                              *g:vimball_path_escape*
  57
  58         Paths used in vimball are preprocessed by s:Path(); in addition,
  59         certain characters are escaped (by prepending a backslash).  The
  60         characters are in g:vimball_path_escape, and may be overridden by
  61         the user in his/her .vimrc initialization script.
  62
  63                                                         *vimball-extract*
  64                 vim filename.vba
  65
  66         Simply editing a Vimball will cause Vimball.vim to tell the user to
  67         source the file to extract its contents.
  68
  69         Extraction will only proceed if the first line of a putative vimball
  70         file holds the "Vimball Archiver by Charles E. Campbell, Jr., Ph.D."
  71         line.
  72
  73                 :VimballList                            *:VimballList*
  74
  75         This command will tell Vimball to list the files in the archive, along
  76         with their lengths in lines.
  77
  78                 :UseVimball [path]                      *:UseVimball*
  79
  80         This command is contained within the vimball itself; it invokes the
  81         vimball#Vimball() routine which is responsible for unpacking the
  82         vimball.  One may choose to execute it by hand instead of sourcing
  83         the vimball; one may also choose to specify a path for the
  84         installation, thereby overriding the automatic choice of the first
  85         existing directory on the |'runtimepath'|.
  86
  87                 :RmVimball vimballfile [path]           *:RmVimball*
  88
  89         This command removes all files generated by the specified vimball
  90         (but not any directories it may have made).  One may choose a path
  91         for de-installation, too (see |'runtimepath'|); otherwise, the
  92         default is the first existing directory on the |'runtimepath'|.
  93         To implement this, a file (.VimballRecord) is made in that directory
  94         containing a record of what files need to be removed for all vimballs
  95         used thus far.
  96
  97
  98 ==============================================================================
  99 3. Vimball History                                      *vimball-history* {{{1
 100
 101         25 : Mar 24, 2008 * changed vimball#Vimball() to recognize doc/*.??x
 102                             files as help files, too.
 103         24 : Nov 15, 2007 * |g:vimball_path_escape| used by s:Path() to
 104                             prevent certain characters from causing trouble
 105         22 : Mar 21, 2007 * uses setlocal instead of set during BufEnter
 106         21 : Nov 27, 2006 * (tnx to Bill McCarthy) vimball had a header
 107                             handling problem and it now changes \s to /s
 108         20 : Nov 20, 2006 * substitute() calls have all had the 'e' flag
 109                             removed.
 110         18 : Aug 01, 2006 * vimballs now use folding to easily display their
 111                             contents.
 112                           * if a user has AsNeeded/somefile, then vimball
 113                             will extract plugin/somefile to the AsNeeded/
 114                             directory
 115         17 : Jun 28, 2006 * changes all \s to /s internally for Windows
 116         16 : Jun 15, 2006 * A. Mechylynck's idea to allow users to specify
 117                             installation root paths implemented for
 118                             UseVimball, MkVimball, and RmVimball.
 119                           * RmVimball implemented
 120         15 : Jun 13, 2006 * bugfix
 121         14 : May 26, 2006 * bugfixes
 122         13 : May 01, 2006 * exists("&acd") used to determine if the acd
 123                             option exists
 124         12 : May 01, 2006 * bugfix - the |'acd'| option is not always defined
 125         11 : Apr 27, 2006 * VimballList would create missing subdirectories that
 126                             the vimball specified were needed.  Fixed.
 127         10 : Apr 27, 2006 * moved all setting saving/restoration to a pair of
 128                             functions.  Included some more settings in them
 129                             which frequently cause trouble.
 130         9  : Apr 26, 2006 * various changes to support Windows' predilection
 131                             for backslashes and spaces in file and directory
 132                             names.
 133         7  : Apr 25, 2006 * bypasses foldenable
 134                           * uses more exe and less norm! (:yank :put etc)
 135                           * does better at insuring a "Press ENTER" prompt
 136                             appears to keep its messages visible
 137         4  : Mar 31, 2006 * BufReadPost seems to fire twice; BufReadEnter
 138                             only fires once, so the "Source this file..."
 139                             message is now issued only once.
 140         3  : Mar 20, 2006 * removed query, now requires sourcing to be
 141                             extracted (:so %).  Message to that effect
 142                             included.
 143                           * :VimballList  now shows files that would be
 144                             extracted.
 145         2  : Mar 20, 2006 * query, :UseVimball included
 146         1  : Mar 20, 2006 * initial release
 147
 148
 149 ==============================================================================
 150 vim:tw=78:ts=8:ft=help:fdm=marker