| Elliott Hughes | 44aba64 | 2023-09-12 20:18:59 +0000 | [diff] [blame] | 1 | .TH "ZSTDGREP" "1" "March 2023" "zstd 1.5.5" "User Commands" |
| Yann Collet | 3addf2f | 2021-09-22 14:30:59 -0700 | [diff] [blame] | 2 | .SH "NAME" |
| 3 | \fBzstdgrep\fR \- print lines matching a pattern in zstandard\-compressed files |
| 4 | .SH "SYNOPSIS" |
| Elliott Hughes | 44aba64 | 2023-09-12 20:18:59 +0000 | [diff] [blame] | 5 | \fBzstdgrep\fR [\fIgrep\-flags\fR] [\-\-] \fIpattern\fR [\fIfiles\fR \|\.\|\.\|\.] |
| Yann Collet | 3addf2f | 2021-09-22 14:30:59 -0700 | [diff] [blame] | 6 | .SH "DESCRIPTION" |
| Elliott Hughes | 44aba64 | 2023-09-12 20:18:59 +0000 | [diff] [blame] | 7 | \fBzstdgrep\fR runs \fBgrep\fR(1) on files, or \fBstdin\fR if no files argument is given, after decompressing them with \fBzstdcat\fR(1)\. |
| Yann Collet | 3addf2f | 2021-09-22 14:30:59 -0700 | [diff] [blame] | 8 | .P |
| Elliott Hughes | 44aba64 | 2023-09-12 20:18:59 +0000 | [diff] [blame] | 9 | The \fIgrep\-flags\fR and \fIpattern\fR arguments are passed on to \fBgrep\fR(1)\. If an \fB\-e\fR flag is found in the \fIgrep\-flags\fR, \fBzstdgrep\fR will not look for a \fIpattern\fR argument\. |
| Yann Collet | 3addf2f | 2021-09-22 14:30:59 -0700 | [diff] [blame] | 10 | .P |
| Elliott Hughes | 44aba64 | 2023-09-12 20:18:59 +0000 | [diff] [blame] | 11 | Note that modern \fBgrep\fR alternatives such as \fBripgrep\fR (\fBrg\fR(1)) support \fBzstd\fR\-compressed files out of the box, and can prove better alternatives than \fBzstdgrep\fR notably for unsupported complex pattern searches\. Note though that such alternatives may also feature some minor command line differences\. |
| Yann Collet | 3addf2f | 2021-09-22 14:30:59 -0700 | [diff] [blame] | 12 | .SH "EXIT STATUS" |
| 13 | In case of missing arguments or missing pattern, 1 will be returned, otherwise 0\. |
| 14 | .SH "SEE ALSO" |
| Elliott Hughes | 44aba64 | 2023-09-12 20:18:59 +0000 | [diff] [blame] | 15 | \fBzstd\fR(1) |
| Yann Collet | 3addf2f | 2021-09-22 14:30:59 -0700 | [diff] [blame] | 16 | .SH "AUTHORS" |
| 17 | Thomas Klausner \fIwiz@NetBSD\.org\fR |