bac896fca7b1af1e4237e96c58a0c13b8ff2d0de

Author
Marc Cornellà <marc.cornella@live.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

extract: add README

Diff

 1diff --git a/plugins/extract/README.md b/plugins/extract/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..c6bdd36dd6c3cd2d6920103ca709dab17e47d340
 4--- /dev/null
 5+++ b/plugins/extract/README.md
 6@@ -0,0 +1,46 @@
 7+# extract plugin
 8+
 9+This plugin defines a function called `extract` that extracts the archive file
10+you pass it, and it supports a wide variety of archive filetypes.
11+
12+This way you don't have to know what specific command extracts a file, you just
13+do `extract <filename>` and the function takes care of the rest.
14+
15+To use it, add `extract` to the plugins array in your zshrc file:
16+
17+```zsh
18+plugins=(... extract)
19+```
20+
21+## Supported file extensions
22+
23+| Extension         | Description                          |
24+|:------------------|:-------------------------------------|
25+| `7z`              | 7zip file                            |
26+| `Z`               | Z archive (LZW)                      |
27+| `apk`             | Android app file                     |
28+| `bz2`             | Bzip2 file                           |
29+| `deb`             | Debian package                       |
30+| `gz`              | Gzip file                            |
31+| `ipsw`            | iOS firmware file                    |
32+| `jar`             | Java Archive                         |
33+| `lzma`            | LZMA archive                         |
34+| `rar`             | WinRAR archive                       |
35+| `sublime-package` | Sublime Text package                 |
36+| `tar`             | Tarball                              |
37+| `tar.bz2`         | Tarball with bzip2 compression       |
38+| `tar.gz`          | Tarball with gzip compression        |
39+| `tar.xz`          | Tarball with lzma2 compression       |
40+| `tar.zma`         | Tarball with lzma compression        |
41+| `tbz`             | Tarball with bzip compression        |
42+| `tbz2`            | Tarball with bzip2 compression       |
43+| `tgz`             | Tarball with gzip compression        |
44+| `tlz`             | Tarball with lzma compression        |
45+| `txz`             | Tarball with lzma2 compression       |
46+| `war`             | Web Application archive (Java-based) |
47+| `xpi`             | Mozilla XPI module file              |
48+| `xz`              | LZMA2 archive                        |
49+| `zip`             | Zip archive                          |
50+
51+See [list of archive formats](https://en.wikipedia.org/wiki/List_of_archive_formats) for
52+more information regarding archive formats.