From 841ec4dc6e2cfa771f0c55637708d8f22547560d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20M=2E=20Bezerra?= Date: Mon, 30 Jan 2023 23:30:24 -0300 Subject: [PATCH] readme: add notes about supported formats Notes state that some formats are compressed in parallel, and some doesn't support (de)compression streaming. --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 20dab90..d5768fa 100644 --- a/README.md +++ b/README.md @@ -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