diff options
Diffstat (limited to '3rdparty/zstd/programs/zstdgrep.1.md')
-rw-r--r-- | 3rdparty/zstd/programs/zstdgrep.1.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/3rdparty/zstd/programs/zstdgrep.1.md b/3rdparty/zstd/programs/zstdgrep.1.md new file mode 100644 index 00000000000..6370a81c7ca --- /dev/null +++ b/3rdparty/zstd/programs/zstdgrep.1.md @@ -0,0 +1,30 @@ +zstdgrep(1) -- print lines matching a pattern in zstandard-compressed files +============================================================================ + +SYNOPSIS +-------- + +`zstdgrep` [<grep-flags>] [--] <pattern> [<files> ...] + + +DESCRIPTION +----------- +`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`(1)) 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. + +SEE ALSO +-------- +`zstd`(1) + +AUTHORS +------- +Thomas Klausner <wiz@NetBSD.org> |