diff options
| author | Andrew Gallant <jamslam@gmail.com> | 2016-09-24 18:55:48 -0400 |
|---|---|---|
| committer | Andrew Gallant <jamslam@gmail.com> | 2016-09-24 18:55:48 -0400 |
| commit | 9ce0484670c9d63c5ac16bb52d2fa026c58e7a37 (patch) | |
| tree | fddfeab35733298ddb630a5bb086df27452745e6 /doc | |
| parent | 346bad7dfcceea62e27dba8110ac470fc52ff9bf (diff) | |
Clarify the documentation of the --type-* flags.
Fixes #15
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rg.1 | 9 | ||||
| -rw-r--r-- | doc/rg.1.md | 8 |
2 files changed, 13 insertions, 4 deletions
@@ -254,11 +254,16 @@ Show all supported file types and their associated globs. .TP .B \-\-type\-add \f[I]ARG\f[] ... Add a new glob for a particular file type. -Example: \-\-type\-add html:\f[I]\&.html,\f[].htm +Note that this must be passed to every invocation of rg. .RS .RE +.PP +Example: \-\-type\-add html:\f[I]\&.html,\f[].htm .TP .B \-\-type\-clear \f[I]TYPE\f[] ... -Clear the file type globs for TYPE. +Clear the file type globs previously defined for TYPE. +This only clears the default type definitions that are found inside of +ripgrep. +Note that this must be passed to every invocation of rg. .RS .RE diff --git a/doc/rg.1.md b/doc/rg.1.md index 224ff1a9..028d3a57 100644 --- a/doc/rg.1.md +++ b/doc/rg.1.md @@ -164,8 +164,12 @@ the raw speed of grep. : Show all supported file types and their associated globs. --type-add *ARG* ... -: Add a new glob for a particular file type. +: Add a new glob for a particular file type. Note that this must be + passed to every invocation of rg. + Example: --type-add html:*.html,*.htm --type-clear *TYPE* ... -: Clear the file type globs for TYPE. +: Clear the file type globs previously defined for TYPE. This only clears + the default type definitions that are found inside of ripgrep. Note + that this must be passed to every invocation of rg. |