annotate runtime/doc/vimball.txt @ 800:d8f905020502 v7.0b

updated for version 7.0b
author vimboss
date Fri, 24 Mar 2006 22:46:53 +0000
parents 98a88a884610
children 9f345c48220b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
800
d8f905020502 updated for version 7.0b
vimboss
parents: 791
diff changeset
1 *vimball.txt* For Vim version 7.0b. Last change: 2006 Mar 24
d8f905020502 updated for version 7.0b
vimboss
parents: 791
diff changeset
2
d8f905020502 updated for version 7.0b
vimboss
parents: 791
diff changeset
3 Vimball Archiver
d8f905020502 updated for version 7.0b
vimboss
parents: 791
diff changeset
4
791
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
5 Author: Charles E. Campbell, Jr. <NdrOchip@ScampbellPfamily.AbizM>
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
6 (remove NOSPAM from Campbell's email first)
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
7 Copyright: (c) 2004-2006 by Charles E. Campbell, Jr. *Vimball-copyright*
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
8 The VIM LICENSE applies to Vimball.vim, and Vimball.txt
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
9 (see |copyright|) except use "Vimball" instead of "Vim".
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
10 No warranty, express or implied.
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
11 Use At-Your-Own-Risk!
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
12
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
13 ==============================================================================
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
14 1. Contents *vimball* *vimball-contents*
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
15
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
16 1. Contents......................................: |vimball-contents|
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
17 2. Vimball Manual................................: |vimball-manual|
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
18 3. Vimball History...............................: |vimball-history|
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
19
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
20
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
21 ==============================================================================
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
22 2. Vimball Manual *vimball-manual*
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
23
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
24 *:MkVimball*
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
25 :[range]MkVimball[!] filename
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
26
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
27 This command takes lines holding a path to files to be included in
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
28 your vimball; as an example: >
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
29 plugin/something.vim
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
30 doc/something.txt
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
31 < using MkVimball on this range will create a file called
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
32 "filename.vba" which can be used by Vimball.vim to re-create these
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
33 files. If the "filename.vba" file already exists, then MkVimball
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
34 will issue a warning and not create the file.
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
35
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
36 However, if you use the exclamation point (!), then MkVimball will
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
37 create the "filename.vba" file, overwriting it if it already exists.
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
38 This behavior resembles that for |:w|.
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
39
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
40 *vimball-extract*
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
41 vim filename.vba
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
42
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
43 Simply editing a Vimball will cause Vimball.vim to tell the user to
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
44 source the file to extract its contents.
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
45
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
46 Extraction will only proceed if the first line of a putative vimball
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
47 file holds the "Vimball Archiver by Charles E. Campbell, Jr., Ph.D."
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
48 line.
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
49
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
50 :VimballList *vimball-vimballlist*
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
51
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
52 This command will tell Vimball to list the files in the archive, along
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
53 with their lengths in lines.
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
54
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
55
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
56 ==============================================================================
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
57 3. Vimball History *vimball-history*
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
58
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
59 3 : Mar 20, 2006 * removed query, now requires sourcing to be
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
60 extracted (:so %). Message to that effect
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
61 included.
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
62 * :VimballList now shows files that would be
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
63 extracted.
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
64 2 : Mar 20, 2006 * query, :UseVimball included
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
65 1 : Mar 20, 2006 * initial release
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
66
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
67
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
68 ==============================================================================
98a88a884610 updated for version 7.0230
vimboss
parents:
diff changeset
69 vim:tw=78:ts=8:ft=help:fdm=marker