Zip File Interface Plugin for Vim

*pi_zip.txt* Nvim +====================+ | Zip File Interface | +====================+ Author: Charles E. Campbell <NcampObell@SdrPchip.AorgM-NOSPAM> (remove NOSPAM from Campbell's email first) Copyright: Copyright (C) 2005-2015 Charles E Campbell *zip-copyright* The VIM LICENSE (see |copyright|) applies to the files in this package, including zipPlugin.vim, zip.vim, and pi_zip.vim. except use "zip.vim" instead of "VIM". Like anything else that's free, zip.vim and its associated files are provided as is and comes with no warranty of any kind, either expressed or implied. No guarantees of merchantability. No guarantees of suitability for any purpose. By using this plugin, you agree that in no event will the copyright holder be liable for any damages resulting from the use of this software. Use at your own risk! ============================================================================== 1. Contents *zip* *zip-contents* 1. Contents................................................|zip-contents| 2. Usage...................................................|zip-usage| 3. Additional Extensions...................................|zip-extension| 4. History.................................................|zip-history| ============================================================================== 2. Usage *zip-usage* *zip-manual* When one edits a `*.zip` file, this plugin will handle displaying a contents page. Select a file to edit by moving the cursor atop the desired file, then hit the <return> key. After editing, one may also write to the file. Currently, one may not make a new file in zip archives via the plugin. COMMANDS~ *zip-x* x : extract a listed file when the cursor is atop it OPTIONS~ *g:zip_nomax* If this variable exists and is true, the file window will not be automatically maximized when opened. *g:zip_shq* Different operating systems may use one or more shells to execute commands. Zip will try to guess the correct quoting mechanism to allow spaces and whatnot in filenames; however, if it is incorrectly guessing the quote to use for your setup, you may use > g:zip_shq < which by default is a single quote under Unix (') and a double quote under Windows ("). If you'd rather have no quotes, simply set g:zip_shq to the empty string (let g:zip_shq= "") in your <.vimrc>. *g:zip_unzipcmd* Use this option to specify the program which does the duty of "unzip". It's used during browsing. By default: > let g:zip_unzipcmd= "unzip" < *g:zip_zipcmd* Use this option to specify the program which does the duty of "zip". It's used during the writing (updating) of a file already in a zip file; by default: > let g:zip_zipcmd= "zip" < *g:zip_extractcmd* This option specifies the program (and any options needed) used to extract a file from a zip archive. By default, > let g:zip_extractcmd= g:zip_unzipcmd < *g:zip_exec* For security reasons, one may prevent that Vim runs executables automatically when opening a buffer. This option (default: "1") can be used to prevent executing the "unzip" command when set to "0": > let g:zip_exec=0 < PREVENTING LOADING~ If for some reason you do not wish to use vim to examine zipped files, you may put the following two variables into your <.vimrc> to prevent the zip plugin from loading: > let g:loaded_zipPlugin= 1 let g:loaded_zip = 1 < ============================================================================== 3. Additional Extensions *zip-extension* Apparently there are a number of archivers which generate zip files that don't use the .zip extension (.jar, .xpi, etc). To handle such files, place a line in your <.vimrc> file: > au BufReadCmd *.jar,*.xpi call zip#Browse(expand("<amatch>")) < One can simply extend

This document describes the zip file interface plugin for Vim, which allows users to browse and edit files within zip archives. It covers usage instructions, available commands (like 'x' to extract files), and configurable options such as the ability to prevent automatic maximization of the file window, customize quoting mechanisms for filenames with spaces, and specify the commands used for unzipping, zipping, and extracting files. Additionally, it explains how to prevent the plugin from loading and how to handle zip files with different extensions.