summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2017-03-12 20:24:45 -0400
committerAndrew Gallant <jamslam@gmail.com>2017-03-12 20:24:45 -0400
commitf0d3cae56963a912a6e50bc7c4d11416e4ef4989 (patch)
tree7b5d5339228a88dddb7de486791e685c263053e6
parent4ef481813084b83e04ece4ed44ccb38b49f7e817 (diff)
Clarify -u/--unrestricted flags.
Fixes #340
-rw-r--r--doc/rg.115
-rw-r--r--doc/rg.1.md4
2 files changed, 19 insertions, 0 deletions
diff --git a/doc/rg.1 b/doc/rg.1
index 1b66f2a2..de0d5910 100644
--- a/doc/rg.1
+++ b/doc/rg.1
@@ -127,6 +127,12 @@ Two \-u flags will search hidden files and directories.
Three \-u flags will search binary files.
\-uu is equivalent to grep \-r, and \-uuu is equivalent to grep \-a \-r.
.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
.TP
.B \-v, \-\-invert\-match
@@ -199,6 +205,15 @@ Show debug messages.
.RS
.RE
.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 ...
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
diff --git a/doc/rg.1.md b/doc/rg.1.md
index 7c49eb72..fce63c56 100644
--- a/doc/rg.1.md
+++ b/doc/rg.1.md
@@ -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
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
: Invert matching.