]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
update zstdgrep doc
authorYann Collet <cyan@fb.com>
Wed, 22 Sep 2021 21:30:06 +0000 (14:30 -0700)
committerYann Collet <cyan@fb.com>
Wed, 22 Sep 2021 21:30:06 +0000 (14:30 -0700)
to mention ripgrep alternative which transparently supports zstd-compressed files.

programs/zstdgrep.1.md

index 363ad4f9978c6669978d8c31c9e7268563265c04..35186a4bf02d3f95d0d23cffe205bc532b3edfaa 100644 (file)
@@ -9,10 +9,14 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-`zstdgrep` runs `grep (1)` on files or stdin, if no files argument is given, after decompressing them with `zstdcat (1)`.
+`zstdgrep` runs `grep (1)` on files, or `stdin` if no files argument is given, after decompressing them with `zstdcat (1)`.
 
 The grep-flags and pattern arguments are passed on to `grep (1)`.  If an `-e` flag is found in the `grep-flags`, `zstdgrep` will not look for a pattern argument.
 
+Note that modern `grep` alternatives such as `ripgrep` (`rg`) support `zstd`-compressed files out of the box,
+and can prove better alternatives than `zstdgrep` notably for unsupported complex pattern searches.
+Note though that such alternatives may also feature some minor command line differences.
+
 EXIT STATUS
 -----------
 In case of missing arguments or missing pattern, 1 will be returned, otherwise 0.