blob: 7a6faf167d4e6fb09c607af8925d83fba9379332 [file] [log] [blame]
Bram Moolenaarb1c91982018-05-17 17:04:55 +02001*pi_tar.txt* For Vim version 8.1. Last change: 2013 Apr 17
Bram Moolenaarc01140a2006-03-24 22:21:52 +00002
Bram Moolenaar3577c6f2008-06-24 21:16:56 +00003 +====================+
4 | Tar 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 Moolenaar6be7f872012-01-20 21:08:56 +01009Copyright 2005-2012: *tar-copyright*
10 The VIM LICENSE (see |copyright|) applies to the files in this
11 package, including tarPlugin.vim, tar.vim, and pi_tar.txt. Like
12 anything else that's except use "tar.vim" instead of "VIM". Like
13 anything else that's free, tar.vim and its associated files are
14 provided *as is* and comes with no warranty of any kind, either
15 expressed or implied. No guarantees of merchantability. No
16 guarantees of suitability for any purpose. By using this plugin, you
17 agree that in no event will the copyright holder be liable for any
18 damages resulting from the use of this software. Use at your own risk!
Bram Moolenaar98358622005-11-28 22:58:23 +000019
20==============================================================================
211. Contents *tar* *tar-contents*
22 1. Contents..................................................|tar-contents|
23 2. Usage.....................................................|tar-usage|
Bram Moolenaar910f66f2006-04-05 20:41:53 +000024 3. Options...................................................|tar-options|
25 4. History...................................................|tar-history|
Bram Moolenaar98358622005-11-28 22:58:23 +000026
27==============================================================================
282. Usage *tar-usage* *tar-manual*
29
30 When one edits a *.tar 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 tar archives via the plugin.
35
Bram Moolenaar477db062010-07-28 18:17:41 +020036 *:Vimuntar*
37 VIMUNTAR~
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010038
Bram Moolenaar477db062010-07-28 18:17:41 +020039 :Vimuntar [vimhome]
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010040
41 This command copies, if necessary, the tarball to the .vim or vimfiles
42 directory using the first writable directory in the |'runtimepath'|
43 when no [vimhome] is specified. Otherwise, the [vimhome] argument
44 allows the user to specify that directory, instead.
45
46 The copy is done using the command in *g:tar_copycmd* , which is >
47 cp for cygwin, unix, macunix
48 copy for windows (32, 95, 64, 16)
49< The extraction is done with the command specified with
50 *g:tar_extractcmd* , which by default is >
51 "tar -xf"
52<
Bram Moolenaarff034192013-04-24 18:51:19 +020053 *:TarDiff*
54 DIFFERENCING SUPPORT~
55
56 :TarDiff [filename]
57
58 This command will attempt to show the differences between the tarball
59 version of a file and the associated file on the system. In order to
60 find that file on the system, the script uses the path associated with
61 the file mentioned in the tarball. If the current directory is not
62 correct for that path, :TarDiff will fail to find the associated file.
63
64 If the [filename] is given, that that filename (and path) will be used
65 to specify the associated file.
66
67
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010068 PREVENTING LOADING~
69
70 If for some reason you do not wish to use vim to examine tar'd files,
71 you may put the following two variables into your <.vimrc> to prevent
72 the tar plugin from loading: >
73
74 let g:loaded_tarPlugin= 1
75 let g:loaded_tar = 1
76<
77
Bram Moolenaar98358622005-11-28 22:58:23 +000078==============================================================================
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000793. Options *tar-options*
80
81 These options are variables that one may change, typically in one's
82 <.vimrc> file.
Bram Moolenaar9964e462007-05-05 17:54:07 +000083 Default
84 Variable Value Explanation
Bram Moolenaar251e1912011-06-19 05:09:16 +020085 *g:tar_browseoptions* "Ptf" used to get a list of contents
86 *g:tar_readoptions* "OPxf" used to extract a file from a tarball
87 *g:tar_cmd* "tar" the name of the tar program
88 *g:tar_nomax* 0 if true, file window will not be maximized
89 *g:tar_secure* undef if exists:
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010090 "--"s will be used to prevent unwanted
Bram Moolenaared39e1d2008-08-09 17:55:22 +000091 option expansion in tar commands.
92 Please be sure that your tar command
93 accepts "--"; Posix compliant tar
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010094 utilities do accept them.
Bram Moolenaared39e1d2008-08-09 17:55:22 +000095 if not exists:
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +010096 The tar plugin will reject any tar
97 files or member files that begin with
98 "-"
Bram Moolenaared39e1d2008-08-09 17:55:22 +000099 Not all tar's support the "--" which is why
100 it isn't default.
Bram Moolenaar251e1912011-06-19 05:09:16 +0200101 *g:tar_writeoptions* "uf" used to update/replace a file
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000102
103
104==============================================================================
1054. History *tar-history*
106
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100107
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100108 v28 Jun 23, 2011 * a few more decompression options (tbz tb2 txz)
Bram Moolenaar251e1912011-06-19 05:09:16 +0200109 v27 May 31, 2011 * moved cygwin detection before g:tar_copycmd handling
110 * inserted additional |:keepj| modifiers
111 * changed silent to sil! (|:silent|)
Bram Moolenaar7fc0c062010-08-10 21:43:35 +0200112 v26 Aug 09, 2010 * uses buffer-local instead of window variables to hold
113 tarfile name
Bram Moolenaar251e1912011-06-19 05:09:16 +0200114 * inserted keepj before 0d to protect jump list
Bram Moolenaar477db062010-07-28 18:17:41 +0200115 v25 Jun 19, 2010 * (Jan Steffens) added support for xz compression
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100116 v24 Apr 07, 2009 * :Untarvim command implemented
117 Sep 28, 2009 * Added lzma support
Bram Moolenaared39e1d2008-08-09 17:55:22 +0000118 v22 Aug 08, 2008 * security fixes
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000119 v16 Jun 06, 2008 * tarfile:: used instead of tarfile: when editing files
120 inside tarballs. Fixes a problem with tarballs called
121 things like c:\abc.tar. (tnx to Bill McCarthy)
122 v14 May 09, 2008 * arno caught a security bug
123 May 28, 2008 * various security improvements. Now requires patch 299
124 which provides the fnameescape() function
125 May 30, 2008 * allows one to view *.gz and *.bz2 files that are in
126 *.tar files.
127 v12 Sep 07, 2007 * &shq now used if not the empty string for g:tar_shq
Bram Moolenaar9964e462007-05-05 17:54:07 +0000128 v10 May 02, 2006 * now using "redraw then echo" to show messages, instead
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000129 of "echo and prompt user"
Bram Moolenaard68071d2006-05-02 22:08:30 +0000130 v9 May 02, 2006 * improved detection of masquerading as tar file
131 v8 May 02, 2006 * allows editing of files that merely masquerade as tar
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000132 files
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000133 v7 Mar 22, 2006 * work on making tar plugin work across network
134 Mar 27, 2006 * g:tar_cmd now available for users to change the name
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000135 of the tar program to be used. By default, of course,
136 it's "tar".
Bram Moolenaar86e01082005-12-29 22:45:34 +0000137 v6 Dec 21, 2005 * writing to files not in directories caused problems -
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000138 fixed (pointed out by Christian Robinson)
Bram Moolenaar98358622005-11-28 22:58:23 +0000139 v5 Nov 22, 2005 * report option workaround installed
140 v3 Sep 16, 2005 * handles writing files in an archive back to the
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000141 archive
Bram Moolenaar98358622005-11-28 22:58:23 +0000142 Oct 18, 2005 * <amatch> used instead of <afile> in autocmds
143 Oct 18, 2005 * handles writing to compressed archives
144 Nov 03, 2005 * handles writing tarfiles across a network using
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000145 netrw#NetWrite()
Bram Moolenaar9964e462007-05-05 17:54:07 +0000146 v2 * converted to use Vim7's new autoload feature by
Bram Moolenaar3577c6f2008-06-24 21:16:56 +0000147 Bram Moolenaar
Bram Moolenaar98358622005-11-28 22:58:23 +0000148 v1 (original) * Michael Toren (see http://michael.toren.net/code/)
149
150==============================================================================
151vim:tw=78:ts=8:ft=help