bug-grep
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: change in -r behavior needs manpage update


From: Paul Eggert
Subject: Re: change in -r behavior needs manpage update
Date: Thu, 26 Jul 2012 12:18:46 -0700
User-agent: Mozilla/5.0 (X11; Linux i686; rv:14.0) Gecko/20120714 Thunderbird/14.0

For the savannah problem I have filed a bug report here,
which you're welcome to follow and/or add to:

http://savannah.gnu.org/support/index.php?108097

For grep, I pushed the following patch to the man page; thanks
for reporting it.

>From 9d6393058cc9576e4279709283f38740f0e45250 Mon Sep 17 00:00:00 2001
From: Paul Eggert <address@hidden>
Date: Thu, 26 Jul 2012 12:07:12 -0700
Subject: [PATCH] doc: document -r/-R in man page

* doc/grep.in.1: Document -r vs. -R.
---
 doc/grep.in.1 |   27 ++++++++++++++++++---------
 1 files changed, 18 insertions(+), 9 deletions(-)

diff --git a/doc/grep.in.1 b/doc/grep.in.1
index 4cf1f17..4bf03b4 100644
--- a/doc/grep.in.1
+++ b/doc/grep.in.1
@@ -475,19 +475,19 @@ By default,
 .I ACTION
 is
 .BR read ,
-which means that directories are read just as if they were ordinary files.
+i.e., read directories just as if they were ordinary files.
 If
 .I ACTION
 is
 .BR skip ,
-directories are silently skipped.
+silently skip directories.
 If
 .I ACTION
 is
 .BR recurse ,
-.B grep
-reads all files under each directory, recursively;
-this is equivalent to the
+read all files under each directory, recursively,
+following symbolic links only if they are on the command line.
+This is equivalent to the
 .B \-r
 option.
 .TP
@@ -527,11 +527,16 @@ Search only files whose base name matches
 (using wildcard matching as described under
 .BR \-\^\-exclude ).
 .TP
-.BR \-R ", " \-r ", " \-\^\-recursive
-Read all files under each directory, recursively;
-this is equivalent to the
+.BR \-r ", " \-\^\-recursive
+Read all files under each directory, recursively,
+following symbolic links only if they are on the command line.
+This is equivalent to the
 .B "\-d recurse"
 option.
+.BR \-R ", " \-\^\-dereference\-recursive
+Read all files under each directory, recursively.
+Follow all symbolic links, unlike
+.BR \-r .
 .SS "Other Options"
 .TP
 .BR \-\^\-line\-buffered
@@ -1216,7 +1221,8 @@ grep(1p).
 .SS "\*(Txinfo Documentation"
 The full documentation for
 .B grep
-is maintained as a \*(Txinfo manual.
+is maintained as a \*(Txinfo manual,
+which you can read at http://www.gnu.org/software/grep/manual/.
 If the
 .B info
 and
@@ -1228,6 +1234,9 @@ programs are properly installed at your site, the command
 should give you access to the complete manual.
 .
 .SH NOTES
+This man page is maintained only fitfully;
+the full documentation is often more up-to-date.
+.PP
 \s-1GNU\s0's not Unix, but Unix is a beast;
 its plural form is Unixen.
 .\" Work around problems with some troff -man implementations.
-- 
1.7.6.5





reply via email to

[Prev in Thread] Current Thread [Next in Thread]