Mercurial > vim
annotate runtime/doc/pi_tar.txt @ 3764:c2c3577021ed v7.3.640
updated for version 7.3.640
Problem: It's not easy to build Vim on Windows with XPM support.
Solution: Binary files for 7.3.639. (Sergey Khorev)
author | Bram Moolenaar <bram@vim.org> |
---|---|
date | Wed, 29 Aug 2012 14:26:27 +0200 |
parents | af1e8a1714c2 |
children | 22fa3049e934 |
rev | line source |
---|---|
3281 | 1 *pi_tar.txt* For Vim version 7.3. Last change: 2012 Jan 17 |
799 | 2 |
1620 | 3 +====================+ |
4 | Tar File Interface | | |
5 +====================+ | |
567 | 6 |
7 Author: Charles E. Campbell, Jr. <NdrOchip@ScampbellPfamily.AbizM> | |
8 (remove NOSPAM from Campbell's email first) | |
3281 | 9 Copyright 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! | |
567 | 19 |
20 ============================================================================== | |
21 1. Contents *tar* *tar-contents* | |
22 1. Contents..................................................|tar-contents| | |
23 2. Usage.....................................................|tar-usage| | |
819 | 24 3. Options...................................................|tar-options| |
25 4. History...................................................|tar-history| | |
567 | 26 |
27 ============================================================================== | |
28 2. 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 | |
2426 | 36 *:Vimuntar* |
37 VIMUNTAR~ | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
38 |
2426 | 39 :Vimuntar [vimhome] |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
40 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
41 This command copies, if necessary, the tarball to the .vim or vimfiles |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
42 directory using the first writable directory in the |'runtimepath'| |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
43 when no [vimhome] is specified. Otherwise, the [vimhome] argument |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
44 allows the user to specify that directory, instead. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
45 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
46 The copy is done using the command in *g:tar_copycmd* , which is > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
47 cp for cygwin, unix, macunix |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
48 copy for windows (32, 95, 64, 16) |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
49 < The extraction is done with the command specified with |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
50 *g:tar_extractcmd* , which by default is > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
51 "tar -xf" |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
52 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
53 PREVENTING LOADING~ |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
54 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
55 If for some reason you do not wish to use vim to examine tar'd files, |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
56 you may put the following two variables into your <.vimrc> to prevent |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
57 the tar plugin from loading: > |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
58 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
59 let g:loaded_tarPlugin= 1 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
60 let g:loaded_tar = 1 |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
61 < |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
62 |
567 | 63 ============================================================================== |
819 | 64 3. Options *tar-options* |
65 | |
66 These options are variables that one may change, typically in one's | |
67 <.vimrc> file. | |
1121 | 68 Default |
69 Variable Value Explanation | |
2908 | 70 *g:tar_browseoptions* "Ptf" used to get a list of contents |
71 *g:tar_readoptions* "OPxf" used to extract a file from a tarball | |
72 *g:tar_cmd* "tar" the name of the tar program | |
73 *g:tar_nomax* 0 if true, file window will not be maximized | |
74 *g:tar_secure* undef if exists: | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
75 "--"s will be used to prevent unwanted |
1702 | 76 option expansion in tar commands. |
77 Please be sure that your tar command | |
78 accepts "--"; Posix compliant tar | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
79 utilities do accept them. |
1702 | 80 if not exists: |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
81 The tar plugin will reject any tar |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
82 files or member files that begin with |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
83 "-" |
1702 | 84 Not all tar's support the "--" which is why |
85 it isn't default. | |
2908 | 86 *g:tar_writeoptions* "uf" used to update/replace a file |
819 | 87 |
88 | |
89 ============================================================================== | |
90 4. History *tar-history* | |
91 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
92 |
3281 | 93 v28 Jun 23, 2011 * a few more decompression options (tbz tb2 txz) |
2908 | 94 v27 May 31, 2011 * moved cygwin detection before g:tar_copycmd handling |
95 * inserted additional |:keepj| modifiers | |
96 * changed silent to sil! (|:silent|) | |
2535
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
97 v26 Aug 09, 2010 * uses buffer-local instead of window variables to hold |
31e51111bd14
Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents:
2527
diff
changeset
|
98 tarfile name |
2908 | 99 * inserted keepj before 0d to protect jump list |
2426 | 100 v25 Jun 19, 2010 * (Jan Steffens) added support for xz compression |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
101 v24 Apr 07, 2009 * :Untarvim command implemented |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
102 Sep 28, 2009 * Added lzma support |
1702 | 103 v22 Aug 08, 2008 * security fixes |
1620 | 104 v16 Jun 06, 2008 * tarfile:: used instead of tarfile: when editing files |
105 inside tarballs. Fixes a problem with tarballs called | |
106 things like c:\abc.tar. (tnx to Bill McCarthy) | |
107 v14 May 09, 2008 * arno caught a security bug | |
108 May 28, 2008 * various security improvements. Now requires patch 299 | |
109 which provides the fnameescape() function | |
110 May 30, 2008 * allows one to view *.gz and *.bz2 files that are in | |
111 *.tar files. | |
112 v12 Sep 07, 2007 * &shq now used if not the empty string for g:tar_shq | |
1121 | 113 v10 May 02, 2006 * now using "redraw then echo" to show messages, instead |
1620 | 114 of "echo and prompt user" |
857 | 115 v9 May 02, 2006 * improved detection of masquerading as tar file |
116 v8 May 02, 2006 * allows editing of files that merely masquerade as tar | |
1620 | 117 files |
819 | 118 v7 Mar 22, 2006 * work on making tar plugin work across network |
119 Mar 27, 2006 * g:tar_cmd now available for users to change the name | |
1620 | 120 of the tar program to be used. By default, of course, |
121 it's "tar". | |
622 | 122 v6 Dec 21, 2005 * writing to files not in directories caused problems - |
1620 | 123 fixed (pointed out by Christian Robinson) |
567 | 124 v5 Nov 22, 2005 * report option workaround installed |
125 v3 Sep 16, 2005 * handles writing files in an archive back to the | |
1620 | 126 archive |
567 | 127 Oct 18, 2005 * <amatch> used instead of <afile> in autocmds |
128 Oct 18, 2005 * handles writing to compressed archives | |
129 Nov 03, 2005 * handles writing tarfiles across a network using | |
1620 | 130 netrw#NetWrite() |
1121 | 131 v2 * converted to use Vim7's new autoload feature by |
1620 | 132 Bram Moolenaar |
567 | 133 v1 (original) * Michael Toren (see http://michael.toren.net/code/) |
134 | |
135 ============================================================================== | |
136 vim:tw=78:ts=8:ft=help |