Clarify documentation for --replace.

Also add a minor clarification for --type-add.

Fixes #147

3 files changed, 35 insertions, 21 deletions

diff --git a/doc/rg.1 b/doc/rg.1
index edcc25ad..c0a32b0a 100644
--- a/doc/rg.1
+++ b/doc/rg.1
@@ -91,12 +91,6 @@ If a match is found in a file, stop searching that file.
 .RS
 .RE
 .TP
-.B \-r, \-\-replace \f[I]ARG\f[]
-Replace every match with the string given.
-Capture group indices (e.g., $5) and names (e.g., $foo) are supported.
-.RS
-.RE
-.TP
 .B \-t, \-\-type \f[I]TYPE\f[] ...
 Only search files matching TYPE.
 Multiple type flags may be provided.
@@ -259,6 +253,15 @@ Alias for \-\-color=always \-\-heading \-n.
 .RS
 .RE
 .TP
+.B \-r, \-\-replace \f[I]ARG\f[]
+Replace every match with the string given when printing search results.
+Neither this flag nor any other flag will modify your files.
+.RS
+.PP
+Capture group indices (e.g., $5) and names (e.g., $foo) are supported in
+the replacement string.
+.RE
+.TP
 .B \-s, \-\-case\-sensitive
 Search case sensitively.
 This overrides \-\-ignore\-case and \-\-smart\-case.
@@ -305,10 +308,12 @@ Multiple \-\-type\-add flags can be provided.
 Unless \-\-type\-clear is used, globs are added to any existing globs
 inside of ripgrep.
 Note that this must be passed to every invocation of rg.
+Type settings are NOT persisted.
 .RS
-.RE
 .PP
-Example: \f[C]\-\-type\-add\ html:*.html\f[]
+Example:
+\f[C]rg\ \-\-type\-add\ \[aq]foo:*.foo\[aq]\ \-tfoo\ PATTERN\f[]
+.RE
 .TP
 .B \-\-type\-clear \f[I]TYPE\f[] ...
 Clear the file type globs previously defined for TYPE.
diff --git a/doc/rg.1.md b/doc/rg.1.md
index 6de16e53..0dd4e88b 100644
--- a/doc/rg.1.md
+++ b/doc/rg.1.md
@@ -61,10 +61,6 @@ the raw speed of grep.
 : Do not print anything to stdout. If a match is found in a file, stop
   searching that file.
 
--r, --replace *ARG*
-: Replace every match with the string given. Capture group indices (e.g., $5)
-  and names (e.g., $foo) are supported.
-
 -t, --type *TYPE* ...
 : Only search files matching TYPE. Multiple type flags may be provided. Use the
   --type-list flag to list all available types.
@@ -168,6 +164,13 @@ the raw speed of grep.
 -p, --pretty
 : Alias for --color=always --heading -n.
 
+-r, --replace *ARG*
+: Replace every match with the string given when printing search results.
+  Neither this flag nor any other flag will modify your files.
+
+    Capture group indices (e.g., $5) and names (e.g., $foo) are supported
+    in the replacement string.
+
 -s, --case-sensitive
 : Search case sensitively. This overrides --ignore-case and --smart-case.
 
@@ -197,9 +200,10 @@ the raw speed of grep.
 : Add a new glob for a particular file type. Only one glob can be added
   at a time. Multiple --type-add flags can be provided. Unless --type-clear
   is used, globs are added to any existing globs inside of ripgrep. Note that
-  this must be passed to every invocation of rg.
+  this must be passed to every invocation of rg. Type settings are NOT
+  persisted.
 
-  Example: `--type-add html:*.html`
+      Example: `rg --type-add 'foo:*.foo' -tfoo PATTERN`
 
 --type-clear *TYPE* ...
 : Clear the file type globs previously defined for TYPE. This only clears
diff --git a/src/args.rs b/src/args.rs
index 6ee30e7f..ba6235f0 100644
--- a/src/args.rs
+++ b/src/args.rs
@@ -68,9 +68,6 @@ Common options:
     -N, --no-line-number       Suppress line numbers.
     -q, --quiet                Do not print anything to stdout. If a match is
                                found in a file, stop searching that file.
-    -r, --replace ARG          Replace every match with the string given.
-                               Capture group indices (e.g., $5) and names
-                               (e.g., $foo) are supported.
     -t, --type TYPE ...        Only search files matching TYPE. Multiple type
                                flags may be provided. Use the --type-list flag
                                to list all available types.
@@ -169,6 +166,13 @@ Less common options:
     -p, --pretty
         Alias for --color=always --heading -n.
 
+    -r, --replace ARG
+        Replace every match with the string given when printing search results.
+        Neither this flag nor any other flag will modify your files.
+
+        Capture group indices (e.g., $5) and names (e.g., $foo) are supported
+        in the replacement string.
+
     -s, --case-sensitive
         Search case sensitively. This overrides --ignore-case and --smart-case.
 
@@ -194,10 +198,11 @@ File type management options:
         Show all supported file types and their associated globs.
 
     --type-add ARG ...
-        Add a new glob for a particular file type. Only one glob can be added
-        at a time. Multiple type-add flags can be provided. Unless type-clear
-        is used, globs are added to any existing globs inside of ripgrep. Note
-        that this must be passed to every invocation of rg.
+        Add a new glob for a particular file type. Only one glob can be
+        added at a time. Multiple --type-add flags can be provided. Unless
+        --type-clear is used, globs are added to any existing globs inside of
+        ripgrep. Note that this must be passed to every invocation of rg. Type
+        settings are NOT persisted.
 
         Example: `--type-add html:*.html`