Clarify -u/--unrestricted flags.

Fixes #340
This commit is contained in:
Andrew Gallant 2017-03-12 20:24:45 -04:00
parent 4ef4818130
commit f0d3cae569
2 changed files with 19 additions and 0 deletions

View File

@ -127,6 +127,12 @@ Two \-u flags will search hidden files and directories.
Three \-u flags will search binary files. Three \-u flags will search binary files.
\-uu is equivalent to grep \-r, and \-uuu is equivalent to grep \-a \-r. \-uu is equivalent to grep \-r, and \-uuu is equivalent to grep \-a \-r.
.RS .RS
.PP
Note that the \-u flags are convenient aliases for other combinations of
flags.
\-u aliases \[aq]\-\-no\-ignore\[aq].
\-uu aliases \[aq]\-\-no\-ignore \-\-hidden\[aq].
\-uuu aliases \[aq]\-\-no\-ignore \-\-hidden \-\-text\[aq].
.RE .RE
.TP .TP
.B \-v, \-\-invert\-match .B \-v, \-\-invert\-match
@ -199,6 +205,15 @@ Show debug messages.
.RS .RS
.RE .RE
.TP .TP
.B \-E, \-\-encoding \f[I]ENCODING\f[]
Specify the text encoding that ripgrep will use on all files searched.
The default value is \[aq]auto\[aq], which will cause ripgrep to do a
best effort automatic detection of encoding on a per\-file basis.
Other supported values can be found in the list of labels here:
https://encoding.spec.whatwg.org/#concept\-encoding\-get
.RS
.RE
.TP
.B \-f, \-\-file FILE ... .B \-f, \-\-file FILE ...
Search for patterns from the given file, with one pattern per line. Search for patterns from the given file, with one pattern per line.
When this flag is used or multiple times or in combination with the When this flag is used or multiple times or in combination with the

View File

@ -89,6 +89,10 @@ Project home page: https://github.com/BurntSushi/ripgrep
-u flags will search binary files. -uu is equivalent to grep -r, and -uuu is -u flags will search binary files. -uu is equivalent to grep -r, and -uuu is
equivalent to grep -a -r. equivalent to grep -a -r.
Note that the -u flags are convenient aliases for other combinations of
flags. -u aliases '--no-ignore'. -uu aliases '--no-ignore --hidden'.
-uuu aliases '--no-ignore --hidden --text'.
-v, --invert-match -v, --invert-match
: Invert matching. : Invert matching.