1
0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-01-08 13:23:34 +02:00

Clarify use of --heading/--no-heading.

Fixes #247.
This commit is contained in:
Andrew Gallant 2016-11-28 17:39:45 -05:00
parent 08514e8e6c
commit d12bdf35a5
3 changed files with 16 additions and 8 deletions

View File

@ -222,13 +222,17 @@ This is the default when one file is searched.
.RE
.TP
.B \-\-heading
Show the file name above clusters of matches from each file.
Show the file name above clusters of matches from each file instead of
showing the file name for every match.
This is the default mode at a tty.
.RS
.RE
.TP
.B \-\-no\-heading
Don\[aq]t show any file name heading.
Don\[aq]t group matches by each file.
If \-H/\-\-with\-filename is enabled, then file names will be shown for
every line matched.
This is the default more when not at a tty.
.RS
.RE
.TP

View File

@ -147,11 +147,13 @@ Project home page: https://github.com/BurntSushi/ripgrep
one file is searched.
--heading
: Show the file name above clusters of matches from each file.
This is the default mode at a tty.
: Show the file name above clusters of matches from each file instead of
showing the file name for every match. This is the default mode at a tty.
--no-heading
: Don't show any file name heading.
: Don't group matches by each file. If -H/--with-filename is enabled, then
file names will be shown for every line matched. This is the default more
when not at a tty.
--hidden
: Search hidden directories and files. (Hidden directories and files are

View File

@ -338,11 +338,13 @@ lazy_static! {
doc!(h, "heading",
"Show matches grouped by each file.",
"This shows the file name above clusters of matches from each \
file. This is the default mode at a tty.");
file instead of showing the file name for every match. This is \
the default mode at a tty.");
doc!(h, "no-heading",
"Don't group matches by each file.",
"Don't group matches by each file. This is the default mode \
when not at a tty.");
"Don't group matches by each file. If -H/--with-filename is \
enabled, then file names will be shown for every line matched. \
This is the default mode when not at a tty.");
doc!(h, "hidden",
"Search hidden files and directories.",
"Search hidden files and directories. By default, hidden files \