Mercurial > vim
annotate runtime/doc/pi_zip.txt @ 18501:c9777bf23eb8
Added tag v8.1.2244 for changeset c0445cb7cfe0432628191cc5c7d21400bd2dab75
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Sat, 02 Nov 2019 23:30:04 +0100 |
| parents | 2f7e67dd088c |
| children | af69c9335223 |
| rev | line source |
|---|---|
| 13963 | 1 *pi_zip.txt* For Vim version 8.1. Last change: 2016 Sep 13 |
| 799 | 2 |
| 819 | 3 +====================+ |
| 4 | Zip File Interface | | |
| 5 +====================+ | |
| 567 | 6 |
| 4339 | 7 Author: Charles E. Campbell <NdrOchip@ScampbellPfamily.AbizM> |
| 567 | 8 (remove NOSPAM from Campbell's email first) |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
9 Copyright: Copyright (C) 2005-2015 Charles E Campbell *zip-copyright* |
| 3281 | 10 The VIM LICENSE (see |copyright|) applies to the files in this |
| 11 package, including zipPlugin.vim, zip.vim, and pi_zip.vim. except use | |
| 12 "zip.vim" instead of "VIM". Like anything else that's free, zip.vim | |
| 13 and its associated files are provided *as is* and comes with no | |
| 14 warranty of any kind, either expressed or implied. No guarantees of | |
| 15 merchantability. No guarantees of suitability for any purpose. By | |
| 16 using this plugin, you agree that in no event will the copyright | |
| 17 holder be liable for any damages resulting from the use of this | |
| 18 software. Use at your own risk! | |
| 567 | 19 |
| 20 ============================================================================== | |
| 2908 | 21 1. Contents *zip* *zip-contents* |
| 1201 | 22 1. Contents................................................|zip-contents| |
| 23 2. Usage...................................................|zip-usage| | |
| 24 3. Additional Extensions...................................|zip-extension| | |
| 25 4. History.................................................|zip-history| | |
| 567 | 26 |
| 27 ============================================================================== | |
| 2908 | 28 2. Usage *zip-usage* *zip-manual* |
| 567 | 29 |
| 30 When one edits a *.zip file, this plugin will handle displaying a | |
| 31 contents page. Select a file to edit by moving the cursor atop | |
| 32 the desired file, then hit the <return> key. After editing, one may | |
| 33 also write to the file. Currently, one may not make a new file in | |
| 34 zip archives via the plugin. | |
| 35 | |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
36 *zip-x* |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
37 x : may extract a listed file when the cursor is atop it |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
38 |
| 1201 | 39 OPTIONS |
| 1620 | 40 |
| 41 *g:zip_nomax* | |
| 42 | |
| 43 If this variable exists and is true, the file window will not be | |
| 44 automatically maximized when opened. | |
| 45 | |
| 46 *g:zip_shq* | |
| 1201 | 47 Different operating systems may use one or more shells to execute |
| 48 commands. Zip will try to guess the correct quoting mechanism to | |
| 49 allow spaces and whatnot in filenames; however, if it is incorrectly | |
| 50 guessing the quote to use for your setup, you may use > | |
| 51 g:zip_shq | |
| 1121 | 52 < which by default is a single quote under Unix (') and a double quote |
| 53 under Windows ("). If you'd rather have no quotes, simply set | |
| 54 g:zip_shq to the empty string (let g:zip_shq= "") in your <.vimrc>. | |
| 55 | |
| 1201 | 56 *g:zip_unzipcmd* |
| 57 Use this option to specify the program which does the duty of "unzip". | |
| 1620 | 58 It's used during browsing. By default: > |
| 1201 | 59 let g:zip_unzipcmd= "unzip" |
| 60 < | |
| 61 *g:zip_zipcmd* | |
| 62 Use this option to specify the program which does the duty of "zip". | |
| 1620 | 63 It's used during the writing (updating) of a file already in a zip |
| 1201 | 64 file; by default: > |
| 65 let g:zip_zipcmd= "zip" | |
| 66 < | |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
67 *g:zip_extractcmd* |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
68 This option specifies the program (and any options needed) used to |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
69 extract a file from a zip archive. By default, > |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
70 let g:zip_extractcmd= g:zip_unzipcmd |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
71 < |
| 2152 | 72 PREVENTING LOADING~ |
| 73 | |
| 74 If for some reason you do not wish to use vim to examine zipped files, | |
| 75 you may put the following two variables into your <.vimrc> to prevent | |
| 2581 | 76 the zip plugin from loading: > |
| 2152 | 77 |
| 78 let g:loaded_zipPlugin= 1 | |
| 79 let g:loaded_zip = 1 | |
| 80 < | |
| 1201 | 81 |
| 567 | 82 ============================================================================== |
| 1201 | 83 3. Additional Extensions *zip-extension* |
| 84 | |
| 3281 | 85 Apparently there are a number of archivers which generate zip files that |
| 1201 | 86 don't use the .zip extension (.jar, .xpi, etc). To handle such files, |
| 87 place a line in your <.vimrc> file: > | |
| 88 | |
| 89 au BufReadCmd *.jar,*.xpi call zip#Browse(expand("<amatch>")) | |
| 90 < | |
| 1668 | 91 One can simply extend this line to accommodate additional extensions that |
| 1620 | 92 should be treated as zip files. |
| 1201 | 93 |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
94 Alternatively, one may change *g:zipPlugin_ext* in one's .vimrc. |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
95 Currently (11/30/15) it holds: > |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
96 |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
97 let g:zipPlugin_ext= '*.zip,*.jar,*.xpi,*.ja,*.war,*.ear,*.celzip, |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
98 \ *.oxt,*.kmz,*.wsz,*.xap,*.docx,*.docm,*.dotx,*.dotm,*.potx,*.potm, |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
99 \ *.ppsx,*.ppsm,*.pptx,*.pptm,*.ppam,*.sldx,*.thmx,*.xlam,*.xlsx,*.xlsm, |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
100 \ *.xlsb,*.xltx,*.xltm,*.xlam,*.crtx,*.vdw,*.glox,*.gcsx,*.gqsx,*.epub' |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
101 |
| 1201 | 102 ============================================================================== |
| 2908 | 103 4. History *zip-history* {{{1 |
|
10211
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
104 v28 Oct 08, 2014 * changed the sanity checks for executables to reflect |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
105 the command actually to be attempted in zip#Read() |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
106 and zip#Write() |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
107 * added the extraction of a file capability |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
108 Nov 30, 2015 * added *.epub to the |g:zipPlugin_ext| list |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
109 Sep 13, 2016 * added *.apk to the |g:zipPlugin_ext| list and |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
110 sorted the suffices. |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
111 v27 Jul 02, 2013 * sanity check: zipfile must have "PK" as its first |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
112 two bytes. |
|
b7da8d4c594c
commit https://github.com/vim/vim/commit/d07969093a9b3051511c478d71c36de6fc33c0d6
Christian Brabandt <cb@256bit.org>
parents:
10198
diff
changeset
|
113 * modified to allow zipfile: entries in quickfix lists |
| 4339 | 114 v26 Nov 15, 2012 * (Jason Spiro) provided a lot of new extensions that |
| 115 are synonyms for .zip | |
| 3281 | 116 v25 Jun 27, 2011 * using keepj with unzip -Z |
| 117 (consistent with the -p variant) | |
| 4339 | 118 * (Ben Staniford) now uses |
| 119 has("win32unix") && executable("cygpath") | |
| 120 before converting to cygwin-style paths | |
| 2908 | 121 v24 Jun 21, 2010 * (Cédric Bosdonnat) unzip seems to need its filenames |
| 122 fnameescape'd as well as shellquote'd | |
| 123 * (Motoya Kurotsu) inserted keepj before 0d to protect | |
| 124 jump list | |
| 1620 | 125 v17 May 09, 2008 * arno caught a security bug |
| 126 v15 Sep 07, 2007 * &shq now used if not the empty string for g:zip_shq | |
| 1201 | 127 v14 May 07, 2007 * using b:zipfile instead of w:zipfile to avoid problem |
| 128 when editing alternate file to bring up a zipfile | |
| 1121 | 129 v10 May 02, 2006 * now using "redraw then echo" to show messages, instead |
| 130 of "echo and prompt user" | |
| 131 * g:zip_shq provided to allow for quoting control for the | |
| 132 command being passed via :r! ... commands. | |
| 826 | 133 v8 Apr 10, 2006 * Bram Moolenaar reported that he received an error message |
| 1121 | 134 due to "Pattern not found: ^.*\%0c"; this was caused by |
| 826 | 135 stridx finding a Name... at the beginning of the line; |
| 136 zip.vim tried 4,$s/^.*\%0c//, but that doesn't work. | |
| 137 Fixed. | |
| 797 | 138 v7 Mar 22, 2006 * escaped some characters that can cause filename handling |
| 1121 | 139 problems. |
| 622 | 140 v6 Dec 21, 2005 * writing to files not in directories caused problems - |
| 1121 | 141 fixed (pointed out by Christian Robinson) |
| 567 | 142 v5 Nov 22, 2005 * report option workaround installed |
| 143 v3 Oct 18, 2005 * <amatch> used instead of <afile> in autocmds | |
| 144 v2 Sep 16, 2005 * silenced some commands (avoiding hit-enter prompt) | |
| 1121 | 145 * began testing under Windows; works thus far |
| 567 | 146 * filetype detection fixed |
| 147 Nov 03, 2005 * handles writing zipfiles across a network using | |
| 1121 | 148 netrw#NetWrite() |
| 567 | 149 v1 Sep 15, 2005 * Initial release, had browsing, reading, and writing |
| 150 | |
| 151 ============================================================================== | |
| 14421 | 152 vim:tw=78:ts=8:noet:ft=help:fdm=marker |