[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
patch for minor documentation errors
From: |
Dave Kemper |
Subject: |
patch for minor documentation errors |
Date: |
Sat, 21 Sep 2013 04:23:39 -0500 |
Below is a patch to fix some minor errors in the groff documentation.
I created this patch against the 1.22.2 release. What it fixes:
- The man page's descriptions of .tm and .tm1 say they send text to
stdout; in fact, they both use stderr, as the info manual documents.
- The documentation for the -me macro .$H says it is "called at the
top of each page"; it is actually called at the top of each column.
- The info manual example for the dn and dl registers concludes with both
a .rr @s and a .rm @s. The latter is unnecessary because the example code
never defined @s as a macro, diversion, or string, only as a register.
I also see that my previous documentation patch, which
I submitted in Dec 2011, is not in the 1.22.2 code. (See
http://lists.gnu.org/archive/html/groff/2011-12/msg00053.html for
details.) Was there a problem with this patch?
--- doc/groff.info-2.orig 2013-02-07 06:06:21.000000000 -0600
+++ doc/groff.info-2 2013-09-21 03:50:28.000000000 -0500
@@ -1391,7 +1391,6 @@
. br
. fi
. rr @s
- . rm @s
. rm @c
..
.\" End of macro definitions, restore escape mechanism
--- doc/meref.me.orig 2013-02-07 06:06:11.000000000 -0600
+++ doc/meref.me 2013-09-21 03:47:21.000000000 -0500
@@ -714,11 +714,12 @@
(after putting out
the header,
initial saved floating keeps,
-etc.);
+etc.),
+or each column when in two-column mode;
in other words,
this macro is called immediately before
printing text
-on a page.
+on a page or in a column.
It can be used for column headings
and the like.
.sh 1 "Displays"
--- man/groff.man.orig 2013-02-07 06:06:08.000000000 -0600
+++ man/groff.man 2013-09-21 03:39:16.000000000 -0500
@@ -2397,13 +2397,13 @@
.REQ .tm "anything"
Print
.I anything
-on stdout.
+on stderr.
.
.TPx
.REQ .tm1 "anything"
Print
.I anything
-on stdout, allowing leading whitespace if
+on stderr, allowing leading whitespace if
.I anything
starts with
\&\f[CB]\[dq]\f[]
@@ -2548,7 +2548,7 @@
for an overview) or from a preprocessor.
.
.P
-Preprocessor macros are easy to be recognized.
+Preprocessor macros are easily recognized.
.
They enclose their code into a pair of characteristic macros.
.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- patch for minor documentation errors,
Dave Kemper <=