diff options
| author | YPCrumble <ipcampbell@gmail.com> | 2016-12-22 07:21:22 -0500 |
|---|---|---|
| committer | Andrew Gallant <jamslam@gmail.com> | 2016-12-22 07:21:22 -0500 |
| commit | 900ef0abc76c21697afa5c5a1a4f53f0a7d4ecc5 (patch) | |
| tree | 7acbe4506a247de248c046c4a9833858d83e83da /doc | |
| parent | 8396d3ffaae3784880a6cef25775ba2abd9f4fcf (diff) | |
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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rg.1 | 16 | ||||
| -rw-r--r-- | doc/rg.1.md | 12 |
2 files changed, 26 insertions, 2 deletions
@@ -1,6 +1,6 @@ -.\" Automatically generated by Pandoc 1.18 +.\" Automatically generated by Pandoc 1.19.1 .\" -.TH "rg" "1" +.TH "" "" "" "" "" .hy .SH NAME .PP @@ -69,6 +69,14 @@ Multiple glob flags may be used. Globbing rules match .gitignore globs. Precede a glob with a \[aq]!\[aq] to exclude it. .RS +.PP +Values given to \-g must be quoted or your shell will expand them and +result in unexpected behavior. +.PP +Combine with the \-\-files flag to return matched filenames (i.e., to +replicate ack/ag\[aq]s \-g flag). +.PP +For example: rg \-g \[aq]<glob>\[aq] \-\-files .RE .TP .B \-h, \-\-help @@ -202,6 +210,10 @@ counted as part of the pattern. .B \-\-files Print each file that would be searched (but don\[aq]t search). .RS +.PP +Combine with the \-g flag to return matched paths, for example: +.PP +rg \-g \[aq]<glob>\[aq] \-\-files .RE .TP .B \-l, \-\-files\-with\-matches diff --git a/doc/rg.1.md b/doc/rg.1.md index 466a3539..3dc1a443 100644 --- a/doc/rg.1.md +++ b/doc/rg.1.md @@ -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. |