readme: add notes about supported formats

Notes state that some formats are compressed in parallel, and some
doesn't support (de)compression streaming.
This commit is contained in:
João M. Bezerra 2023-01-30 23:30:24 -03:00
parent 30bf657e5e
commit 841ec4dc6e

View File

@ -106,15 +106,21 @@ Output:
| Format | `.tar` | `.zip` | `.gz` | `.xz`, `.lzma` | `.bz`, `.bz2` | `.lz4` | `.sz` | `.zst` |
|:---------:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
| Supported | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| Supported | ✓ | ✓¹ | ✓² | ✓ | ✓ | ✓ | ✓² | ✓ |
And the aliases: `tgz`, `tbz`, `tbz2`, `tlz4`, `txz`, `tlzma`, `tsz`, `tzst`.
✓: Supports compression and decompression.
✓¹: Due to limitations of `.zip`, it doesn't support streaming (de)compression.
✓²: Supported, and compression runs in parallel.
`tar` aliases are also supported: `tgz`, `tbz`, `tbz2`, `tlz4`, `txz`, `tlzma`, `tsz`, `tzst`.
Formats can be chained:
- `.tar.gz`
- `.tar.gz.gz.gz.gz`
- `.tar.gz.gz.gz.gz.zst.xz.bz.lz4`
- `.zst.gz`
- `.tar.gz.gz`
- `.tar.gz.gz.gz.zst.xz.bz.lz4`
If the filename has no extensions, `Ouch` will try to infer the format by the [file signature](https://en.wikipedia.org/wiki/List_of_file_signatures).
# Installation