diff options
| author | Andrew Gallant <jamslam@gmail.com> | 2017-08-23 19:14:27 -0400 |
|---|---|---|
| committer | Andrew Gallant <jamslam@gmail.com> | 2017-08-23 19:14:27 -0400 |
| commit | 398326bfe2f696b71d9a812b11868de12a57dcb7 (patch) | |
| tree | 6a414114a8a42be59f90307ba828f39fd572df88 /doc | |
| parent | 01358a155c284b839c09b4d7e96559d543eea904 (diff) | |
doc: note that ripgrep may terminate unexpectedly
Fixes #581
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rg.1 | 20 | ||||
| -rw-r--r-- | doc/rg.1.md | 4 |
2 files changed, 23 insertions, 1 deletions
@@ -29,6 +29,10 @@ time searching. Because of this, features like backreferences and arbitrary lookaround are not supported. .PP +Note that ripgrep may abort unexpectedly when using default settings if +it searches a file that is simultaneously truncated. +This behavior can be avoided by passing the \-\-no\-mmap flag. +.PP Project home page: https://github.com/BurntSushi/ripgrep .SH COMMON OPTIONS .TP @@ -45,7 +49,10 @@ Only show count of line matches for each file. .B \-\-color \f[I]WHEN\f[] Whether to use color in the output. Valid values are never, auto, always or ansi. -[default: auto] +The default is auto. +When always is used, coloring is attempted based on your environment. +When ansi is used, coloring is forcefully done using ANSI escape color +codes. .RS .RE .TP @@ -299,6 +306,17 @@ Search hidden directories and files. .RS .RE .TP +.B \-\-iglob \f[I]GLOB\f[] ... +Include or exclude files/directories case insensitively. +This always overrides any other ignore logic if there is a conflict, but +is otherwise applied in addition to ignore files (e.g., .gitignore or +\&.ignore). +Multiple glob flags may be used. +Globbing rules match .gitignore globs. +Precede a glob with a \[aq]!\[aq] to exclude it. +.RS +.RE +.TP .B \-\-ignore\-file \f[I]FILE\f[] ... Specify additional ignore files for filtering file paths. Ignore files should be in the gitignore format and are matched relative diff --git a/doc/rg.1.md b/doc/rg.1.md index 90e1dac7..56fb5858 100644 --- a/doc/rg.1.md +++ b/doc/rg.1.md @@ -25,6 +25,10 @@ ripgrep's regex engine uses finite automata and guarantees linear time searching. Because of this, features like backreferences and arbitrary lookaround are not supported. +Note that ripgrep may abort unexpectedly when using default settings if it +searches a file that is simultaneously truncated. This behavior can be avoided +by passing the --no-mmap flag. + Project home page: https://github.com/BurntSushi/ripgrep # COMMON OPTIONS |