rust/ripgrep
1
0
Fork 0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-04-19 09:02:15 +02:00
Code Issues Releases Activity

doc: small updates to the FAQ and GUIDE

Browse Source 
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`.
This commit is contained in:
Andrew Gallant 2019-01-26 16:19:09 -05:00
parent 0df71240ff
commit 5724391d39
No known key found for this signature in database
GPG Key ID: B2E3A4923F8B0D44
2 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
FAQ.md
View File

@ -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 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 sort the output. Currently, this will disable all parallelism. (On smaller
repositories, you might not notice much of a performance difference!) You 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: There is more discussion on this topic here:
https://github.com/BurntSushi/ripgrep/issues/152 https://github.com/BurntSushi/ripgrep/issues/152
@ -136,10 +136,10 @@ How do I search compressed files?
</h3> </h3>
ripgrep's `-z/--search-zip` flag will cause it to search compressed files 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 automatically. Currently, this supports gzip, bzip2, xz, lzma, lz4, Brotli and
requires the corresponding `gzip`, `bzip2` and `xz` binaries to be installed on Zstd. Each of these requires requires the corresponding `gzip`, `bzip2`, `xz`,
your system. (That is, ripgrep does decompression by shelling out to another `lz4`, `brotli` and `zstd` binaries to be installed on your system. (That is,
process.) ripgrep does decompression by shelling out to another process.)
ripgrep currently does not search archive formats, so `*.tar.gz` files, for ripgrep currently does not search archive formats, so `*.tar.gz` files, for
example, are skipped. example, are skipped.
@ -149,9 +149,8 @@ example, are skipped.
How do I search over multiple lines? How do I search over multiple lines?
</h3> </h3>
This isn't currently possible. ripgrep is fundamentally a line-oriented search The `-U/--multiline` flag enables ripgrep to report results that span over
tool. With that said, multiple lines.
[multiline search is a planned opt-in feature](https://github.com/BurntSushi/ripgrep/issues/176).
<h3 name="fancy"> <h3 name="fancy">

6
GUIDE.md
View File

@ -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 * `--files`: Print the files that ripgrep *would* search, but don't actually
search them. search them.
* `-a/--text`: Search binary files as if they were plain text. * `-a/--text`: Search binary files as if they were plain text.
* `-z/--search-zip`: Search compressed files (gzip, bzip2, lzma, xz). This is * `-z/--search-zip`: Search compressed files (gzip, bzip2, lzma, xz, lz4,
disabled by default. brotli, zstd). This is disabled by default.
* `-C/--context`: Show the lines surrounding a match. * `-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.) parallelism, so it might be slower.)
* `-L/--follow`: Follow symbolic links while recursively searching. * `-L/--follow`: Follow symbolic links while recursively searching.
* `-M/--max-columns`: Limit the length of lines printed by ripgrep. * `-M/--max-columns`: Limit the length of lines printed by ripgrep.