1
0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-01-19 05:49:14 +02:00

Make backreference support clear.

Fixes #268.
This commit is contained in:
Andrew Gallant 2016-12-12 07:03:37 -05:00
parent 652c70f207
commit 8396d3ffaa
4 changed files with 23 additions and 4 deletions

View File

@ -1,9 +1,15 @@
ripgrep (rg) ripgrep (rg)
------------ ------------
`ripgrep` is a command line search tool that combines the usability of The `ripgrep` is a line oriented search tool that combines the usability of The
Silver Searcher (an `ack` clone) with the raw speed of GNU grep. `ripgrep` has Silver Searcher (an `ack` clone) with the raw speed of GNU grep. `ripgrep`
first class support on Windows, Mac and Linux, with binary downloads available works by recursively searching your current directory for a regex pattern.
for [every release](https://github.com/BurntSushi/ripgrep/releases). `ripgrep` has first class support on Windows, Mac and Linux, with binary
downloads available for
[every release](https://github.com/BurntSushi/ripgrep/releases).
ripgrep's regex engine uses finite automata and guarantees linear time
searching. Because of this, features like backreferences and arbitrary
lookaround are not supported.
[![Linux build status](https://travis-ci.org/BurntSushi/ripgrep.svg?branch=master)](https://travis-ci.org/BurntSushi/ripgrep) [![Linux build status](https://travis-ci.org/BurntSushi/ripgrep.svg?branch=master)](https://travis-ci.org/BurntSushi/ripgrep)
[![Windows build status](https://ci.appveyor.com/api/projects/status/github/BurntSushi/ripgrep?svg=true)](https://ci.appveyor.com/project/BurntSushi/ripgrep) [![Windows build status](https://ci.appveyor.com/api/projects/status/github/BurntSushi/ripgrep?svg=true)](https://ci.appveyor.com/project/BurntSushi/ripgrep)

View File

@ -24,6 +24,11 @@ rg [\f[I]options\f[]] \-\-version
ripgrep (rg) combines the usability of The Silver Searcher (an ack ripgrep (rg) combines the usability of The Silver Searcher (an ack
clone) with the raw speed of grep. clone) with the raw speed of grep.
.PP .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 Project home page: https://github.com/BurntSushi/ripgrep
.SH COMMON OPTIONS .SH COMMON OPTIONS
.TP .TP

View File

@ -21,6 +21,10 @@ rg [*options*] --version
ripgrep (rg) combines the usability of The Silver Searcher (an ack clone) with ripgrep (rg) combines the usability of The Silver Searcher (an ack clone) with
the raw speed of grep. 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 Project home page: https://github.com/BurntSushi/ripgrep
# COMMON OPTIONS # COMMON OPTIONS

View File

@ -5,6 +5,10 @@ use clap::{App, AppSettings, Arg, ArgSettings};
const ABOUT: &'static str = " const ABOUT: &'static str = "
ripgrep (rg) recursively searches your current directory for a regex pattern. ripgrep (rg) recursively searches your current directory for a regex pattern.
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 Project home page: https://github.com/BurntSushi/ripgrep
Use -h for short descriptions and --help for more details."; Use -h for short descriptions and --help for more details.";