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