share/vim/vim74/doc/pi_zip.txt

   1 *pi_zip.txt*    For Vim version 7.4.  Last change: 2013 Apr 17
   2
   3                                 +====================+
   4                                 | Zip File Interface |
   5                                 +====================+
   6
   7 Author:  Charles E. Campbell  <NdrOchip@ScampbellPfamily.AbizM>
   8           (remove NOSPAM from Campbell's email first)
   9 Copyright: Copyright (C) 2005-2012 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 ==============================================================================
  21 1. 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 ==============================================================================
  28 2. 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    OPTIONS
  37
  38                                                         *g:zip_nomax*
  39
  40    If this variable exists and is true, the file window will not be
  41    automatically maximized when opened.
  42
  43                                                         *g:zip_shq*
  44    Different operating systems may use one or more shells to execute
  45    commands.  Zip will try to guess the correct quoting mechanism to
  46    allow spaces and whatnot in filenames; however, if it is incorrectly
  47    guessing the quote to use for your setup, you may use >
  48         g:zip_shq
  49 <  which by default is a single quote under Unix (') and a double quote
  50    under Windows (").  If you'd rather have no quotes, simply set
  51    g:zip_shq to the empty string (let g:zip_shq= "") in your <.vimrc>.
  52
  53                                                         *g:zip_unzipcmd*
  54    Use this option to specify the program which does the duty of "unzip".
  55    It's used during browsing. By default: >
  56         let g:zip_unzipcmd= "unzip"
  57 <
  58                                                         *g:zip_zipcmd*
  59    Use this option to specify the program which does the duty of "zip".
  60    It's used during the writing (updating) of a file already in a zip
  61    file; by default: >
  62         let g:zip_zipcmd= "zip"
  63 <
  64    PREVENTING LOADING~
  65
  66    If for some reason you do not wish to use vim to examine zipped files,
  67    you may put the following two variables into your <.vimrc> to prevent
  68    the zip plugin from loading: >
  69
  70         let g:loaded_zipPlugin= 1
  71         let g:loaded_zip      = 1
  72 <
  73
  74 ==============================================================================
  75 3. Additional Extensions                                        *zip-extension*
  76
  77    Apparently there are a number of archivers which generate zip files that
  78    don't use the .zip extension (.jar, .xpi, etc).  To handle such files,
  79    place a line in your <.vimrc> file: >
  80
  81         au BufReadCmd *.jar,*.xpi call zip#Browse(expand("<amatch>"))
  82 <
  83    One can simply extend this line to accommodate additional extensions that
  84    should be treated as zip files.
  85
  86 ==============================================================================
  87 4. History                                                      *zip-history* {{{1
  88    v26 Nov 15, 2012 * (Jason Spiro) provided a lot of new extensions that
  89                       are synonyms for .zip
  90    v25 Jun 27, 2011 * using keepj with unzip -Z
  91                       (consistent with the -p variant)
  92                     * (Ben Staniford) now uses
  93                         has("win32unix") && executable("cygpath")
  94                       before converting to cygwin-style paths
  95    v24 Jun 21, 2010 * (Cédric Bosdonnat) unzip seems to need its filenames
  96                       fnameescape'd as well as shellquote'd
  97                     * (Motoya Kurotsu) inserted keepj before 0d to protect
  98                       jump list
  99    v17 May 09, 2008 * arno caught a security bug
 100    v15 Sep 07, 2007 * &shq now used if not the empty string for g:zip_shq
 101    v14 May 07, 2007 * using b:zipfile instead of w:zipfile to avoid problem
 102                       when editing alternate file to bring up a zipfile
 103    v10 May 02, 2006 * now using "redraw then echo" to show messages, instead
 104                       of "echo and prompt user"
 105                     * g:zip_shq provided to allow for quoting control for the
 106                       command being passed via :r! ... commands.
 107    v8 Apr 10, 2006 * Bram Moolenaar reported that he received an error message
 108                      due to "Pattern not found: ^.*\%0c"; this was caused by
 109                      stridx finding a Name... at the beginning of the line;
 110                      zip.vim tried 4,$s/^.*\%0c//, but that doesn't work.
 111                      Fixed.
 112    v7 Mar 22, 2006 * escaped some characters that can cause filename handling
 113                      problems.
 114    v6 Dec 21, 2005 * writing to files not in directories caused problems -
 115                      fixed (pointed out by Christian Robinson)
 116    v5 Nov 22, 2005 * report option workaround installed
 117    v3 Oct 18, 2005 * <amatch> used instead of <afile> in autocmds
 118    v2 Sep 16, 2005 * silenced some commands (avoiding hit-enter prompt)
 119                    * began testing under Windows; works thus far
 120                    * filetype detection fixed
 121       Nov 03, 2005 * handles writing zipfiles across a network using
 122                      netrw#NetWrite()
 123    v1 Sep 15, 2005 * Initial release, had browsing, reading, and writing
 124
 125 ==============================================================================
 126 vim:tw=78:ts=8:ft=help:fdm=marker