aboutsummaryrefslogtreecommitdiff
path: root/programs/zstdgrep.1.md
diff options
context:
space:
mode:
Diffstat (limited to 'programs/zstdgrep.1.md')
-rw-r--r--programs/zstdgrep.1.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/programs/zstdgrep.1.md b/programs/zstdgrep.1.md
index 363ad4f9978c..35186a4bf02d 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.