aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/zip.txt
blob: bc15d499b977e7c49727070435d430c1e73e755f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
*zip.txt*    Nvim


                            NVIM REFERENCE MANUAL


Builtin plugin: zip                                                      *zip*

Nvim opens a read-only listing when |:edit| is used with a zip archive. The
listing is a |dir| buffer with 'filetype' set to "zip"; entries open as
read-only `zip://{archive}/{path}` buffers. Requires the `unzip`
executable.

Recognized extensions include zip, jar, apk, epub, Office and OpenDocument
formats, whl, xpi, pkpass, and cbz. Remote archives are fetched by |vim.net|.

Reading an entry from an encrypted archive prompts for its password.

                                                    *g:loaded_nvim_zip_plugin*
To disable the built-in zip browser, set this before startup: >lua

    vim.g.loaded_nvim_zip_plugin = 1

MAPPINGS                                                       *zip-mappings*

The standard |dir-buffer-mappings|, plus:

• x extracts the entry under the cursor into the current directory, discarding
  its path inside the archive. It never overwrites an existing file.

At the archive root, - opens the containing filesystem directory.

LIMITATIONS                                                *zip-limitations*

Archive entries cannot be updated. Remote archives are not refetched on
reload, and there is no PowerShell fallback, no custom backend command, and no
support for the legacy `g:zip_*` variables. Use |old-zip| when those features
are required.

Only the original zip encryption is supported, not AES.

==============================================================================
Legacy plugin: zip                                                   *old-zip*

The legacy Vimscript zip plugin browses, updates, and extracts archive
entries. It is not loaded by default; use `:packadd` to activate it: >lua

    vim.cmd.packadd('old-zip')
<
This can be done at any time. Its manual is then available as
`:help pi_zip.txt`.

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