Skip to content

Commit

Permalink
Add example to -r/--replace docs.
Browse files Browse the repository at this point in the history
Fixes #308
  • Loading branch information
BurntSushi committed Jan 10, 2017
1 parent a6a24ba commit 2143bcf
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
11 changes: 11 additions & 0 deletions doc/rg.1
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,17 @@ Neither this flag nor any other flag will modify your files.
.PP
Capture group indices (e.g., $5) and names (e.g., $foo) are supported in
the replacement string.
.PP
Note that the replacement by default replaces each match, and NOT the
entire line.
To replace the entire line, you should match the entire line.
For example, to emit only the first phone numbers in each line:
.IP
.nf
\f[C]
rg\ \[aq]^.*([0\-9]{3}\-[0\-9]{3}\-[0\-9]{4}).*$\[aq]\ \-\-replace\ \[aq]$1\[aq]
\f[]
.fi
.RE
.TP
.B \-s, \-\-case\-sensitive
Expand Down
6 changes: 6 additions & 0 deletions doc/rg.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,12 @@ Project home page: https://github.com/BurntSushi/ripgrep
Capture group indices (e.g., $5) and names (e.g., $foo) are supported
in the replacement string.

Note that the replacement by default replaces each match, and NOT the
entire line. To replace the entire line, you should match the entire line.
For example, to emit only the first phone numbers in each line:

rg '^.*([0-9]{3}-[0-9]{3}-[0-9]{4}).*$' --replace '$1'

-s, --case-sensitive
: Search case sensitively. This overrides --ignore-case and --smart-case.

Expand Down
5 changes: 4 additions & 1 deletion src/app.rs
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,10 @@ lazy_static! {
"Replace every match with the string given when printing \
results. Neither this flag nor any other flag will modify your \
files.\n\nCapture group indices (e.g., $5) and names \
(e.g., $foo) are supported in the replacement string.");
(e.g., $foo) are supported in the replacement string.\n\n\
Note that the replacement by default replaces each match, and \
NOT the entire line. To replace the entire line, you should \
match the entire line.");
doc!(h, "case-sensitive",
"Search case sensitively.",
"Search case sensitively. This overrides -i/--ignore-case and \
Expand Down

0 comments on commit 2143bcf

Please sign in to comment.