blob: e3b1e27e584b2046af1a6651ebc2f84deddbd821 [file] [log] [blame]
Bram Moolenaarbb76f242016-09-12 14:24:39 +02001*pi_zip.txt* For Vim version 8.0. Last change: 2013 Apr 17
Bram Moolenaarc01140a2006-03-24 22:21:52 +00002
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003 +====================+
4 | Zip File Interface |
5 +====================+
Bram Moolenaar98358622005-11-28 22:58:23 +00006
Bram Moolenaarff034192013-04-24 18:51:19 +02007Author: Charles E. Campbell <NdrOchip@ScampbellPfamily.AbizM>
Bram Moolenaar98358622005-11-28 22:58:23 +00008 (remove NOSPAM from Campbell's email first)
Bram Moolenaarff034192013-04-24 18:51:19 +02009Copyright: Copyright (C) 2005-2012 Charles E Campbell *zip-copyright*
Bram Moolenaar6be7f872012-01-20 21:08:56 +010010 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!
Bram Moolenaar98358622005-11-28 22:58:23 +000019
20==============================================================================
Bram Moolenaar251e1912011-06-19 05:09:16 +0200211. Contents *zip* *zip-contents*
Bram Moolenaar7263a772007-05-10 17:35:54 +000022 1. Contents................................................|zip-contents|
23 2. Usage...................................................|zip-usage|
24 3. Additional Extensions...................................|zip-extension|
25 4. History.................................................|zip-history|
Bram Moolenaar98358622005-11-28 22:58:23 +000026
27==============================================================================
Bram Moolenaar251e1912011-06-19 05:09:16 +0200282. Usage *zip-usage* *zip-manual*
Bram Moolenaar98358622005-11-28 22:58:23 +000029
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
Bram Moolenaar7263a772007-05-10 17:35:54 +000036 OPTIONS
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000037
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*
Bram Moolenaar7263a772007-05-10 17:35:54 +000044 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
Bram Moolenaar9964e462007-05-05 17:54:07 +000049< 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
Bram Moolenaar7263a772007-05-10 17:35:54 +000053 *g:zip_unzipcmd*
54 Use this option to specify the program which does the duty of "unzip".
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000055 It's used during browsing. By default: >
Bram Moolenaar7263a772007-05-10 17:35:54 +000056 let g:zip_unzipcmd= "unzip"
57<
58 *g:zip_zipcmd*
59 Use this option to specify the program which does the duty of "zip".
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000060 It's used during the writing (updating) of a file already in a zip
Bram Moolenaar7263a772007-05-10 17:35:54 +000061 file; by default: >
62 let g:zip_zipcmd= "zip"
63<
Bram Moolenaar00a927d2010-05-14 23:24:24 +020064 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
Bram Moolenaar24ea3ba2010-09-19 19:01:21 +020068 the zip plugin from loading: >
Bram Moolenaar00a927d2010-05-14 23:24:24 +020069
70 let g:loaded_zipPlugin= 1
71 let g:loaded_zip = 1
72<
Bram Moolenaar7263a772007-05-10 17:35:54 +000073
Bram Moolenaar98358622005-11-28 22:58:23 +000074==============================================================================
Bram Moolenaar7263a772007-05-10 17:35:54 +0000753. Additional Extensions *zip-extension*
76
Bram Moolenaar6be7f872012-01-20 21:08:56 +010077 Apparently there are a number of archivers which generate zip files that
Bram Moolenaar7263a772007-05-10 17:35:54 +000078 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<
Bram Moolenaarc236c162008-07-13 17:41:49 +000083 One can simply extend this line to accommodate additional extensions that
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000084 should be treated as zip files.
Bram Moolenaar7263a772007-05-10 17:35:54 +000085
86==============================================================================
Bram Moolenaar251e1912011-06-19 05:09:16 +0200874. History *zip-history* {{{1
Bram Moolenaarff034192013-04-24 18:51:19 +020088 v26 Nov 15, 2012 * (Jason Spiro) provided a lot of new extensions that
89 are synonyms for .zip
Bram Moolenaar6be7f872012-01-20 21:08:56 +010090 v25 Jun 27, 2011 * using keepj with unzip -Z
91 (consistent with the -p variant)
Bram Moolenaarff034192013-04-24 18:51:19 +020092 * (Ben Staniford) now uses
93 has("win32unix") && executable("cygpath")
94 before converting to cygwin-style paths
Bram Moolenaar251e1912011-06-19 05:09:16 +020095 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
Bram Moolenaar3577c6f2008-06-24 21:16:56 +000099 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
Bram Moolenaar7263a772007-05-10 17:35:54 +0000101 v14 May 07, 2007 * using b:zipfile instead of w:zipfile to avoid problem
102 when editing alternate file to bring up a zipfile
Bram Moolenaar9964e462007-05-05 17:54:07 +0000103 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.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000107 v8 Apr 10, 2006 * Bram Moolenaar reported that he received an error message
Bram Moolenaar9964e462007-05-05 17:54:07 +0000108 due to "Pattern not found: ^.*\%0c"; this was caused by
Bram Moolenaar4c3f5362006-04-11 21:38:50 +0000109 stridx finding a Name... at the beginning of the line;
110 zip.vim tried 4,$s/^.*\%0c//, but that doesn't work.
111 Fixed.
Bram Moolenaar7b5f8322006-03-23 22:47:08 +0000112 v7 Mar 22, 2006 * escaped some characters that can cause filename handling
Bram Moolenaar9964e462007-05-05 17:54:07 +0000113 problems.
Bram Moolenaar86e01082005-12-29 22:45:34 +0000114 v6 Dec 21, 2005 * writing to files not in directories caused problems -
Bram Moolenaar9964e462007-05-05 17:54:07 +0000115 fixed (pointed out by Christian Robinson)
Bram Moolenaar98358622005-11-28 22:58:23 +0000116 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)
Bram Moolenaar9964e462007-05-05 17:54:07 +0000119 * began testing under Windows; works thus far
Bram Moolenaar98358622005-11-28 22:58:23 +0000120 * filetype detection fixed
121 Nov 03, 2005 * handles writing zipfiles across a network using
Bram Moolenaar9964e462007-05-05 17:54:07 +0000122 netrw#NetWrite()
Bram Moolenaar98358622005-11-28 22:58:23 +0000123 v1 Sep 15, 2005 * Initial release, had browsing, reading, and writing
124
125==============================================================================
Bram Moolenaar7263a772007-05-10 17:35:54 +0000126vim:tw=78:ts=8:ft=help:fdm=marker