Documentation updates
[MacVim/KaoriYa.git] / runtime / doc / pi_tar.txt
blobcf099d480f0078c88f72bbd0ebeca33328b6f957
1 *pi_tar.txt*    For Vim version 7.1.  Last change: 2006 Sep 29
3                        +====================+
4                        | Tar File Interface |
5                        +====================+
7 Author:  Charles E. Campbell, Jr.  <NdrOchip@ScampbellPfamily.AbizM>
8           (remove NOSPAM from Campbell's email first)
9 Copyright: The GPL (gnu public license) applies to      *tar-copyright*
10            tarPlugin.vim, and pi_tar.txt.
11            No warranty, express or implied.  Use At-Your-Own-Risk.
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|
20 ==============================================================================
21 2. Usage                                        *tar-usage* *tar-manual*
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.
29 ==============================================================================
30 3. Options                                              *tar-options*
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_writeoptions*   "uf"    used to update/replace a file
42 ==============================================================================
43 4. History                                              *tar-history*
45    v10 May 02, 2006 * now using "redraw then echo" to show messages, instead
46                       of "echo and prompt user"
47    v9 May 02, 2006 * improved detection of masquerading as tar file
48    v8 May 02, 2006 * allows editing of files that merely masquerade as tar
49                      files
50    v7 Mar 22, 2006 * work on making tar plugin work across network
51       Mar 27, 2006 * g:tar_cmd now available for users to change the name
52                      of the tar program to be used.  By default, of course,
53                      its "tar".
54    v6 Dec 21, 2005 * writing to files not in directories caused problems -
55                      fixed (pointed out by Christian Robinson)
56    v5 Nov 22, 2005 * report option workaround installed
57    v3 Sep 16, 2005 * handles writing files in an archive back to the
58                      archive
59       Oct 18, 2005 * <amatch> used instead of <afile> in autocmds
60       Oct 18, 2005 * handles writing to compressed archives
61       Nov 03, 2005 * handles writing tarfiles across a network using
62                      netrw#NetWrite()
63    v2              * converted to use Vim7's new autoload feature by
64                      Bram Moolenaar
65    v1 (original)   * Michael Toren (see http://michael.toren.net/code/)
67 ==============================================================================
68 vim:tw=78:ts=8:ft=help