summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAhmed El Gabri <ahmed+github@gabri.me>2018-05-25 12:42:05 +0200
committerAndrew Gallant <jamslam@gmail.com>2018-05-25 06:42:05 -0400
commitc3f97513d6186ddd2a7a5c5b35fc3286ec80b0de (patch)
treefed2840107b771bfde75253b956e338f2bad1525 /doc
parentc21b9b20cf0d4d25bd2765f39a2d19a782c4b254 (diff)
doc: sync config file examples
This brings the examples for configuration files in sync between the man page and the guide.
Diffstat (limited to 'doc')
-rw-r--r--doc/rg.1.txt.tpl22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/rg.1.txt.tpl b/doc/rg.1.txt.tpl
index 5af3eb29..fc268f8b 100644
--- a/doc/rg.1.txt.tpl
+++ b/doc/rg.1.txt.tpl
@@ -98,6 +98,28 @@ would behave identically to the following command
rg --smart-case foo
+another example is adding types
+
+ --type-add
+ web:*.{html,css,js}*
+
+would behave identically to the following command
+
+ rg --type-add 'web:*.{html,css,js}*' foo
+
+same with using globs
+
+ --glob=!git/*
+
+or
+
+ --glob
+ !git/*
+
+would behave identically to the following command
+
+ rg --glob '!git/*' foo
+
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.