annotate runtime/doc/pi_zip.txt @ 0:76efa0be13f1

Initial revision
author atsuki
date Sat, 10 Nov 2007 15:07:22 +0900
parents
children e170173ecb68
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
1 *pi_zip.txt* For Vim version 7.1. Last change: 2007 May 11
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
2
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
3 +====================+
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
4 | Zip File Interface |
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
5 +====================+
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
6
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
7 Author: Charles E. Campbell, Jr. <NdrOchip@ScampbellPfamily.AbizM>
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
8 (remove NOSPAM from Campbell's email first)
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
9 Copyright: Copyright (C) 2005,2006 Charles E Campbell, Jr *zip-copyright*
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
10 Permission is hereby granted to use and distribute this code,
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
11 with or without modifications, provided that this copyright
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
12 notice is copied with it. Like anything else that's free,
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
13 zip.vim, zipPlugin.vim, and pi_zip.txt are provided *as is*
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
14 and it comes with no warranty of any kind, either expressed or
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
15 implied. By using this plugin, you agree that in no event will
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
16 the copyright holder be liable for any damages resulting from
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
17 the use of this software.
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
18
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
19 ==============================================================================
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
20 1. Contents *zip* *zip-contents*
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
21 1. Contents................................................|zip-contents|
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
22 2. Usage...................................................|zip-usage|
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
23 3. Additional Extensions...................................|zip-extension|
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
24 4. History.................................................|zip-history|
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
25
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
26 ==============================================================================
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
27 2. Usage *zip-usage* *zip-manual*
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
28
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
29 When one edits a *.zip file, this plugin will handle displaying a
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
30 contents page. Select a file to edit by moving the cursor atop
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
31 the desired file, then hit the <return> key. After editing, one may
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
32 also write to the file. Currently, one may not make a new file in
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
33 zip archives via the plugin.
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
34
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
35 OPTIONS
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
36 *zip_shq*
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
37 Different operating systems may use one or more shells to execute
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
38 commands. Zip will try to guess the correct quoting mechanism to
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
39 allow spaces and whatnot in filenames; however, if it is incorrectly
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
40 guessing the quote to use for your setup, you may use >
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
41 g:zip_shq
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
42 < which by default is a single quote under Unix (') and a double quote
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
43 under Windows ("). If you'd rather have no quotes, simply set
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
44 g:zip_shq to the empty string (let g:zip_shq= "") in your <.vimrc>.
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
45
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
46 *g:zip_unzipcmd*
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
47 Use this option to specify the program which does the duty of "unzip".
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
48 Its used during browsing. By default: >
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
49 let g:zip_unzipcmd= "unzip"
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
50 <
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
51 *g:zip_zipcmd*
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
52 Use this option to specify the program which does the duty of "zip".
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
53 Its used during the writing (updating) of a file already in a zip
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
54 file; by default: >
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
55 let g:zip_zipcmd= "zip"
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
56 <
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
57
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
58 ==============================================================================
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
59 3. Additional Extensions *zip-extension*
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
60
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
61 Apparently there are a number of archivers who generate zip files that
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
62 don't use the .zip extension (.jar, .xpi, etc). To handle such files,
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
63 place a line in your <.vimrc> file: >
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
64
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
65 au BufReadCmd *.jar,*.xpi call zip#Browse(expand("<amatch>"))
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
66 <
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
67 One can simply extend this line to accommodate additional extensions that
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
68 are actually zip files.
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
69
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
70 ==============================================================================
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
71 4. History *zip-history* {{{1
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
72 v14 May 07, 2007 * using b:zipfile instead of w:zipfile to avoid problem
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
73 when editing alternate file to bring up a zipfile
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
74 v10 May 02, 2006 * now using "redraw then echo" to show messages, instead
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
75 of "echo and prompt user"
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
76 * g:zip_shq provided to allow for quoting control for the
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
77 command being passed via :r! ... commands.
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
78 v8 Apr 10, 2006 * Bram Moolenaar reported that he received an error message
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
79 due to "Pattern not found: ^.*\%0c"; this was caused by
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
80 stridx finding a Name... at the beginning of the line;
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
81 zip.vim tried 4,$s/^.*\%0c//, but that doesn't work.
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
82 Fixed.
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
83 v7 Mar 22, 2006 * escaped some characters that can cause filename handling
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
84 problems.
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
85 v6 Dec 21, 2005 * writing to files not in directories caused problems -
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
86 fixed (pointed out by Christian Robinson)
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
87 v5 Nov 22, 2005 * report option workaround installed
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
88 v3 Oct 18, 2005 * <amatch> used instead of <afile> in autocmds
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
89 v2 Sep 16, 2005 * silenced some commands (avoiding hit-enter prompt)
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
90 * began testing under Windows; works thus far
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
91 * filetype detection fixed
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
92 Nov 03, 2005 * handles writing zipfiles across a network using
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
93 netrw#NetWrite()
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
94 v1 Sep 15, 2005 * Initial release, had browsing, reading, and writing
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
95
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
96 ==============================================================================
76efa0be13f1 Initial revision
atsuki
parents:
diff changeset
97 vim:tw=78:ts=8:ft=help:fdm=marker