search: add support for searching compressed files
This commit adds opt-in support for searching compressed files during recursive search. This behavior is only enabled when the `-z/--search-zip` flag is passed to ripgrep. When enabled, a limited set of common compression formats are recognized via file extension, and a new process is spawned to perform the decompression. ripgrep then searches the stdout of that spawned process. Closes #539
This commit is contained in:
committed by
Andrew Gallant
parent
a8543f798d
commit
f007f940c5
13
doc/rg.1
13
doc/rg.1
@@ -184,6 +184,15 @@ Only show matches surrounded by line boundaries.
|
||||
This is equivalent to putting ^...$ around the search pattern.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-z, \-\-search\-zip
|
||||
Search in compressed files.
|
||||
Currently gz, bz2, xz and lzma formats are supported.
|
||||
.RS
|
||||
.PP
|
||||
Note that ripgrep expects to find the decompression binaries for the
|
||||
respective formats in your system\[aq]s PATH for use with this flag.
|
||||
.RE
|
||||
.SH LESS COMMON OPTIONS
|
||||
.TP
|
||||
.B \-A, \-\-after\-context \f[I]NUM\f[]
|
||||
@@ -437,9 +446,7 @@ such part on a separate output line.
|
||||
.TP
|
||||
.B \-\-passthru, \-\-passthrough
|
||||
Show both matching and non\-matching lines.
|
||||
This is equivalent to adding ^ to the list of search patterns.
|
||||
This option overrides \-\-count and cannot be used with
|
||||
\-\-only\-matching or \-\-replace.
|
||||
This option cannot be used with \-\-only\-matching or \-\-replace.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
|
||||
@@ -125,6 +125,13 @@ Project home page: https://github.com/BurntSushi/ripgrep
|
||||
: Only show matches surrounded by line boundaries. This is equivalent to
|
||||
putting ^...$ around the search pattern.
|
||||
|
||||
-z, --search-zip
|
||||
: Search in compressed files. Currently gz, bz2, xz and lzma
|
||||
formats are supported.
|
||||
|
||||
Note that ripgrep expects to find the decompression binaries for the
|
||||
respective formats in your system's PATH for use with this flag.
|
||||
|
||||
# LESS COMMON OPTIONS
|
||||
|
||||
-A, --after-context *NUM*
|
||||
|
||||
Reference in New Issue
Block a user