stow/oh-my-zsh/.oh-my-zsh/plugins/universalarchive/README.md

   1 # universalarchive plugin
   2
   3 Lets you compress files by a command `ua <format> <files>`, supporting various
   4 compression formats (e.g. 7z, tar.gz, lzma, ...).
   5
   6 To enable it, add `universalarchive` to the plugins array in your zshrc file:
   7
   8 ```zsh
   9 plugins=(... universalarchive)
  10 ```
  11
  12 ## Usage
  13
  14 Run `ua <format> <files>` to compress `<files>` into an archive file using `<format>`.
  15 For example:
  16
  17 ```sh
  18 ua xz *.html
  19 ```
  20
  21 this command will compress all `.html` files in directory `folder` into `folder.xz`.
  22
  23 This plugin saves you from having to remember which command line arguments compress a file.
  24
  25 ## Supported compression formats
  26
  27 | Extension        | Description                    |
  28 |:-----------------|:-------------------------------|
  29 | `7z`             | 7zip file                      |
  30 | `bz2`            | Bzip2 file                     |
  31 | `gz`             | Gzip file                      |
  32 | `lzma`           | LZMA archive                   |
  33 | `lzo`            | LZO archive                    |
  34 | `rar`            | WinRAR archive                 |
  35 | `tar`            | Tarball                        |
  36 | `tbz`/`tar.bz2`  | Tarball with bzip2 compression |
  37 | `tgz`/`tar.gz`   | Tarball with gzip compression  |
  38 | `tlz`/`tar.lzma` | Tarball with lzma compression  |
  39 | `txz`/`tar.xz`   | Tarball with lzma2 compression |
  40 | `tZ`/`tar.Z`     | Tarball with LZW compression   |
  41 | `xz`             | LZMA2 archive                  |
  42 | `Z`              | Z archive (LZW)                |
  43 | `zip`            | Zip archive                    |
  44 | `zst`            | Zstd archive                   |
  45
  46 See [list of archive formats](https://en.wikipedia.org/wiki/List_of_archive_formats) for more information regarding the archive formats.