summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2023-07-07 10:45:06 -0400
committerAndrew Gallant <jamslam@gmail.com>2023-07-08 18:52:42 -0400
commit54e609d65725ac6683714d365b65d3cf7832dd97 (patch)
treebfd81e71017b14733ed36005a13b2a1c4096383e /doc
parent43bbcca06f0aab493b5f8c85ea2f7caf4fa3f7c4 (diff)
doc: add another example for the config file
Closes #2453
Diffstat (limited to 'doc')
-rw-r--r--doc/rg.1.txt.tpl10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/rg.1.txt.tpl b/doc/rg.1.txt.tpl
index ee37744f..62ef5630 100644
--- a/doc/rg.1.txt.tpl
+++ b/doc/rg.1.txt.tpl
@@ -232,6 +232,16 @@ would behave identically to the following command
rg --glob '!.git' foo
+The bottom line is that every shell argument needs to be on its own line. So
+for example, a config file containing
+
+ -j 4
+
+is probably not doing what you intend. Instead, you want
+
+ -j
+ 4
+
ripgrep also provides a 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.