summaryrefslogtreecommitdiffstats
path: root/crates
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2020-03-15 09:55:31 -0400
committerAndrew Gallant <jamslam@gmail.com>2020-03-15 13:19:14 -0400
commitdaa831939873a50cd7e193a7211b5e3d37ad631c (patch)
treeb32e04af1842ad5faf9aa46d918e0e0caa572a8d /crates
parent3a6a24a52ad43d55554240b43e8be989c78e4efe (diff)
doc: note ripgrep's stdin behavior
Fixes #1439
Diffstat (limited to 'crates')
-rw-r--r--crates/core/app.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/crates/core/app.rs b/crates/core/app.rs
index d65b41fa..ef9cf883 100644
--- a/crates/core/app.rs
+++ b/crates/core/app.rs
@@ -27,6 +27,11 @@ configuration file. The file can specify one shell argument per line. Lines
starting with '#' are ignored. For more details, see the man page or the
README.
+ripgrep will automatically detect if stdin exists and search stdin for a regex
+pattern, e.g. 'ls | rg foo'. In some environments, stdin may exist when it
+shouldn't. To turn off stdin detection explicitly specify the directory to
+search, e.g. 'rg foo ./'.
+
Tip: to disable all smart filtering and make ripgrep behave a bit more like
classical grep, use 'rg -uuu'.