From 8b3ab9fe3d1f929ffb409ebd5bcab2610ee42aa1 Mon Sep 17 00:00:00 2001 From: Jan Frenzel <jan.frenzel@tu-dresden.de> Date: Tue, 16 Aug 2022 09:19:01 +0200 Subject: [PATCH] Added usage example for pragzip. --- .../docs/software/utilities.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc.zih.tu-dresden.de/docs/software/utilities.md b/doc.zih.tu-dresden.de/docs/software/utilities.md index c1db9bb1c..d52bbe11a 100644 --- a/doc.zih.tu-dresden.de/docs/software/utilities.md +++ b/doc.zih.tu-dresden.de/docs/software/utilities.md @@ -160,6 +160,24 @@ marie@compute$ src/tools/pragzip --help The built binary can then be used directly or copied inside a folder that is available in your `PATH` environment variable. +Pragzip can be used like this: + +```bash +marie@compute$ pragzip -d <file_to_decompress> +``` + +For example, if you want to decompress a file called `data.gz`, use: + +```console +marie@compute$ pragzip -d data.gz +``` + +Furthermore, you can use it to speed up extraction of a file `my-archive.tar.gz` like this: + +```console +marie@compute$ tar --use-compress-program=pragzip -xf my-archive.tar.gz +``` + Pragzip is still in development, so if it crashes or if it is slower than the system `gzip`, please [open an issue](https://github.com/mxmlnkn/pragzip/issues) on GitHub. -- GitLab