Re: Changes to grep/doc/grep.1

[Charles Levert]

* On Wednesday 2005-11-09 at 20:00:55 +0100, Benno Schulenberg wrote:
> But really I prefer the old way:
> 
>   *grep* searches through files...
> 
> >  For example, the shell command
> > -.B "egrep '{1'"
> > +.B "grep\ \-E\ '{1'"
> 
> Hmm, "shell command"?  Better simply "command" here.

Here is a tentative patch.  Please search
through both files and try to find any remaining
similar formulations that I may have missed,
so that the situation can be fully handled with
a single commit.



Index: grep/ChangeLog
===================================================================
RCS file: /cvsroot/grep/grep/ChangeLog,v
retrieving revision 1.278
diff -u -r1.278 ChangeLog
--- grep/ChangeLog      9 Nov 2005 20:04:40 -0000       1.278
+++ grep/ChangeLog      9 Nov 2005 21:23:44 -0000
@@ -5,6 +5,10 @@
          detect errors, for portability with other POSIX-compliant
          implementations.
 
+       * doc/grep.1, doc/grep.texi: Use just "grep" instead of
+         "the grep command", unless an example command really follows.
+         Use just "command" instead of "shell command".
+
 2005-11-09  Charles Levert  <address@hidden>
 
        The following set of changes aims to make "egrep" and "fgrep"
Index: grep/doc/grep.1
===================================================================
RCS file: /cvsroot/grep/grep/doc/grep.1,v
retrieving revision 1.36
diff -u -r1.36 grep.1
--- grep/doc/grep.1     9 Nov 2005 20:04:41 -0000       1.36
+++ grep/doc/grep.1     9 Nov 2005 21:23:56 -0000
@@ -32,9 +32,8 @@
 .RI [ FILE .\|.\|.]
 .SH DESCRIPTION
 .PP
-The
 .B grep
-command searches the named input
+searches the named input
 .IR FILE s
 (or standard input if no files are named, or
 the file name
@@ -471,9 +470,8 @@
 Regular expressions are constructed analogously to arithmetic
 expressions, by using various operators to combine smaller expressions.
 .PP
-The
 .B grep
-command understands two different versions of regular expression syntax:
+understands two different versions of regular expression syntax:
 \*(lqbasic\*(rq and \*(lqextended.\*(rq  In
 .RB "\s-1GNU\s0\ " grep ,
 there is no difference in available functionality using either syntax.
@@ -683,7 +681,7 @@
 attempts to support traditional usage by assuming that
 .B {
 is not special if it would be the start of an invalid interval
-specification.  For example, the shell command
+specification.  For example, the command
 .B "grep\ \-E\ '{1'"
 searches for the two-character string
 .B {1
Index: grep/doc/grep.texi
===================================================================
RCS file: /cvsroot/grep/grep/doc/grep.texi,v
retrieving revision 1.59
diff -u -r1.59 grep.texi
--- grep/doc/grep.texi  9 Nov 2005 20:04:41 -0000       1.59
+++ grep/doc/grep.texi  9 Nov 2005 21:24:02 -0000
@@ -89,7 +89,7 @@
 @node Top
 @top grep
 
-The @command{grep} command searches for lines matching a pattern.
address@hidden searches for lines matching a pattern.
 
 This document was produced for version @value{VERSION} of @sc{gnu}
 @command{grep}.
@@ -115,7 +115,7 @@
 
 @cindex Searching for a pattern.
 
-The @command{grep} command searches the input files
address@hidden searches the input files
 for lines containing a match to a given
 pattern list.  When it finds a match in a line, it copies the line to standard
 output (by default), or does whatever other sort of output you have requested
@@ -717,7 +717,7 @@
 @node grep Programs
 @chapter @command{grep} programs
 
-The @command{grep} command searches the named input files
address@hidden searches the named input files
 (or standard input if no files are named,
 or the file name @file{-} is given)
 for lines containing a match to the given pattern.
@@ -1061,7 +1061,7 @@
 
 @sc{gnu} @command{grep@ -E} attempts to support traditional usage by
 assuming that @address@hidden is not special if it would be the start of an
-invalid interval specification.  For example, the shell command
+invalid interval specification.  For example, the command
 @samp{grep@ -E@ '@{1'} searches for the two-character string @address@hidden
 instead of reporting a syntax error in the regular expression.
 @sc{posix.2} allows this behavior as an extension, but portable scripts
@@ -1071,7 +1071,7 @@
 @chapter Usage
 
 @cindex Usage, examples
-Here is an example shell command that invokes @sc{gnu} @command{grep}:
+Here is an example command that invokes @sc{gnu} @command{grep}:
 
 @example
 grep -i 'hello.*world' menu.h main.c