pi_tar.txt (6955B)
1 *pi_tar.txt* Nvim 2 3 +====================+ 4 | Tar File Interface | 5 +====================+ 6 7 Original Author: Charles E. Campbell 8 Copyright 2005-2017: *tar-copyright* 9 The VIM LICENSE (see |copyright|) applies to the files in this 10 package, including tarPlugin.vim, tar.vim, and pi_tar.txt. Like 11 anything else that's except use "tar.vim" instead of "VIM". Like 12 anything else that's free, tar.vim and its associated files are 13 provided as is and comes with no warranty of any kind, either 14 expressed or implied. No guarantees of merchantability. No 15 guarantees of suitability for any purpose. By using this plugin, you 16 agree that in no event will the copyright holder be liable for any 17 damages resulting from the use of this software. Use at your own risk! 18 19 ============================================================================== 20 1. Contents *tar* *tar-contents* 21 1. Contents..................................................|tar-contents| 22 2. Usage.....................................................|tar-usage| 23 3. Options...................................................|tar-options| 24 4. History...................................................|tar-history| 25 26 ============================================================================== 27 2. Usage *tar-usage* *tar-manual* 28 29 When one edits a `*.tar` file, this plugin will handle displaying a 30 contents page. Select a file to edit by moving the cursor atop 31 the desired file, then hit the <return> key. After editing, one may 32 also write to the file. Currently, one may not make a new file in 33 tar archives via the plugin. 34 35 *:TarDiff* 36 DIFFERENCING SUPPORT~ 37 38 :TarDiff [filename] 39 40 This command will attempt to show the differences between the tarball 41 version of a file and the associated file on the system. In order to 42 find that file on the system, the script uses the path associated with 43 the file mentioned in the tarball. If the current directory is not 44 correct for that path, :TarDiff will fail to find the associated file. 45 46 If the [filename] is given, that filename (and path) will be used to 47 specify the associated file. 48 49 50 PREVENTING LOADING~ 51 52 If for some reason you do not wish to use vim to examine tar'd files, 53 you may put the following two variables into your <.vimrc> to prevent 54 the tar plugin from loading: > 55 56 let g:loaded_tarPlugin= 1 57 let g:loaded_tar = 1 58 < 59 *tar-mappings* 60 MAPPINGS~ 61 62 The following (buffer-local) mappings are available in a tar buffer: 63 64 <CR> Open selected file for editing, any changes will be 65 written back to the archive. 66 <LeftMouse> same as <CR> 67 x Extract selected file. 68 69 ============================================================================== 70 3. Options *tar-options* 71 72 These options are variables that one may change, typically in one's 73 <.vimrc> file. 74 Default 75 Variable Value Explanation 76 *g:tar_browseoptions* "Ptf" used to get a list of contents 77 *g:tar_readoptions* "OPxf" used to extract a file from a tarball 78 *g:tar_cmd* "tar" the name of the tar program 79 *g:tar_nomax* 0 if true, file window will not be maximized 80 *g:tar_writeoptions* "uf" used to update/replace a file 81 82 83 ============================================================================== 84 4. History *tar-history* 85 86 unreleased: 87 Jul 13, 2025 * drop leading / 88 May 19, 2025 * restore working directory after read/write 89 Apr 16, 2025 * decouple from netrw by adding s:WinPath() 90 instead of shelling out to file(1) 91 Mar 02, 2025 * determine the compression using readblob() 92 Mar 02, 2025 * escape the filename before using :read 93 Mar 01, 2025 * fix syntax error in tar#Read() 94 Feb 28, 2025 * add support for bzip3 (#16755) 95 Feb 06, 2025 * add support for lz4 (#16591) 96 Nov 11, 2024 * support permissions (#7379) 97 Feb 19, 2024 * announce adoption 98 Jan 08, 2024 * fix a few problems (#138331, #12637, #8109) 99 v31 Apr 02, 2017 * (klartext) reported that browsing encrypted 100 files in a zip archive created unencrypted 101 swap files. I am applying a similar fix 102 used on zip.vim to tar.vim: new buffers 103 are opened with |:noswapfile|. 104 May 16, 2017 * When the mouse option isn't empty, the 105 leftmouse can be used to select a file 106 in the tar-file listing. 107 v30 Apr 22, 2014 * .tgz files are ambiguous: they may have been 108 compressed with either gzip or bzip2. Tar.vim 109 disambiguates by using unix's "file" command. 110 Feb 18, 2016 * Changed =~ to =~# where appropriate 111 Feb 18, 2017 * Now also permits xz decompression 112 v28 Jun 23, 2011 * a few more decompression options (tbz tb2 txz) 113 v27 May 31, 2011 * moved cygwin detection before g:tar_copycmd 114 handling 115 * inserted additional |:keepj| modifiers 116 * changed silent to sil! (|:silent|) 117 v26 Aug 09, 2010 * uses buffer-local instead of window variables 118 to hold tarfile name 119 * inserted keepj before 0d to protect jump list 120 v25 Jun 19, 2010 * (Jan Steffens) added support for xz 121 compression 122 v24 Apr 07, 2009 * :Untarvim command implemented 123 Sep 28, 2009 * Added lzma support 124 v22 Aug 08, 2008 * security fixes 125 v16 Jun 06, 2008 * tarfile:: used instead of tarfile: when 126 editing files inside tarballs. Fixes a 127 problem with tarballs called things like 128 c:\abc.tar. (tnx to Bill McCarthy) 129 v14 May 09, 2008 * arno caught a security bug 130 May 28, 2008 * various security improvements. Now requires 131 patch 299 which provides the fnameescape() 132 function 133 May 30, 2008 * allows one to view `*.gz` and `*.bz2` files that 134 are in `*.tar` files. 135 v12 Sep 07, 2007 * &shq now used if not the empty string for 136 g:tar_shq 137 v10 May 02, 2006 * now using "redraw then echo" to show messages, 138 instead of "echo and prompt user" 139 v9 May 02, 2006 * improved detection of masquerading as tar file 140 v8 May 02, 2006 * allows editing of files that merely masquerade 141 as tar files 142 v7 Mar 22, 2006 * work on making tar plugin work across network 143 Mar 27, 2006 * g:tar_cmd now available for users to change 144 the name of the tar program to be used. By 145 default, of course, it's "tar". 146 v6 Dec 21, 2005 * writing to files not in directories caused 147 problems - fixed (pointed out by 148 Christian Robinson) 149 v5 Nov 22, 2005 * report option workaround installed 150 v3 Sep 16, 2005 * handles writing files in an archive back to 151 the archive 152 Oct 18, 2005 * <amatch> used instead of <afile> in autocmds 153 Oct 18, 2005 * handles writing to compressed archives 154 Nov 03, 2005 * handles writing tarfiles across a network 155 using netrw#NetWrite() 156 v2 * converted to use Vim7's new autoload feature 157 by Bram Moolenaar 158 v1 (original) * Michael Toren 159 (see michael.toren.net/code/ 160 link seems dead) 161 162 ============================================================================== 163 vim:tw=78:ts=8:noet:ft=help