runtime/doc/pi_zip.txt

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