rust/ripgrep
1
0
Fork 0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-04-19 09:02:15 +02:00
Code Issues Releases Activity

doc: tweak wording for stdin detection

Browse Source 
This makes it slightly more precise to cover weird cases like trying to
pass a directory on stdin.

Closes #2906
This commit is contained in:
Andrew Gallant 2024-09-30 07:38:05 -04:00
parent bf63fe8f25
commit 79cbe89deb
No known key found for this signature in database
GPG Key ID: B2E3A4923F8B0D44
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
crates/core/flags/doc/template.rg.1
View File

@ -43,10 +43,10 @@ configuration file. The file can specify one shell argument per line. Lines
starting with \fB#\fP are ignored. For more details, see \fBCONFIGURATION starting with \fB#\fP are ignored. For more details, see \fBCONFIGURATION
FILES\fP below. FILES\fP below.
.sp .sp
ripgrep will automatically detect if stdin exists and search stdin for a regex ripgrep will automatically detect if stdin is a readable file and search stdin
pattern, e.g. \fBls | rg foo\fP. In some environments, stdin may exist when for a regex pattern, e.g. \fBls | rg foo\fP. In some environments, stdin may
it shouldn't. To turn off stdin detection, one can explicitly specify the exist when it shouldn't. To turn off stdin detection, one can explicitly
directory to search, e.g. \fBrg foo ./\fP. specify the directory to search, e.g. \fBrg foo ./\fP.
.sp .sp
Like other tools such as \fBls\fP, ripgrep will alter its output depending on Like other tools such as \fBls\fP, ripgrep will alter its output depending on
whether stdout is connected to a tty. By default, when printing a tty, ripgrep whether stdout is connected to a tty. By default, when printing a tty, ripgrep