summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2016-12-12 07:03:37 -0500
committerAndrew Gallant <jamslam@gmail.com>2016-12-12 07:03:37 -0500
commit8396d3ffaae3784880a6cef25775ba2abd9f4fcf (patch)
tree89773e783cd53e894ed0bb4fd88ac7b2193cd8ac /doc
parent652c70f207ccfd859055c0bde09cbd6cc4a3d263 (diff)
Make backreference support clear.
Fixes #268.
Diffstat (limited to 'doc')
-rw-r--r--doc/rg.15
-rw-r--r--doc/rg.1.md4
2 files changed, 9 insertions, 0 deletions
diff --git a/doc/rg.1 b/doc/rg.1
index d1f2174f..b6ea695c 100644
--- a/doc/rg.1
+++ b/doc/rg.1
@@ -24,6 +24,11 @@ rg [\f[I]options\f[]] \-\-version
ripgrep (rg) combines the usability of The Silver Searcher (an ack
clone) with the raw speed of grep.
.PP
+ripgrep\[aq]s regex engine uses finite automata and guarantees linear
+time searching.
+Because of this, features like backreferences and arbitrary lookaround
+are not supported.
+.PP
Project home page: https://github.com/BurntSushi/ripgrep
.SH COMMON OPTIONS
.TP
diff --git a/doc/rg.1.md b/doc/rg.1.md
index f0fed3da..466a3539 100644
--- a/doc/rg.1.md
+++ b/doc/rg.1.md
@@ -21,6 +21,10 @@ rg [*options*] --version
ripgrep (rg) combines the usability of The Silver Searcher (an ack clone) with
the raw speed of grep.
+ripgrep's regex engine uses finite automata and guarantees linear time
+searching. Because of this, features like backreferences and arbitrary
+lookaround are not supported.
+
Project home page: https://github.com/BurntSushi/ripgrep
# COMMON OPTIONS