view runtime/doc/pi_gzip.txt @ 33721:d7ac49e53d62

runtime(doc): document vim-script library function Commit: https://github.com/vim/vim/commit/da4e433dc3bee7fa521df3c7235d49a6732134ef Author: Christian Brabandt <cb@256bit.org> Date: Sun Nov 5 10:45:12 2023 +0100 runtime(doc): document vim-script library function Signed-off-by: Christian Brabandt <cb@256bit.org>
author Christian Brabandt <cb@256bit.org>
date Sun, 05 Nov 2023 11:00:03 +0100
parents f8116058ca76
children fc557aa379ef
line wrap: on
line source

*pi_gzip.txt*   For Vim version 9.0.  Last change: 2023 Nov 05


		  VIM REFERENCE MANUAL    by Bram Moolenaar


Editing compressed files with Vim		*gzip* *bzip2* *compress*

1. Autocommands			|gzip-autocmd|

The functionality mentioned here is a |standard-plugin|.
This plugin is only available if 'compatible' is not set.
You can avoid loading this plugin by setting the "loaded_gzip" variable: >
	:let loaded_gzip = 1
<
							*g:gzip_exec*

For security reasons, one may prevent that Vim runs executables automatically
when opening a buffer.  This option (default: "1") can be used to prevent
executing the executables command when set to "0": >
	:let g:gzip_exec = 0
<

==============================================================================
2. Autocommands						*gzip-autocmd*

The plugin installs autocommands to intercept reading and writing of files
with these extensions:

	extension	compression ~
	*.Z		compress (Lempel-Ziv)
	*.gz		gzip
	*.bz2		bzip2
	*.lzma		lzma
	*.xz		xz
	*.lz		lzip
	*.zst		zstd

That's actually the only thing you need to know.  There are no options.

After decompressing a file, the filetype will be detected again.  This will
make a file like "foo.c.gz" get the "c" filetype.

If you have 'patchmode' set, it will be appended after the extension for
compression.  Thus editing the patchmode file will not give you the automatic
decompression.  You have to rename the file if you want this.

==============================================================================
 vim:tw=78:ts=8:noet:ft=help:norl: