xref: /aosp_15_r20/external/zstd/programs/zstdgrep.1.md (revision 01826a4963a0d8a59bc3812d29bdf0fb76416722)
1*01826a49SYabin Cuizstdgrep(1) -- print lines matching a pattern in zstandard-compressed files
2*01826a49SYabin Cui============================================================================
3*01826a49SYabin Cui
4*01826a49SYabin CuiSYNOPSIS
5*01826a49SYabin Cui--------
6*01826a49SYabin Cui
7*01826a49SYabin Cui`zstdgrep` [<grep-flags>] [--] <pattern> [<files> ...]
8*01826a49SYabin Cui
9*01826a49SYabin Cui
10*01826a49SYabin CuiDESCRIPTION
11*01826a49SYabin Cui-----------
12*01826a49SYabin Cui`zstdgrep` runs `grep`(1) on files, or `stdin` if no files argument is given, after decompressing them with `zstdcat`(1).
13*01826a49SYabin Cui
14*01826a49SYabin CuiThe <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*01826a49SYabin Cui
16*01826a49SYabin CuiNote that modern `grep` alternatives such as `ripgrep` (`rg`(1)) support `zstd`-compressed files out of the box,
17*01826a49SYabin Cuiand can prove better alternatives than `zstdgrep` notably for unsupported complex pattern searches.
18*01826a49SYabin CuiNote though that such alternatives may also feature some minor command line differences.
19*01826a49SYabin Cui
20*01826a49SYabin CuiEXIT STATUS
21*01826a49SYabin Cui-----------
22*01826a49SYabin CuiIn case of missing arguments or missing pattern, 1 will be returned, otherwise 0.
23*01826a49SYabin Cui
24*01826a49SYabin CuiSEE ALSO
25*01826a49SYabin Cui--------
26*01826a49SYabin Cui`zstd`(1)
27*01826a49SYabin Cui
28*01826a49SYabin CuiAUTHORS
29*01826a49SYabin Cui-------
30*01826a49SYabin CuiThomas Klausner <[email protected]>
31