1
0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-03-03 14:32:22 +02:00

doc: improve docs for --replace flag

Specifically, we document shell-specific caveats related to the `--replace`
flag.

PR #1318
This commit is contained in:
Hugo Locurcio 2019-07-04 17:42:35 +02:00 committed by Andrew Gallant
parent 785c1f1766
commit 8ebc113847

View File

@ -2171,7 +2171,10 @@ Replace every match with the text given when printing results. Neither this
flag nor any other ripgrep flag will modify your files.
Capture group indices (e.g., $5) and names (e.g., $foo) are supported in the
replacement string.
replacement string. In shells such as Bash and zsh, you should wrap the
pattern in single quotes instead of double quotes. Otherwise, capture group
indices will be replaced by expanded shell variables which will most likely
be empty.
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.