summaryrefslogtreecommitdiffstats
path: root/doc/rg.1.md
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2017-03-12 20:31:09 -0400
committerAndrew Gallant <jamslam@gmail.com>2017-03-12 20:31:09 -0400
commitae863bc7aa6fc887aa237b007f3bfce4fdf33e11 (patch)
treeac092e207e83f4154c869d75adbdb6d611ef1750 /doc/rg.1.md
parentf0d3cae56963a912a6e50bc7c4d11416e4ef4989 (diff)
Improve docs for --glob flag.
Fixes #345.
Diffstat (limited to 'doc/rg.1.md')
-rw-r--r--doc/rg.1.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/rg.1.md b/doc/rg.1.md
index fce63c56..d8e498c0 100644
--- a/doc/rg.1.md
+++ b/doc/rg.1.md
@@ -49,8 +49,13 @@ Project home page: https://github.com/BurntSushi/ripgrep
-g, --glob *GLOB* ...
: Include or exclude files for searching that match the given glob. This always
- overrides any other ignore logic. Multiple glob flags may be used. Globbing
- rules match .gitignore globs. Precede a glob with a '!' to exclude it.
+ overrides any other ignore logic if there is a conflict, but is otherwise
+ applied in addition to ignore files (e.g., .gitignore or .ignore). Multiple
+ glob flags may be used. Globbing rules match .gitignore globs. Precede a
+ glob with a '!' to exclude it.
+
+ The --glob flag subsumes the functionality of both the --include and
+ --exclude flags commonly found in other tools.
Values given to -g must be quoted or your shell will expand them and result
in unexpected behavior.