1*pi_tar.txt*	For Vim version 7.3.  Last change: 2010 Aug 09
2
3		       +====================+
4		       | Tar File Interface |
5		       +====================+
6
7Author:  Charles E. Campbell, Jr.  <NdrOchip@ScampbellPfamily.AbizM>
8	  (remove NOSPAM from Campbell's email first)
9Copyright 2005-2010: The GPL (gnu public license) applies to	*tar-copyright*
10	   tar.vim, tarPlugin.vim, and pi_tar.txt.
11	   No warranty, express or implied.  Use At-Your-Own-Risk.
12
13==============================================================================
141. Contents					*tar* *tar-contents*
15   1. Contents..................................................|tar-contents|
16   2. Usage.....................................................|tar-usage|
17   3. Options...................................................|tar-options|
18   4. History...................................................|tar-history|
19
20==============================================================================
212. Usage					*tar-usage* *tar-manual*
22
23   When one edits a *.tar file, this plugin will handle displaying a
24   contents page.  Select a file to edit by moving the cursor atop
25   the desired file, then hit the <return> key.  After editing, one may
26   also write to the file.  Currently, one may not make a new file in
27   tar archives via the plugin.
28
29						*:Vimuntar*
30   VIMUNTAR~
31
32   :Vimuntar [vimhome]
33
34	This command copies, if necessary, the tarball to the .vim or vimfiles
35	directory using the first writable directory in the |'runtimepath'|
36	when no [vimhome] is specified.  Otherwise, the [vimhome] argument
37	allows the user to specify that directory, instead.
38
39	The copy is done using the command in *g:tar_copycmd* , which is >
40		cp   for cygwin, unix, macunix
41		copy for windows (32, 95, 64, 16)
42<	The extraction is done with the command specified with
43	*g:tar_extractcmd* , which by default is >
44		"tar -xf"
45<
46   PREVENTING LOADING~
47
48   If for some reason you do not wish to use vim to examine tar'd files,
49   you may put the following two variables into your <.vimrc> to prevent
50   the tar plugin from loading: >
51
52	let g:loaded_tarPlugin= 1
53	let g:loaded_tar      = 1
54<
55
56==============================================================================
573. Options						*tar-options*
58
59   These options are variables that one may change, typically in one's
60   <.vimrc> file.
61                         Default
62   Variable               Value   Explanation
63   *g:tar_browseoptions*  "Ptf"   used to get a list of contents
64   *g:tar_readoptions*    "OPxf"  used to extract a file from a tarball
65   *g:tar_cmd*            "tar"   the name of the tar program
66   *g:tar_nomax*            0     if true, file window will not be maximized
67   *g:tar_secure*         undef   if exists:
68					"--"s will be used to prevent unwanted
69					option expansion in tar commands.
70					Please be sure that your tar command
71					accepts "--"; Posix compliant tar
72					utilities do accept them.
73				  if not exists:
74				  	The tar plugin will reject any tar
75					files or member files that begin with
76					"-"
77				  Not all tar's support the "--" which is why
78				  it isn't default.
79   *g:tar_writeoptions*   "uf"    used to update/replace a file
80
81
82==============================================================================
834. History						*tar-history*
84
85
86   v26 Aug 09, 2010 * uses buffer-local instead of window variables to hold
87		      tarfile name
88   v25 Jun 19, 2010 * (Jan Steffens) added support for xz compression
89   v24 Apr 07, 2009 * :Untarvim command implemented
90       Sep 28, 2009 * Added lzma support
91   v22 Aug 08, 2008 * security fixes
92   v16 Jun 06, 2008 * tarfile:: used instead of tarfile: when editing files
93		      inside tarballs.  Fixes a problem with tarballs called
94		      things like c:\abc.tar. (tnx to Bill McCarthy)
95   v14 May 09, 2008 * arno caught a security bug
96       May 28, 2008 * various security improvements.  Now requires patch 299
97		      which provides the fnameescape() function
98       May 30, 2008 * allows one to view *.gz and *.bz2 files that are in
99		    *.tar files.
100   v12 Sep 07, 2007 * &shq now used if not the empty string for g:tar_shq
101   v10 May 02, 2006 * now using "redraw then echo" to show messages, instead
102		      of "echo and prompt user"
103   v9 May 02, 2006 * improved detection of masquerading as tar file
104   v8 May 02, 2006 * allows editing of files that merely masquerade as tar
105		     files
106   v7 Mar 22, 2006 * work on making tar plugin work across network
107      Mar 27, 2006 * g:tar_cmd now available for users to change the name
108		     of the tar program to be used.  By default, of course,
109		     it's "tar".
110   v6 Dec 21, 2005 * writing to files not in directories caused problems -
111		     fixed (pointed out by Christian Robinson)
112   v5 Nov 22, 2005 * report option workaround installed
113   v3 Sep 16, 2005 * handles writing files in an archive back to the
114		     archive
115      Oct 18, 2005 * <amatch> used instead of <afile> in autocmds
116      Oct 18, 2005 * handles writing to compressed archives
117      Nov 03, 2005 * handles writing tarfiles across a network using
118		     netrw#NetWrite()
119   v2              * converted to use Vim7's new autoload feature by
120		     Bram Moolenaar
121   v1 (original)   * Michael Toren (see http://michael.toren.net/code/)
122
123==============================================================================
124vim:tw=78:ts=8:ft=help
125