From: Yann Collet <cyan@fb.com>
Date: Wed, 22 Sep 2021 21:30:06 +0000 (-0700)
Subject: update zstdgrep doc
X-Git-Tag: v1.5.1~1^2~102^2~2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=70b36c2308441fc6448fc48a365831c7748078b9;p=thirdparty%2Fzstd.git

update zstdgrep doc

to mention ripgrep alternative which transparently supports zstd-compressed files.
---

diff --git a/programs/zstdgrep.1.md b/programs/zstdgrep.1.md
index 363ad4f99..35186a4bf 100644
--- a/programs/zstdgrep.1.md
+++ b/programs/zstdgrep.1.md
@@ -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.