summaryrefslogtreecommitdiffstats
path: root/GUIDE.md
AgeCommit message (Collapse)Author
2023-07-08doc: add '--hidden' to example configurationKevin Ushey
This increases visibility of the fact that hidden files are skipped by default. Closes #2356
2022-08-10doc: add '-.' as short flag for '--hidden'David Marzal
PR #2279
2021-11-22doc: transcoding is done in addition to searchMateusz Konieczny
Even if transcoding would be faster than search it would still incur performance penalty. We make this clearer by tweaking the wording. PR #2079
2021-07-21doc: add -F/--fixed-strings to "common options"Dash
#607 is the top result for the search "ripgrep disable regex". I think it makes sense to add it to the user guide, since it's a very useful flag. PR #1945
2021-06-15doc: fix formatting of nested listkotborealis
Markdown wants 4 spaces, not 2. PR #1894
2021-05-31doc: explain ignore rules a bit moretillyboy
Closes #1600
2020-09-22spelling: fix various misspellingsJosh Soref
These were found by the check spelling action[1] and reported here[2]. PR #1685 [1] - https://github.com/marketplace/actions/check-spelling [2] - https://github.com/jsoref/ripgrep/commit/6f02d056716a116b643da1de4b53c6f15118fc38#commitcomment-42625778
2020-05-08doc: add a section about --pre to the GUIDEAndrew Gallant
Fixes #1252
2020-05-08doc: add -U/--multiline to common optionsAndrew Gallant
2020-02-17doc: document `all` file typeRobert Irelan
This adds it to the guide and the docs for the --type flag. Fixes #1344, Closes #1472
2020-01-20doc: add missing "will" to the user guideOliver Newman
PR #1462
2019-06-01doc: point regex doc link to the latest versionskierpage
The latest doc is different, e.g. adds "symmetric differences" under https://docs.rs/regex/*/regex/#character-classes PR #1287
2019-04-15ripgrep: max-column-preview --> max-columns-previewAndrew Gallant
Credit to @okdana for catching this. This naming is a bit more consistent with the existing --max-columns flag.
2019-04-14printer: support previews for long linesAndrew Gallant
This commit adds support for showing a preview of long lines. While the default still remains as completely suppressing the entire line, this new functionality will show the first N graphemes of a matching line, including the number of matches that are suppressed. This was unfortunately a fairly invasive change to the printer that required a bit of refactoring. On the bright side, the single line and multi-line coloring are now more unified than they were before. Closes #1078
2019-04-14binary: rejigger ripgrep's handling of binary filesAndrew Gallant
This commit attempts to surface binary filtering in a slightly more user friendly way. Namely, before, ripgrep would silently stop searching a file if it detected a NUL byte, even if it had previously printed a match. This can lead to the user quite reasonably assuming that there are no more matches, since a partial search is fairly unintuitive. (ripgrep has this behavior by default because it really wants to NOT search binary files at all, just like it doesn't search gitignored or hidden files.) With this commit, if a match has already been printed and ripgrep detects a NUL byte, then it will print a warning message indicating that the search stopped prematurely. Moreover, this commit adds a new flag, --binary, which causes ripgrep to stop filtering binary files, but in a way that still avoids dumping binary data into terminals. That is, the --binary flag makes ripgrep behave more like grep's default behavior. For files explicitly specified in a search, e.g., `rg foo some-file`, then no binary filtering is applied (just like no gitignore and no hidden file filtering is applied). Instead, ripgrep behaves as if you gave the --binary flag for all explicitly given files. This was a fairly invasive change, and potentially increases the UX complexity of ripgrep around binary files. (Before, there were two binary modes, where as now there are three.) However, ripgrep is now a bit louder with warning messages when binary file detection might otherwise be hiding potential matches, so hopefully this is a net improvement. Finally, the `-uuu` convenience now maps to `--no-ignore --hidden --binary`, since this is closer to the actualy intent of the `--unrestricted` flag, i.e., to reduce ripgrep's smart filtering. As a consequence, `rg -uuu foo` should now search roughly the same number of bytes as `grep -r foo`, and `rg -uuua foo` should search roughly the same number of bytes as `grep -ra foo`. (The "roughly" weasel word is used because grep's and ripgrep's binary file detection might differ somewhat---perhaps based on buffer sizes---which can impact exactly what is and isn't searched.) See the numerous tests in tests/binary.rs for intended behavior. Fixes #306, Fixes #855
2019-04-06searcher: add option to disable BOM sniffinglesnyrumcajs
This commit adds a new encoding feature where the -E/--encoding flag will now accept a value of 'none'. When given this value, all encoding related machinery is disabled and ripgrep will search the raw bytes of the file, including the BOM if it's present. Closes #1207, Closes #1208
2019-04-05config: switch to using bstrsAndrew Gallant
This lets us implement correct Unicode trimming and also simplifies the parsing logic a bit. This also removes the last platform specific bits of code in ripgrep core.
2019-01-26doc: small updates to the FAQ and GUIDEAndrew Gallant
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`.
2019-01-26doc: clarify automatic encoding detectionAndrew Gallant
Fixes #1103
2019-01-22ripgrep: add --ignore-file-case-insensitiveDavid Torosyan
The --ignore-file-case-insensitive flag causes all .gitignore/.rgignore/.ignore files to have their globs matched without regard for case. Because this introduces a potentially significant performance regression, this is always disabled by default. Users that need case insensitive matching can enable it on a case by case basis. Closes #1164, Closes #1170
2018-08-31doc: fix typosJakub Wilk
2018-05-25doc: sync config file examplesAhmed El Gabri
This brings the examples for configuration files in sync between the man page and the guide.
2018-02-20doc: clarify failure modeAndrew Gallant
This adds a hint for end users that run into a common failure mode where ripgrep won't search any files because they have a `*` rule in their `$HOME/.gitignore`. Fixes #815
2018-02-10doc: overhaul documentationAndrew Gallant
This commit cleans up the README and splits portions of it out into a user guide (GUIDE.md) and a FAQ (FAQ.md). The README now provides a small list of documentation "quick" links to various parts of the docs. This commit also does a few other minor touchups.