view runtime/doc/pi_gzip.txt @ 36543:6871d5f2fc77 draft

runtime(doc): clarify the use of filters and external commands Commit: https://github.com/vim/vim/commit/f18987caa5095e9ff154f924d952047c67c9fb64 Author: Christian Brabandt <cb@256bit.org> Date: Tue Nov 12 21:38:22 2024 +0100 runtime(doc): clarify the use of filters and external commands related: https://github.com/vim/vim/issues/16044 Signed-off-by: Christian Brabandt <cb@256bit.org>
author Christian Brabandt <cb@256bit.org>
date Tue, 12 Nov 2024 21:45:02 +0100
parents 4635e43f2c6f
children
line wrap: on
line source

*pi_gzip.txt*   For Vim version 9.1.  Last change: 2023 Nov 14


		  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
<

==============================================================================
1. 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: