codekingpro/portable-devtools

1*pi_zip.txt*	For Vim version 9.2.  Last change: 2026 Apr 052 3				+====================+4				| Zip File Interface |5				+====================+6 7Author:  Charles E. Campbell  <NcampObell@SdrPchip.AorgM-NOSPAM>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 this11	package, including zipPlugin.vim, zip.vim, and pi_zip.vim.  except use12	"zip.vim" instead of "VIM".  Like anything else that's free, zip.vim13	and its associated files are provided *as is* and comes with no14	warranty of any kind, either expressed or implied.  No guarantees of15	merchantability.  No guarantees of suitability for any purpose.  By16	using this plugin, you agree that in no event will the copyright17	holder be liable for any damages resulting from the use of this18	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 a31   contents page.  Select a file to edit by moving the cursor atop32   the desired file, then hit the <return> key.  After editing, one may33   also write to the file.  Currently, one may not make a new file in34   zip archives via the plugin.35 36   The zip plugin tries to detect some common path traversal attack37   patterns, but it may not catch all possible cases.  Please be very38   careful when using this plugin with untrusted input.39 40   COMMANDS~41								*zip-x*42   x : extract a listed file when the cursor is atop it43 44   OPTIONS~45 46							*g:zip_nomax*47 48   If this variable exists and is true, the file window will not be49   automatically maximized when opened.50 51							*g:zip_shq*52   Different operating systems may use one or more shells to execute53   commands.  Zip will try to guess the correct quoting mechanism to54   allow spaces and whatnot in filenames; however, if it is incorrectly55   guessing the quote to use for your setup, you may use >56	g:zip_shq57<   which by default is a single quote under Unix (') and a double quote58   under Windows (").  If you'd rather have no quotes, simply set59   g:zip_shq to the empty string (let g:zip_shq= "") in your <.vimrc>.60 61							*g:zip_unzipcmd*62   Use this option to specify the program which does the duty of "unzip".63   It's used during browsing. By default: >64	let g:zip_unzipcmd= "unzip"65<66							*g:zip_zipcmd*67   Use this option to specify the program which does the duty of "zip".68   It's used during the writing (updating) of a file already in a zip69   file; by default: >70	let g:zip_zipcmd= "zip"71<72							*g:zip_extractcmd*73   This option specifies the program (and any options needed) used to74   extract a file from a zip archive.  By default, >75	let g:zip_extractcmd= g:zip_unzipcmd76<77							*g:zip_exec*78   For security reasons, one may prevent that Vim runs executables79   automatically when opening a buffer.  This option (default: "1")80   can be used to prevent executing the "unzip" command when set to81   "0": >82	let g:zip_exec=083<84   FALLBACK TO POWERSHELL CORE~85 86   This plugin will first attempt to use the (more capable) GNU zip/unzip87   commands.  If these commands are not available or fail, and the user is88   using PowerShell Core (i.e., the 'shell' option matches "pwsh"), the89   plugin will fall back to a PowerShell Core cmdlet.  The PowerShell Core90   cmdlets are limited: they cannot write or extract files within91   subdirectories of a zip archive.  The advantage, however, is that no92   separate unzip binary needs to be installed.93 94   PREVENTING LOADING~95 96   If for some reason you do not wish to use vim to examine zipped files,97   you may put the following two variables into your <.vimrc> to prevent98   the zip plugin from loading: >99 100	let g:loaded_zipPlugin= 1101	let g:loaded_zip      = 1102<103 104==============================================================================1053. Additional Extensions					*zip-extension*106 107   Apparently there are a number of archivers which generate zip files that108   don't use the .zip extension (.jar, .xpi, etc).  To handle such files,109   place a line in your <.vimrc> file: >110 111	au BufReadCmd *.jar,*.xpi call zip#Browse(expand("<amatch>"))112<113   One can simply extend this line to accommodate additional extensions that114   should be treated as zip files.115 116   Alternatively, one may change *g:zipPlugin_ext* in one's .vimrc.117   Currently (as of October 2025) it holds: >118 119        let g:zipPlugin_ext='*.aar,*.apk,*.celzip,*.crtx,*.docm,*.docx,120       \ *.dotm,*.dotx,*.ear,*.epub,*.gcsx,*.glox,*.gqsx,*.ja,*.jar,*.kmz,121       \ *.odb,*.odc,*.odf,*.odg,*.odi,*.odm,*.odp,*.ods,*.odt,*.otc,*.otf,122       \ *.otg,*.oth,*.oti,*.otp,*.ots,*.ott,*.oxt,*.pkpass,*.potm,*.potx,123       \ *.ppam,*.ppsm,*.ppsx,*.pptm,*.pptx,*.sldx,*.thmx,*.vdw,*.war,*.whl,124       \ *.wsz, *.xap,*.xlam,*.xlsb,*.xlsm,*.xlsx,*.xltm,*.xltx,*.xpi,*.zip'125 126==============================================================================1274. History							*zip-history* {{{1128   unreleased:129       Sep 19, 2025 * support PowerShell Core130       Jul 12, 2025 * drop ../ on write to prevent path traversal attacks131       Mar 11, 2025 * handle filenames with leading '-' correctly132       Aug 21, 2024 * simplify condition to detect MS-Windows133       Aug 18, 2024 * correctly handle special globbing chars134       Aug 05, 2024 * clean-up and make it work with shellslash on Windows135       Aug 05, 2024 * workaround for the FreeBSD's unzip136       Aug 04, 2024 * escape '[' in name of file to be extracted137       Jul 30, 2024 * fix opening remote zipfile138       Jul 24, 2024 * use delete() function139       Jul 23, 2024 * fix 'x' command140       Jun 16, 2024 * handle whitespace on Windows properly (#14998)141   v33 Dec 07, 2021 * *.xlam mentioned twice in zipPlugin142   v32 Oct 22, 2021 * to avoid an issue with a vim 8.2 patch, zipfile: has143		      been changed to zipfile:// . This often shows up144		      as zipfile:/// with zipped files that are root-based.145   v29 Apr 02, 2017 * (Klartext) reported that an encrypted zip file could146		      opened but the swapfile held unencrypted contents.147		      The solution is to edit the contents of a zip file148		      using the |:noswapfile| modifier.149   v28 Oct 08, 2014 * changed the sanity checks for executables to reflect150		      the command actually to be attempted in zip#Read()151		      and zip#Write()152		    * added the extraction of a file capability153       Nov 30, 2015 * added *.epub to the |g:zipPlugin_ext| list154       Sep 13, 2016 * added *.apk to the |g:zipPlugin_ext| list and155		      sorted the suffices.156   v27 Jul 02, 2013 * sanity check: zipfile must have "PK" as its first157		      two bytes.158		    * modified to allow zipfile: entries in quickfix lists159   v26 Nov 15, 2012 * (Jason Spiro) provided a lot of new extensions that160		      are synonyms for .zip161   v25 Jun 27, 2011 * using keepj with unzip -Z162		      (consistent with the -p variant)163		    * (Ben Staniford) now uses164			has("win32unix") && executable("cygpath")165		      before converting to cygwin-style paths166   v24 Jun 21, 2010 * (Cédric Bosdonnat) unzip seems to need its filenames167		      fnameescape'd as well as shellquote'd168		    * (Motoya Kurotsu) inserted keepj before 0d to protect169		      jump list170   v17 May 09, 2008 * arno caught a security bug171   v15 Sep 07, 2007 * &shq now used if not the empty string for g:zip_shq172   v14 May 07, 2007 * using b:zipfile instead of w:zipfile to avoid problem173                      when editing alternate file to bring up a zipfile174   v10 May 02, 2006 * now using "redraw then echo" to show messages, instead175                      of "echo and prompt user"176		    * g:zip_shq provided to allow for quoting control for the177		      command being passed via :r! ... commands.178   v8 Apr 10, 2006 * Bram Moolenaar reported that he received an error message179                     due to "Pattern not found: ^.*\%0c"; this was caused by180		     stridx finding a Name... at the beginning of the line;181		     zip.vim tried 4,$s/^.*\%0c//, but that doesn't work.182		     Fixed.183   v7 Mar 22, 2006 * escaped some characters that can cause filename handling184                     problems.185   v6 Dec 21, 2005 * writing to files not in directories caused problems -186                     fixed (pointed out by Christian Robinson)187   v5 Nov 22, 2005 * report option workaround installed188   v3 Oct 18, 2005 * <amatch> used instead of <afile> in autocmds189   v2 Sep 16, 2005 * silenced some commands (avoiding hit-enter prompt)190                   * began testing under Windows; works thus far191		   * filetype detection fixed192      Nov 03, 2005 * handles writing zipfiles across a network using193                     netrw#NetWrite()194   v1 Sep 15, 2005 * Initial release, had browsing, reading, and writing195 196==============================================================================197vim:tw=78:ts=8:ft=help:noet:norl:fdm=marker198