1*pi_zip.txt* For Vim version 8.2. Last change: 2021 Nov 08 2 3 +====================+ 4 | Zip File Interface | 5 +====================+ 6 7Author: Charles E. Campbell <[email protected]> 8 (remove NOSPAM from Campbell's email first) 9Copyright: Copyright (C) 2005-2015 Charles E Campbell *zip-copyright* 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! 19 20============================================================================== 211. Contents *zip* *zip-contents* 22 1. Contents................................................|zip-contents| 23 2. Usage...................................................|zip-usage| 24 3. Additional Extensions...................................|zip-extension| 25 4. History.................................................|zip-history| 26 27============================================================================== 282. Usage *zip-usage* *zip-manual* 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 36 COMMANDS~ 37 *zip-x* 38 x : extract a listed file when the cursor is atop it 39 40 OPTIONS~ 41 42 *g:zip_nomax* 43 44 If this variable exists and is true, the file window will not be 45 automatically maximized when opened. 46 47 *g:zip_shq* 48 Different operating systems may use one or more shells to execute 49 commands. Zip will try to guess the correct quoting mechanism to 50 allow spaces and whatnot in filenames; however, if it is incorrectly 51 guessing the quote to use for your setup, you may use > 52 g:zip_shq 53< which by default is a single quote under Unix (') and a double quote 54 under Windows ("). If you'd rather have no quotes, simply set 55 g:zip_shq to the empty string (let g:zip_shq= "") in your <.vimrc>. 56 57 *g:zip_unzipcmd* 58 Use this option to specify the program which does the duty of "unzip". 59 It's used during browsing. By default: > 60 let g:zip_unzipcmd= "unzip" 61< 62 *g:zip_zipcmd* 63 Use this option to specify the program which does the duty of "zip". 64 It's used during the writing (updating) of a file already in a zip 65 file; by default: > 66 let g:zip_zipcmd= "zip" 67< 68 *g:zip_extractcmd* 69 This option specifies the program (and any options needed) used to 70 extract a file from a zip archive. By default, > 71 let g:zip_extractcmd= g:zip_unzipcmd 72< 73 PREVENTING LOADING~ 74 75 If for some reason you do not wish to use vim to examine zipped files, 76 you may put the following two variables into your <.vimrc> to prevent 77 the zip plugin from loading: > 78 79 let g:loaded_zipPlugin= 1 80 let g:loaded_zip = 1 81< 82 83============================================================================== 843. Additional Extensions *zip-extension* 85 86 Apparently there are a number of archivers which generate zip files that 87 don't use the .zip extension (.jar, .xpi, etc). To handle such files, 88 place a line in your <.vimrc> file: > 89 90 au BufReadCmd *.jar,*.xpi call zip#Browse(expand("<amatch>")) 91< 92 One can simply extend this line to accommodate additional extensions that 93 should be treated as zip files. 94 95 Alternatively, one may change *g:zipPlugin_ext* in one's .vimrc. 96 Currently (11/30/15) it holds: > 97 98 let g:zipPlugin_ext= '*.zip,*.jar,*.xpi,*.ja,*.war,*.ear,*.celzip, 99 \ *.oxt,*.kmz,*.wsz,*.xap,*.docx,*.docm,*.dotx,*.dotm,*.potx,*.potm, 100 \ *.ppsx,*.ppsm,*.pptx,*.pptm,*.ppam,*.sldx,*.thmx,*.xlam,*.xlsx,*.xlsm, 101 \ *.xlsb,*.xltx,*.xltm,*.xlam,*.crtx,*.vdw,*.glox,*.gcsx,*.gqsx,*.epub' 102 103============================================================================== 1044. History *zip-history* {{{1 105 v32 Oct 22, 2021 * to avoid an issue with a vim 8.2 patch, zipfile: has 106 been changed to zipfile:// . This often shows up 107 as zipfile:/// with zipped files that are root-based. 108 v29 Apr 02, 2017 * (Klartext) reported that an encrypted zip file could 109 opened but the swapfile held unencrypted contents. 110 The solution is to edit the contents of a zip file 111 using the |:noswapfile| modifier. 112 v28 Oct 08, 2014 * changed the sanity checks for executables to reflect 113 the command actually to be attempted in zip#Read() 114 and zip#Write() 115 * added the extraction of a file capability 116 Nov 30, 2015 * added *.epub to the |g:zipPlugin_ext| list 117 Sep 13, 2016 * added *.apk to the |g:zipPlugin_ext| list and 118 sorted the suffices. 119 v27 Jul 02, 2013 * sanity check: zipfile must have "PK" as its first 120 two bytes. 121 * modified to allow zipfile: entries in quickfix lists 122 v26 Nov 15, 2012 * (Jason Spiro) provided a lot of new extensions that 123 are synonyms for .zip 124 v25 Jun 27, 2011 * using keepj with unzip -Z 125 (consistent with the -p variant) 126 * (Ben Staniford) now uses 127 has("win32unix") && executable("cygpath") 128 before converting to cygwin-style paths 129 v24 Jun 21, 2010 * (Cédric Bosdonnat) unzip seems to need its filenames 130 fnameescape'd as well as shellquote'd 131 * (Motoya Kurotsu) inserted keepj before 0d to protect 132 jump list 133 v17 May 09, 2008 * arno caught a security bug 134 v15 Sep 07, 2007 * &shq now used if not the empty string for g:zip_shq 135 v14 May 07, 2007 * using b:zipfile instead of w:zipfile to avoid problem 136 when editing alternate file to bring up a zipfile 137 v10 May 02, 2006 * now using "redraw then echo" to show messages, instead 138 of "echo and prompt user" 139 * g:zip_shq provided to allow for quoting control for the 140 command being passed via :r! ... commands. 141 v8 Apr 10, 2006 * Bram Moolenaar reported that he received an error message 142 due to "Pattern not found: ^.*\%0c"; this was caused by 143 stridx finding a Name... at the beginning of the line; 144 zip.vim tried 4,$s/^.*\%0c//, but that doesn't work. 145 Fixed. 146 v7 Mar 22, 2006 * escaped some characters that can cause filename handling 147 problems. 148 v6 Dec 21, 2005 * writing to files not in directories caused problems - 149 fixed (pointed out by Christian Robinson) 150 v5 Nov 22, 2005 * report option workaround installed 151 v3 Oct 18, 2005 * <amatch> used instead of <afile> in autocmds 152 v2 Sep 16, 2005 * silenced some commands (avoiding hit-enter prompt) 153 * began testing under Windows; works thus far 154 * filetype detection fixed 155 Nov 03, 2005 * handles writing zipfiles across a network using 156 netrw#NetWrite() 157 v1 Sep 15, 2005 * Initial release, had browsing, reading, and writing 158 159============================================================================== 160vim:tw=78:ts=8:ft=help:noet:norl:fdm=marker 161