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