blob: d7fda583398154186ffc8368300dc7ef0c922b97 [file] [log] [blame]
Yann Collet686e7e42024-03-14 15:38:14 -07001.
2.TH "ZSTDGREP" "1" "March 2024" "zstd 1.5.6" "User Commands"
3.
Yann Collet3addf2f2021-09-22 14:30:59 -07004.SH "NAME"
5\fBzstdgrep\fR \- print lines matching a pattern in zstandard\-compressed files
Yann Collet686e7e42024-03-14 15:38:14 -07006.
Yann Collet3addf2f2021-09-22 14:30:59 -07007.SH "SYNOPSIS"
Yann Collet686e7e42024-03-14 15:38:14 -07008\fBzstdgrep\fR [\fIgrep\-flags\fR] [\-\-] \fIpattern\fR [\fIfiles\fR \.\.\.]
9.
Yann Collet3addf2f2021-09-22 14:30:59 -070010.SH "DESCRIPTION"
Yann Collet95ffc762023-02-09 14:40:39 -080011\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 Collet686e7e42024-03-14 15:38:14 -070012.
Yann Collet3addf2f2021-09-22 14:30:59 -070013.P
Yann Collet95ffc762023-02-09 14:40:39 -080014The \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 Collet686e7e42024-03-14 15:38:14 -070015.
Yann Collet3addf2f2021-09-22 14:30:59 -070016.P
Yann Collet95ffc762023-02-09 14:40:39 -080017Note 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 Collet686e7e42024-03-14 15:38:14 -070018.
Yann Collet3addf2f2021-09-22 14:30:59 -070019.SH "EXIT STATUS"
20In case of missing arguments or missing pattern, 1 will be returned, otherwise 0\.
Yann Collet686e7e42024-03-14 15:38:14 -070021.
Yann Collet3addf2f2021-09-22 14:30:59 -070022.SH "SEE ALSO"
Yann Collet95ffc762023-02-09 14:40:39 -080023\fBzstd\fR(1)
Yann Collet686e7e42024-03-14 15:38:14 -070024.
Yann Collet3addf2f2021-09-22 14:30:59 -070025.SH "AUTHORS"
26Thomas Klausner \fIwiz@NetBSD\.org\fR