summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2019-01-26 16:19:09 -0500
committerAndrew Gallant <jamslam@gmail.com>2019-01-26 16:19:09 -0500
commit5724391d3956dbc68c005d4e6f8f8e4718a052bd (patch)
treecc567a394e8fe8181902052d38ad747d4c18f21c
parent0df71240ff19fe8fa278b64d8776725f0253bcf9 (diff)
doc: small updates to the FAQ and GUIDE
Notably, ripgrep can do multiline search now. We also update the supported compression format list and replace deprecated flags like `--sort-files` with `--sort path`.
-rw-r--r--FAQ.md15
-rw-r--r--GUIDE.md6
2 files changed, 10 insertions, 11 deletions
diff --git a/FAQ.md b/FAQ.md
index 75bbff67..e277ce7a 100644
--- a/FAQ.md
+++ b/FAQ.md
@@ -118,7 +118,7 @@ from run to run of ripgrep.
The only way to make the order of results consistent is to ask ripgrep to
sort the output. Currently, this will disable all parallelism. (On smaller
repositories, you might not notice much of a performance difference!) You
-can achieve this with the `--sort-files` flag.
+can achieve this with the `--sort path` flag.
There is more discussion on this topic here:
https://github.com/BurntSushi/ripgrep/issues/152
@@ -136,10 +136,10 @@ How do I search compressed files?
</h3>
ripgrep's `-z/--search-zip` flag will cause it to search compressed files
-automatically. Currently, this supports gzip, bzip2, lzma, lz4 and xz only and
-requires the corresponding `gzip`, `bzip2` and `xz` binaries to be installed on
-your system. (That is, ripgrep does decompression by shelling out to another
-process.)
+automatically. Currently, this supports gzip, bzip2, xz, lzma, lz4, Brotli and
+Zstd. Each of these requires requires the corresponding `gzip`, `bzip2`, `xz`,
+`lz4`, `brotli` and `zstd` binaries to be installed on your system. (That is,
+ripgrep does decompression by shelling out to another process.)
ripgrep currently does not search archive formats, so `*.tar.gz` files, for
example, are skipped.
@@ -149,9 +149,8 @@ example, are skipped.
How do I search over multiple lines?
</h3>
-This isn't currently possible. ripgrep is fundamentally a line-oriented search
-tool. With that said,
-[multiline search is a planned opt-in feature](https://github.com/BurntSushi/ripgrep/issues/176).
+The `-U/--multiline` flag enables ripgrep to report results that span over
+multiple lines.
<h3 name="fancy">
diff --git a/GUIDE.md b/GUIDE.md
index 39ccb52d..343c812e 100644
--- a/GUIDE.md
+++ b/GUIDE.md
@@ -681,10 +681,10 @@ used options that will likely impact how you use ripgrep on a regular basis.
* `--files`: Print the files that ripgrep *would* search, but don't actually
search them.
* `-a/--text`: Search binary files as if they were plain text.
-* `-z/--search-zip`: Search compressed files (gzip, bzip2, lzma, xz). This is
- disabled by default.
+* `-z/--search-zip`: Search compressed files (gzip, bzip2, lzma, xz, lz4,
+ brotli, zstd). This is disabled by default.
* `-C/--context`: Show the lines surrounding a match.
-* `--sort-files`: Force ripgrep to sort its output by file name. (This disables
+* `--sort path`: Force ripgrep to sort its output by file name. (This disables
parallelism, so it might be slower.)
* `-L/--follow`: Follow symbolic links while recursively searching.
* `-M/--max-columns`: Limit the length of lines printed by ripgrep.