3b4e47092e
Adds documentation to help and man pages for legacy pass-through behavior when force is set and destination is stdout. Documents --pass-through in man pages
27 lines
1.1 KiB
Groff
27 lines
1.1 KiB
Groff
.
|
|
.TH "ZSTDGREP" "1" "August 2022" "zstd 1.5.3" "User Commands"
|
|
.
|
|
.SH "NAME"
|
|
\fBzstdgrep\fR \- print lines matching a pattern in zstandard\-compressed files
|
|
.
|
|
.SH "SYNOPSIS"
|
|
\fBzstdgrep\fR [\fIgrep\-flags\fR] [\-\-] \fIpattern\fR [\fIfiles\fR \.\.\.]
|
|
.
|
|
.SH "DESCRIPTION"
|
|
\fBzstdgrep\fR runs \fBgrep (1)\fR on files, or \fBstdin\fR if no files argument is given, after decompressing them with \fBzstdcat (1)\fR\.
|
|
.
|
|
.P
|
|
The grep\-flags and pattern arguments are passed on to \fBgrep (1)\fR\. If an \fB\-e\fR flag is found in the \fBgrep\-flags\fR, \fBzstdgrep\fR will not look for a pattern argument\.
|
|
.
|
|
.P
|
|
Note that modern \fBgrep\fR alternatives such as \fBripgrep\fR (\fBrg\fR) 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\.
|
|
.
|
|
.SH "EXIT STATUS"
|
|
In case of missing arguments or missing pattern, 1 will be returned, otherwise 0\.
|
|
.
|
|
.SH "SEE ALSO"
|
|
\fBzstd (1)\fR
|
|
.
|
|
.SH "AUTHORS"
|
|
Thomas Klausner \fIwiz@NetBSD\.org\fR
|