diff options
| author | Dan Fabulich <dan.fabulich@redfin.com> | 2017-09-06 02:34:57 -0700 |
|---|---|---|
| committer | Andrew Gallant <jamslam@gmail.com> | 2017-09-06 08:25:05 -0400 |
| commit | beb010d004a79eedb8baa6f4eab21532e83a0ef0 (patch) | |
| tree | 189c4052ffbb8b86c3ae9592f4c95ba371906f5a /doc | |
| parent | f9cbf7d3d4febc44e7834003eec1f25498da111f (diff) | |
doc: clarify --with-filename behavior with --heading
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rg.1 | 5 | ||||
| -rw-r--r-- | doc/rg.1.md | 6 |
2 files changed, 8 insertions, 3 deletions
@@ -274,8 +274,11 @@ Only show path of each file with no matches. .RE .TP .B \-H, \-\-with\-filename -Prefix each match with the file name that contains it. +Display the file name for matches. This is the default when more than one file is searched. +If \-\-heading is enabled, the file name will be shown above clusters of +matches from each file; otherwise, the file name will be shown on each +match. .RS .RE .TP diff --git a/doc/rg.1.md b/doc/rg.1.md index 56fb5858..a069691e 100644 --- a/doc/rg.1.md +++ b/doc/rg.1.md @@ -182,8 +182,10 @@ Project home page: https://github.com/BurntSushi/ripgrep : Only show path of each file with no matches. -H, --with-filename -: Prefix each match with the file name that contains it. This is the - default when more than one file is searched. +: Display the file name for matches. This is the default when + more than one file is searched. If --heading is enabled, the + file name will be shown above clusters of matches from each + file; otherwise, the file name will be shown on each match. --no-filename : Never show the filename for a match. This is the default when |