summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/universalarchive/README.md
diff options
context:
space:
mode:
authorAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
committerAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
commitedc449275b6c04445f58b108ca0937a87c1e8430 (patch)
tree9fd484d58145b616f29a78857cc0b1c8b1c18f05 /oh-my-zsh/plugins/universalarchive/README.md
parent6f5424ca96c4221ef433f545642669e9c104d0ed (diff)
add zsh
Diffstat (limited to 'oh-my-zsh/plugins/universalarchive/README.md')
-rw-r--r--oh-my-zsh/plugins/universalarchive/README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/universalarchive/README.md b/oh-my-zsh/plugins/universalarchive/README.md
new file mode 100644
index 0000000..93a1bd9
--- /dev/null
+++ b/oh-my-zsh/plugins/universalarchive/README.md
@@ -0,0 +1,46 @@
+# universalarchive plugin
+
+Lets you compress files by a command `ua <format> <files>`, supporting various
+compression formats (e.g. 7z, tar.gz, lzma, ...).
+
+To enable it, add `universalarchive` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... universalarchive)
+```
+
+## Usage
+
+Run `ua <format> <files>` to compress `<files>` into an archive file using `<format>`.
+For example:
+
+```sh
+ua xz *.html
+```
+
+this command will compress all `.html` files in directory `folder` into `folder.xz`.
+
+This plugin saves you from having to remember which command line arguments compress a file.
+
+## Supported compression formats
+
+| Extension | Description |
+|:-----------------|:-------------------------------|
+| `7z` | 7zip file |
+| `bz2` | Bzip2 file |
+| `gz` | Gzip file |
+| `lzma` | LZMA archive |
+| `lzo` | LZO archive |
+| `rar` | WinRAR archive |
+| `tar` | Tarball |
+| `tbz`/`tar.bz2` | Tarball with bzip2 compression |
+| `tgz`/`tar.gz` | Tarball with gzip compression |
+| `tlz`/`tar.lzma` | Tarball with lzma compression |
+| `txz`/`tar.xz` | Tarball with lzma2 compression |
+| `tZ`/`tar.Z` | Tarball with LZW compression |
+| `xz` | LZMA2 archive |
+| `Z` | Z archive (LZW) |
+| `zip` | Zip archive |
+| `zst` | Zstd archive |
+
+See [list of archive formats](https://en.wikipedia.org/wiki/List_of_archive_formats) for more information regarding the archive formats.