doc: clarify --with-filename behavior with --heading

2017-09-06 02:34:57 -07:00
parent f9cbf7d3d4
commit beb010d004
4 changed files with 13 additions and 6 deletions
--- a/doc/rg.1
+++ b/doc/rg.1
@@ -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