]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
updated zstdgrep man page
authorYann Collet <yann.collet.73@gmail.com>
Wed, 22 Sep 2021 21:30:59 +0000 (14:30 -0700)
committerYann Collet <yann.collet.73@gmail.com>
Wed, 22 Sep 2021 21:30:59 +0000 (14:30 -0700)
programs/zstdgrep.1

index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..ae4da33545c28f8c74ee010a1b41b1dc85db8793 100644 (file)
@@ -0,0 +1,17 @@
+.TH "ZSTDGREP" "1" "September 2021" "zstd 1.5.1" "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