annotate runtime/doc/pi_tar.txt @ 3275:fbb23bd517f8 v7.3.406

updated for version 7.3.406 Problem: Multi-byte characters in b:browsefilter are not handled correctly. Solution: First use convert_filter() normally and then convert to wide characters. (Taro Muraoka)
author Bram Moolenaar <bram@vim.org>
date Fri, 20 Jan 2012 17:57:51 +0100
parents fd09a9c8468e
children af1e8a1714c2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
1 *pi_tar.txt* For Vim version 7.3. Last change: 2011 May 31
799
6beb2c667935 updated for version 7.0b
vimboss
parents: 622
diff changeset
2
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
3 +====================+
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
4 | Tar File Interface |
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
5 +====================+
567
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
6
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
7 Author: Charles E. Campbell, Jr. <NdrOchip@ScampbellPfamily.AbizM>
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
8 (remove NOSPAM from Campbell's email first)
2426
e52d87a2bb3e More runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
9 Copyright 2005-2010: The GPL (gnu public license) applies to *tar-copyright*
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
10 tar.vim, tarPlugin.vim, and pi_tar.txt.
567
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
11 No warranty, express or implied. Use At-Your-Own-Risk.
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
12
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
13 ==============================================================================
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
14 1. Contents *tar* *tar-contents*
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
15 1. Contents..................................................|tar-contents|
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
16 2. Usage.....................................................|tar-usage|
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
17 3. Options...................................................|tar-options|
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
18 4. History...................................................|tar-history|
567
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
19
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
20 ==============================================================================
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
21 2. Usage *tar-usage* *tar-manual*
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
22
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
23 When one edits a *.tar file, this plugin will handle displaying a
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
24 contents page. Select a file to edit by moving the cursor atop
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
25 the desired file, then hit the <return> key. After editing, one may
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
26 also write to the file. Currently, one may not make a new file in
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
27 tar archives via the plugin.
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
28
2426
e52d87a2bb3e More runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
29 *:Vimuntar*
e52d87a2bb3e More runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
30 VIMUNTAR~
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
31
2426
e52d87a2bb3e More runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
32 :Vimuntar [vimhome]
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
33
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
34 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
35 directory using the first writable directory in the |'runtimepath'|
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
36 when no [vimhome] is specified. Otherwise, the [vimhome] argument
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
37 allows the user to specify that directory, instead.
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
38
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
39 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
40 cp for cygwin, unix, macunix
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
41 copy for windows (32, 95, 64, 16)
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
42 < The extraction is done with the command specified with
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
43 *g:tar_extractcmd* , which by default is >
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
44 "tar -xf"
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 PREVENTING LOADING~
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
47
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
48 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
49 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
50 the tar plugin from loading: >
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
51
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
52 let g:loaded_tarPlugin= 1
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
53 let g:loaded_tar = 1
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
567
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
56 ==============================================================================
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
57 3. Options *tar-options*
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
58
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
59 These options are variables that one may change, typically in one's
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
60 <.vimrc> file.
1121
e63691e7c504 updated for version 7.1a
vimboss
parents: 874
diff changeset
61 Default
e63691e7c504 updated for version 7.1a
vimboss
parents: 874
diff changeset
62 Variable Value Explanation
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
63 *g:tar_browseoptions* "Ptf" used to get a list of contents
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
64 *g:tar_readoptions* "OPxf" used to extract a file from a tarball
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
65 *g:tar_cmd* "tar" the name of the tar program
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
66 *g:tar_nomax* 0 if true, file window will not be maximized
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
67 *g:tar_secure* undef if exists:
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
68 "--"s will be used to prevent unwanted
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
69 option expansion in tar commands.
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
70 Please be sure that your tar command
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
71 accepts "--"; Posix compliant tar
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
72 utilities do accept them.
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
73 if not exists:
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
74 The tar plugin will reject any tar
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
75 files or member files that begin with
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
76 "-"
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
77 Not all tar's support the "--" which is why
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
78 it isn't default.
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
79 *g:tar_writeoptions* "uf" used to update/replace a file
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
80
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
81
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
82 ==============================================================================
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
83 4. History *tar-history*
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
84
2033
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
85
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
86 v27 May 31, 2011 * moved cygwin detection before g:tar_copycmd handling
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
87 * inserted additional |:keepj| modifiers
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
88 * changed silent to sil! (|:silent|)
2535
31e51111bd14 Runtime file updates. Fix tar plugin window split.
Bram Moolenaar <bram@vim.org>
parents: 2527
diff changeset
89 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
90 tarfile name
2908
fd09a9c8468e Updated runtime files.
Bram Moolenaar <bram@vim.org>
parents: 2642
diff changeset
91 * inserted keepj before 0d to protect jump list
2426
e52d87a2bb3e More runtime file updates.
Bram Moolenaar <bram@vim.org>
parents: 2413
diff changeset
92 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
93 v24 Apr 07, 2009 * :Untarvim command implemented
de5a43c5eedc Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents: 1702
diff changeset
94 Sep 28, 2009 * Added lzma support
1702
5232b9862f23 updated for version 7.2-000
vimboss
parents: 1698
diff changeset
95 v22 Aug 08, 2008 * security fixes
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
96 v16 Jun 06, 2008 * tarfile:: used instead of tarfile: when editing files
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
97 inside tarballs. Fixes a problem with tarballs called
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
98 things like c:\abc.tar. (tnx to Bill McCarthy)
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
99 v14 May 09, 2008 * arno caught a security bug
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
100 May 28, 2008 * various security improvements. Now requires patch 299
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
101 which provides the fnameescape() function
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
102 May 30, 2008 * allows one to view *.gz and *.bz2 files that are in
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
103 *.tar files.
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
104 v12 Sep 07, 2007 * &shq now used if not the empty string for g:tar_shq
1121
e63691e7c504 updated for version 7.1a
vimboss
parents: 874
diff changeset
105 v10 May 02, 2006 * now using "redraw then echo" to show messages, instead
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
106 of "echo and prompt user"
857
b933657f7c9d updated for version 7.0g01
vimboss
parents: 856
diff changeset
107 v9 May 02, 2006 * improved detection of masquerading as tar file
b933657f7c9d updated for version 7.0g01
vimboss
parents: 856
diff changeset
108 v8 May 02, 2006 * allows editing of files that merely masquerade as tar
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
109 files
819
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
110 v7 Mar 22, 2006 * work on making tar plugin work across network
23f82b5d2814 updated for version 7.0c10
vimboss
parents: 810
diff changeset
111 Mar 27, 2006 * g:tar_cmd now available for users to change the name
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
112 of the tar program to be used. By default, of course,
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
113 it's "tar".
622
4096208d2a50 updated for version 7.0178
vimboss
parents: 567
diff changeset
114 v6 Dec 21, 2005 * writing to files not in directories caused problems -
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
115 fixed (pointed out by Christian Robinson)
567
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
116 v5 Nov 22, 2005 * report option workaround installed
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
117 v3 Sep 16, 2005 * handles writing files in an archive back to the
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
118 archive
567
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
119 Oct 18, 2005 * <amatch> used instead of <afile> in autocmds
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
120 Oct 18, 2005 * handles writing to compressed archives
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
121 Nov 03, 2005 * handles writing tarfiles across a network using
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
122 netrw#NetWrite()
1121
e63691e7c504 updated for version 7.1a
vimboss
parents: 874
diff changeset
123 v2 * converted to use Vim7's new autoload feature by
1620
73fe8baea242 updated for version 7.2a
vimboss
parents: 1245
diff changeset
124 Bram Moolenaar
567
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
125 v1 (original) * Michael Toren (see http://michael.toren.net/code/)
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
126
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
127 ==============================================================================
afd8e69dba19 updated for version 7.0161
vimboss
parents:
diff changeset
128 vim:tw=78:ts=8:ft=help