runtime/doc/pi_tar.txt

   1 *pi_tar.txt*    For Vim version 7.2.  Last change: 2008 Aug 09
   2
   3                        +====================+
   4                        | Tar File Interface |
   5                        +====================+
   6
   7 Author:  Charles E. Campbell, Jr.  <NdrOchip@ScampbellPfamily.AbizM>
   8           (remove NOSPAM from Campbell's email first)
   9 Copyright 2005-2008: 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 ==============================================================================
  14 1. 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 ==============================================================================
  21 2. 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 ==============================================================================
  30 3. Options                                              *tar-options*
  31
  32    These options are variables that one may change, typically in one's
  33    <.vimrc> file.
  34                          Default
  35    Variable               Value   Explanation
  36    *g:tar_browseoptions*  "Ptf"   used to get a list of contents
  37    *g:tar_readoptions*    "OPxf"  used to extract a file from a tarball
  38    *g:tar_cmd*            "tar"   the name of the tar program
  39    *g:tar_nomax*            0     if true, file window will not be maximized
  40    *g:tar_secure*         undef   if exists:
  41                                         "--" will be used to prevent unwanted
  42                                         option expansion in tar commands.
  43                                         Please be sure that your tar command
  44                                         accepts "--"; Posix compliant tar
  45                                         utilities do accept it.
  46                                   if not exists:
  47                                         The tar plugin will reject any member
  48                                         files that begin with "-"
  49                                   Not all tar's support the "--" which is why
  50                                   it isn't default.
  51    *g:tar_writeoptions*   "uf"    used to update/replace a file
  52
  53
  54 ==============================================================================
  55 4. History                                              *tar-history*
  56
  57    v22 Aug 08, 2008 * security fixes
  58    v16 Jun 06, 2008 * tarfile:: used instead of tarfile: when editing files
  59                       inside tarballs.  Fixes a problem with tarballs called
  60                       things like c:\abc.tar. (tnx to Bill McCarthy)
  61    v14 May 09, 2008 * arno caught a security bug
  62        May 28, 2008 * various security improvements.  Now requires patch 299
  63                       which provides the fnameescape() function
  64        May 30, 2008 * allows one to view *.gz and *.bz2 files that are in
  65                     *.tar files.
  66    v12 Sep 07, 2007 * &shq now used if not the empty string for g:tar_shq
  67    v10 May 02, 2006 * now using "redraw then echo" to show messages, instead
  68                       of "echo and prompt user"
  69    v9 May 02, 2006 * improved detection of masquerading as tar file
  70    v8 May 02, 2006 * allows editing of files that merely masquerade as tar
  71                      files
  72    v7 Mar 22, 2006 * work on making tar plugin work across network
  73       Mar 27, 2006 * g:tar_cmd now available for users to change the name
  74                      of the tar program to be used.  By default, of course,
  75                      it's "tar".
  76    v6 Dec 21, 2005 * writing to files not in directories caused problems -
  77                      fixed (pointed out by Christian Robinson)
  78    v5 Nov 22, 2005 * report option workaround installed
  79    v3 Sep 16, 2005 * handles writing files in an archive back to the
  80                      archive
  81       Oct 18, 2005 * <amatch> used instead of <afile> in autocmds
  82       Oct 18, 2005 * handles writing to compressed archives
  83       Nov 03, 2005 * handles writing tarfiles across a network using
  84                      netrw#NetWrite()
  85    v2              * converted to use Vim7's new autoload feature by
  86                      Bram Moolenaar
  87    v1 (original)   * Michael Toren (see http://michael.toren.net/code/)
  88
  89 ==============================================================================
  90 vim:tw=78:ts=8:ft=help