summaryrefslogtreecommitdiff
path: root/sys/contrib/zstd/programs/zstdgrep.1.md
blob: 35186a4bf02d3f95d0d23cffe205bc532b3edfaa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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`) 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>