|
856
|
1 *pi_vimball.txt* For Vim version 7.0g. Last change: 2006 Apr 30
|
|
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 ==============================================================================
|
|
|
16 1. Contents *vimball* *vimball-contents*
|
|
|
17
|
|
|
18 1. Contents......................................: |vimball-contents|
|
|
|
19 2. Vimball Manual................................: |vimball-manual|
|
|
|
20 3. Vimball History...............................: |vimball-history|
|
|
|
21
|
|
|
22
|
|
|
23 ==============================================================================
|
|
|
24 2. Vimball Manual *vimball-manual*
|
|
|
25
|
|
|
26 *:MkVimball*
|
|
|
27 :[range]MkVimball[!] filename
|
|
|
28
|
|
|
29 This command takes lines holding a path to files to be included in
|
|
|
30 your vimball; as an example: >
|
|
|
31 plugin/something.vim
|
|
|
32 doc/something.txt
|
|
|
33 < using MkVimball on this range will create a file called "filename.vba"
|
|
|
34 which can be used by Vimball.vim to re-create these files. If the
|
|
|
35 "filename.vba" file already exists, then MkVimball will issue a
|
|
|
36 warning and not create the file. Note that these paths are relative
|
|
|
37 to your .vim (vimfiles) directory, and the files should be in that
|
|
|
38 directory. The vimball plugin uses the first |'runtimepath'|directory
|
|
|
39 that exists as a prefix; don't use absolute paths.
|
|
|
40
|
|
|
41 If you use the exclamation point (!), then MkVimball will create the
|
|
|
42 "filename.vba" file, overwriting it if it already exists. This
|
|
|
43 behavior resembles that for |:w|.
|
|
|
44
|
|
|
45 *vimball-extract*
|
|
|
46 vim filename.vba
|
|
|
47
|
|
|
48 Simply editing a Vimball will cause Vimball.vim to tell the user to
|
|
|
49 source the file to extract its contents.
|
|
|
50
|
|
|
51 Extraction will only proceed if the first line of a putative vimball
|
|
|
52 file holds the "Vimball Archiver by Charles E. Campbell, Jr., Ph.D."
|
|
|
53 line.
|
|
|
54
|
|
|
55 :VimballList *vimball-vimballlist*
|
|
856
|
56
|
|
845
|
57 This command will tell Vimball to list the files in the archive, along
|
|
|
58 with their lengths in lines.
|
|
|
59
|
|
|
60
|
|
|
61 ==============================================================================
|
|
|
62 3. Vimball History *vimball-history* {{{1
|
|
|
63
|
|
|
64 11 : Apr 27, 2006 * VimballList would create missing subdirectories that
|
|
856
|
65 the vimball specified were needed. Fixed.
|
|
845
|
66 10 : Apr 27, 2006 * moved all setting saving/restoration to a pair of
|
|
856
|
67 functions. Included some more settings in them
|
|
845
|
68 which frequently cause trouble.
|
|
|
69 9 : Apr 26, 2006 * various changes to support Windows prediliction
|
|
856
|
70 for backslashes and spaces in file and directory
|
|
845
|
71 names.
|
|
|
72 7 : Apr 25, 2006 * bypasses foldenable
|
|
856
|
73 * uses more exe and less norm! (:yank :put etc)
|
|
845
|
74 * does better at insuring a "Press ENTER" prompt
|
|
|
75 appears to keep its messages visible
|
|
|
76 4 : Mar 31, 2006 * BufReadPost seems to fire twice; BufReadEnter
|
|
856
|
77 only fires once, so the "Source this file..."
|
|
845
|
78 message is now issued only once.
|
|
|
79 3 : Mar 20, 2006 * removed query, now requires sourcing to be
|
|
856
|
80 extracted (:so %). Message to that effect
|
|
845
|
81 included.
|
|
|
82 * :VimballList now shows files that would be
|
|
|
83 extracted.
|
|
|
84 2 : Mar 20, 2006 * query, :UseVimball included
|
|
|
85 1 : Mar 20, 2006 * initial release
|
|
|
86
|
|
|
87
|
|
|
88 ==============================================================================
|
|
|
89 vim:tw=78:ts=8:ft=help:fdm=marker
|
