]> git.ipfire.org Git - thirdparty/coreutils.git/commitdiff
doc: clarify the pr --page-width descriptions
authorPádraig Brady <P@draigBrady.com>
Tue, 29 Apr 2014 15:31:22 +0000 (16:31 +0100)
committerPádraig Brady <P@draigBrady.com>
Tue, 29 Apr 2014 18:33:41 +0000 (19:33 +0100)
* doc/coreutils.texi (pr invocation): Clarify that -w or -W
will be rounded down so that each column has the same width.
Adjust the wording for -W, to avoid the implication that the
width of -S is insignificant to the page width.
* src/pr.c (usage): Add a period to avoid ambiguity in
the man page output.

doc/coreutils.texi
src/pr.c

index b21a4fd83b5fd5cf616af1c2a2580e33b9a1186e..12002fcd496abe46b965b94ecedd45e4894e4821 100644 (file)
@@ -2878,8 +2878,10 @@ Print nonprinting characters in octal backslash notation.
 @opindex -w
 @opindex --width
 Set page width to @var{page_width} characters for multiple text-column
-output only (default for @var{page_width} is 72).  @option{-s[CHAR]} turns
-off the default page width and any line truncation and column alignment.
+output only (default for @var{page_width} is 72).  The specified
+@var{page_width} is rounded down so that columns have equal width.
+@option{-s[CHAR]} turns off the default page width and any line truncation
+and column alignment.
 Lines of full length are merged, regardless of the column options
 set.  No @var{page_width} setting is possible with single column output.
 A POSIX-compliant formulation.
@@ -2888,12 +2890,13 @@ A POSIX-compliant formulation.
 @itemx --page_width=@var{page_width}
 @opindex -W
 @opindex --page_width
-Set the page width to @var{page_width} characters.  That's valid with and
-without a column option.  Text lines are truncated, unless @option{-J}
-is used.  Together with one of the three column options
+Set the page width to @var{page_width} characters, honored with and
+without a column option.  With a column option, the specified @var{page_width}
+is rounded down so that columns have equal width.  Text lines are truncated,
+unless @option{-J} is used. Together with one of the three column options
 (@option{-@var{column}}, @option{-a -@var{column}} or @option{-m}) column
 alignment is always used.  The separator options @option{-S} or @option{-s}
-don't affect the @option{-W} option.  Default is 72 characters.  Without
+don't disable the @option{-W} option.  Default is 72 characters.  Without
 @option{-W @var{page_width}} and without any of the column options NO line
 truncation is used (defined to keep downward compatibility and to meet
 most frequent tasks).  That's equivalent to @option{-W 72 -J}@.  The header
index 3f9d1deae2cf261dd2bbcb869820a5b3f81b4233..1515b4a473eee02698accf5eeebfcfa6deb0be2e 100644 (file)
--- a/src/pr.c
+++ b/src/pr.c
@@ -2820,7 +2820,8 @@ Paginate or columnate FILE(s) for printing.\n\
       fputs (_("\
   -s[CHAR], --separator[=CHAR]\n\
                     separate columns by a single character, default for CHAR\n\
-                    is the <TAB> character without -w and \'no char\' with -w\n\
+                    is the <TAB> character without -w and \'no char\' with -w.\
+\n\
                     -s[CHAR] turns off line truncation of all 3 column\n\
                     options (-COLUMN|-a -COLUMN|-m) except -w is set\n\
 "), stdout);