summaryrefslogtreecommitdiffstats
path: root/crates
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2020-05-08 12:03:45 -0400
committerAndrew Gallant <jamslam@gmail.com>2020-05-08 23:24:40 -0400
commit28f2a93caefef8018c786c80c9b47f13f62c01c3 (patch)
treed47fc5c55f705e7c863b96c025d78c66457b2a01 /crates
parent0eb2501b6e89bf83360eb70afbf1b5d221c92142 (diff)
doc: shorten -h/--help prelude
It has grown quite long. It would be nice if we could shorten this only when -h is used and keep it long for --help, but it seems clap doesn't let this happen. (It does have `about` and `long_about` options, but they don't work, even when I disable the use of the template.) The longer prelude is now only available in the man page. This addresses #189.
Diffstat (limited to 'crates')
-rw-r--r--crates/core/app.rs21
1 files changed, 2 insertions, 19 deletions
diff --git a/crates/core/app.rs b/crates/core/app.rs
index 39e1057d..69f9b57c 100644
--- a/crates/core/app.rs
+++ b/crates/core/app.rs
@@ -17,27 +17,10 @@ ripgrep (rg) recursively searches your current directory for a regex pattern.
By default, ripgrep will respect your .gitignore and automatically skip hidden
files/directories and binary files.
-ripgrep's default regex engine uses finite automata and guarantees linear
-time searching. Because of this, features like backreferences and arbitrary
-look-around are not supported. However, if ripgrep is built with PCRE2, then
-the --pcre2 flag can be used to enable backreferences and look-around.
-
-ripgrep supports configuration files. Set RIPGREP_CONFIG_PATH to a
-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'.
+Use -h for short descriptions and --help for more details.
Project home page: https://github.com/BurntSushi/ripgrep
-
-Use -h for short descriptions and --help for more details.";
+";
const USAGE: &str = "
rg [OPTIONS] PATTERN [PATH ...]