xref: /freebsd/sys/contrib/zstd/programs/zstdgrep.1.md (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
1zstdgrep(1) -- print lines matching a pattern in zstandard-compressed files
2============================================================================
3
4SYNOPSIS
5--------
6
7`zstdgrep` [*grep-flags*] [--] _pattern_ [_files_ ...]
8
9
10DESCRIPTION
11-----------
12`zstdgrep` runs `grep (1)` on files, or `stdin` if no files argument is given, after decompressing them with `zstdcat (1)`.
13
14The 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.
15
16Note that modern `grep` alternatives such as `ripgrep` (`rg`) support `zstd`-compressed files out of the box,
17and can prove better alternatives than `zstdgrep` notably for unsupported complex pattern searches.
18Note though that such alternatives may also feature some minor command line differences.
19
20EXIT STATUS
21-----------
22In case of missing arguments or missing pattern, 1 will be returned, otherwise 0.
23
24SEE ALSO
25--------
26`zstd (1)`
27
28AUTHORS
29-------
30Thomas Klausner <wiz@NetBSD.org>
31