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

@@ -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