summaryrefslogtreecommitdiffstats
path: root/README.md
AgeCommit message (Collapse)Author
2018-02-04config: add persistent configurationAndrew Gallant
This commit adds support for reading configuration files that change ripgrep's default behavior. The format of the configuration file is an "rc" style and is very simple. It is defined by two rules: 1. Every line is a shell argument, after trimming ASCII whitespace. 2. Lines starting with '#' (optionally preceded by any amount of ASCII whitespace) are ignored. ripgrep will look for a single configuration file if and only if the RIPGREP_CONFIG_PATH environment variable is set and is non-empty. ripgrep will parse shell arguments from this file on startup and will behave as if the arguments in this file were prepended to any explicit arguments given to ripgrep on the command line. For example, if your ripgreprc file contained a single line: --smart-case then the following command RIPGREP_CONFIG_PATH=wherever/.ripgreprc rg foo would behave identically to the following command rg --smart-case foo This commit also adds a new flag, --no-config, that when present will suppress any and all support for configuration. This includes any future support for auto-loading configuration files from pre-determined paths (which this commit does not add). Conflicts between configuration files and explicit arguments are handled exactly like conflicts in the same command line invocation. That is, this command: RIPGREP_CONFIG_PATH=wherever/.ripgreprc rg foo --case-sensitive is exactly equivalent to rg --smart-case foo --case-sensitive in which case, the --case-sensitive flag would override the --smart-case flag. Closes #196
2018-01-30search: add support for searching compressed filesBalaji Sivaraman
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
2018-01-12readme: add Ubuntu install instructionsSebastian Torres
2018-01-12readme: ripgrep is in Fedora 27Igor Gnatenko
References: https://bodhi.fedoraproject.org/updates/FEDORA-2018-ca3c304458
2018-01-08readme: update summary benchmarksAndrew Gallant
2018-01-08readme: link to Andy Lester's feature comparisonAndrew Gallant
2018-01-07remove reference to copr for F28+Igor Gnatenko
Signed-off-by: Igor Gnatenko <i.gnatenko.brain@gmail.com>
2018-01-07trivial: update instructions for FedoraIgor Gnatenko
Signed-off-by: Igor Gnatenko <i.gnatenko.brain@gmail.com>
2017-11-22full package name for Gentoo sys-apps/ripgrepJonas Stein
2017-11-03Added example for --colors to READMEReuben D'Netto
2017-11-01Correct spelling mistakes in readme file.Christoph Michelbach
2017-10-14Fix minor typosTJ Rana
Update name Mac OS X to macOS
2017-10-12Add troubleshooting notes re: conflicting tools/aliasesdana
2017-10-10readme: clarify introAndrew Gallant
2017-10-08Addressed code reivew.Omer Katz
2017-10-08Ripgrep installs from Linuxbrew just fine and works as expected.Omer Katz
Mentioned it in the README file :)
2017-10-08Update README to be more explicit about precompiled binaries (fixes #618)dana
2017-10-08Rewording READMEDaniel Vergeylen
Trial to stay consistent with rest of the text. Rewording by native english.
2017-10-08Update READMEDaniel Vergeylen
Notify user `cargo install ripgrep` contains debug symbols and informs how to stripe them.
2017-09-04tweak workingAndrew Gallant
2017-08-23readme: update minimum versionAndrew Gallant
2017-07-22fix profile showing command for powershellLeonardo Santagada
change the profile showing command to one that matches the microsoft article linked, as its simpler and the old one didn't work at least on windows 10 creators edition.
2017-07-08update COPR nameCarl George
I switched Fedora usernames, so new builds will be at a different URL.
2017-05-29Add Zsh completion fileFangrui Song
2017-05-08Add Powershell tips and autocompletion instructionsEli Miller
2017-04-09Add short note on Windows TipsDouman
2017-03-14Update whirlwind tour with encoding info.Andrew Gallant
Fixes #1
2017-03-12fix CHANGELOG linkAndrew Gallant
2017-03-12changelog 0.5.0Andrew Gallant
2017-03-12Add support for additional text encodings.Andrew Gallant
This includes, but is not limited to, UTF-16, latin-1, GBK, EUC-JP and Shift_JIS. (Courtesy of the `encoding_rs` crate.) Specifically, this feature enables ripgrep to search files that are encoded in an encoding other than UTF-8. The list of available encodings is tied directly to what the `encoding_rs` crate supports, which is in turn tied to the Encoding Standard. The full list of available encodings can be found here: https://encoding.spec.whatwg.org/#concept-encoding-get This pull request also introduces the notion that text encodings can be automatically detected on a best effort basis. Currently, the only support for this is checking for a UTF-16 bom. In all other cases, a text encoding of `auto` (the default) implies a UTF-8 or ASCII compatible source encoding. When a text encoding is otherwise specified, it is unconditionally used for all files searched. Since ripgrep's regex engine is fundamentally built on top of UTF-8, this feature works by transcoding the files to be searched from their source encoding to UTF-8. This transcoding only happens when: 1. `auto` is specified and a non-UTF-8 encoding is detected. 2. A specific encoding is given by end users (including UTF-8). When transcoding occurs, errors are handled by automatically inserting the Unicode replacement character. In this case, ripgrep's output is guaranteed to be valid UTF-8 (excluding non-UTF-8 file paths, if they are printed). In all other cases, the source text is searched directly, which implies an assumption that it is at least ASCII compatible, but where UTF-8 is most useful. In this scenario, encoding errors are not detected. In this case, ripgrep's output will match the input exactly, byte-for-byte. This design may not be optimal in all cases, but it has some advantages: 1. In the happy path ("UTF-8 everywhere") remains happy. I have not been able to witness any performance regressions. 2. In the non-UTF-8 path, implementation complexity is kept relatively low. The cost here is transcoding itself. A potentially superior implementation might build decoding of any encoding into the regex engine itself. In particular, the fundamental problem with transcoding everything first is that literal optimizations are nearly negated. Future work should entail improving the user experience. For example, we might want to auto-detect more text encodings. A more elaborate UX experience might permit end users to specify multiple text encodings, although this seems hard to pull off in an ergonomic way. Fixes #1
2017-03-08Add "Known issues" section in README.mdJean-Marie Comets
Also document that ctrl-c doesn't restore the termcolor. Fixes #347.
2017-03-01Added Chocolatey to the installation listDavid Salter
2017-02-24kick travisAndrew Gallant
2017-01-14note minimum Rust versionAndrew Gallant
2017-01-09fix minimum Rust versionAndrew Gallant
2017-01-09remove redundant wordsAndrew Gallant
2017-01-09add anti-pitchAndrew Gallant
2017-01-06Add docs for shell completion files.Andrew Gallant
Add small howtos for installing shell completion files to the README and the man page. They are still incomplete. We're missing Zsh and PowerShell. Fixes #262
2016-12-22Update docs to explain use of -g and --files to search for paths. (#285)YPCrumble
Update docs to explain use of -g and --files to search for paths. Fixes #284
2016-12-12Make backreference support clear.Andrew Gallant
Fixes #268.
2016-11-06ucg author says it's not a bug per seAndrew Gallant
2016-11-06touchupsAndrew Gallant
2016-11-06typoAndrew Gallant
2016-11-06touchupsAndrew Gallant
2016-11-06touchupsAndrew Gallant
2016-11-06touchupsAndrew Gallant
2016-11-06touchupsAndrew Gallant
2016-11-06Update README with more/updated benchmarksAndrew Gallant
2016-11-01Add Gentoo info to the READMETim Harder
2016-10-26Mention Nix package in READMEc74d
In the `README.md` document, where said document documents the availability of pre-built packages of ripgrep, document the availability of such a package from the package management system Nix.