Update docs to explain use of -g and --files to search for paths. (#285)

Update docs to explain use of -g and --files to search for paths.

Fixes #284
This commit is contained in:
YPCrumble
2016-12-22 07:21:22 -05:00
committed by Andrew Gallant
parent 8396d3ffaa
commit 900ef0abc7
3 changed files with 32 additions and 2 deletions

View File

@@ -52,6 +52,14 @@ Project home page: https://github.com/BurntSushi/ripgrep
overrides any other ignore logic. Multiple glob flags may be used. Globbing
rules match .gitignore globs. Precede a glob with a '!' to exclude it.
Values given to -g must be quoted or your shell will expand them and result
in unexpected behavior.
Combine with the --files flag to return matched filenames
(i.e., to replicate ack/ag's -g flag).
For example: rg -g '\<glob\>' --files
-h, --help
: Show this usage message.
@@ -136,6 +144,10 @@ Project home page: https://github.com/BurntSushi/ripgrep
--files
: Print each file that would be searched (but don't search).
Combine with the -g flag to return matched paths, for example:
rg -g '\<glob\>' --files
-l, --files-with-matches
: Only show path of each file with matches.