[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 12/37: doc/groff.texi: Finish(?) fixing Savannah #58035.
From: |
G. Branden Robinson |
Subject: |
[groff] 12/37: doc/groff.texi: Finish(?) fixing Savannah #58035. |
Date: |
Mon, 14 Mar 2022 01:59:08 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 6cdb2a543810a2bb2eca2d9c60e03b84d20e8649
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon Mar 7 13:35:47 2022 +1100
doc/groff.texi: Finish(?) fixing Savannah #58035.
* doc/groff.texi (Manipulating Filling and Adjustment): Explicitly
identify the page offset as an output line property that is not
determined until a break occurs.
(Line Layout) <po>: Correct error; the page offset for terminal
devices is set by "tty.tmac", not "troffrc". (The manual has been
wrong for a long time; we've had it in tty.tmac since James Clark put
it there in 1992.) Recast and tighten wording. Drop the word
"horizontal"; there is no vertical page offset (as such) in *roff.
Drop hand-waving about unexpected results with a description of the
formatter's behavior. Dcoument request behavior without an argument
before getting into the weeds (and CSTR #54 errata). Migrate
terminology from "scaling indicator" to "scaling unit".
Fixes <https://savannah.gnu.org/bugs/?58035> [with crossed fingers].
---
ChangeLog | 19 +++++++++++++++++++
doc/groff.texi | 31 ++++++++++++++-----------------
2 files changed, 33 insertions(+), 17 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 9c7ed9c8..c6f52e5c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,22 @@
+2022-03-07 G. Branden Robinson <g.branden.robinson@gmail.com>
+
+ * doc/groff.texi (Manipulating Filling and Adjustment):
+ Explicitly identify the page offset as an output line property
+ that is not determined until a break occurs.
+
+ (Line Layout) <po>: Correct error; the page offset for terminal
+ devices is set by "tty.tmac", not "troffrc". (The manual has
+ been wrong for a long time; we've had it in tty.tmac since James
+ Clark put it there in 1992.) Recast and tighten wording. Drop
+ the word "horizontal"; there is no vertical page offset (as
+ such) in *roff. Drop hand-waving about unexpected results with
+ a description of the formatter's behavior. Dcoument request
+ behavior without an argument before getting into the weeds (and
+ CSTR #54 errata). Migrate terminology from "scaling indicator"
+ to "scaling unit".
+
+ Fixes <https://savannah.gnu.org/bugs/?58035>.
+
2022-03-07 G. Branden Robinson <g.branden.robinson@gmail.com>
* src/roff/troff/input.cpp: Trivially refactor. Drop `#define`
diff --git a/doc/groff.texi b/doc/groff.texi
index ae6d8b86..82374433 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -7387,9 +7387,9 @@ This line returns to normal filling and adjustment.
@noindent
@cindex pending output line
@cindex partially collected line
-Output line properties like adjustment and indentation are not
-determined until the line has been broken. An output line is said to be
-@dfn{pending} if some input has been collected but an output line
+Output line properties like page offset, indentation, and adjustment are
+not determined until the line has been broken. An output line is said
+to be @dfn{pending} if some input has been collected but an output line
corresponding to it has not yet been written; such an output line is
also termed @dfn{partially collected}. If no output line is pending, it
is as if a break has already happened; additional breaks, whether
@@ -9127,23 +9127,20 @@ ous values.
@DefreqItem {po, @t{+}@Var{offset}}
@DefreqItem {po, @t{-}@Var{offset}}
@DefregListEndx {.o}
-@pindex troffrc
-Set horizontal page offset to @var{offset} (or increment or decrement
-the current value by @var{offset}). This request does not cause a
-break, so changing the page offset in the middle of text being filled
-may not yield the expected result. The initial value is 1@dmn{i}.
-For terminal output devices, it is set to 0 in the startup file
-@file{troffrc}; the default scaling indicator is @samp{m}.
+@pindex tty.tmac
+Set page offset to @var{offset} (or increment or decrement its current
+value by @var{offset}). If invoked without an argument, the page offset
+is restored to the value before the previous @code{po} request.
+This request does not cause a break; the page offset in effect when an
+output line is broken prevails (@pxref{Manipulating Filling and
+Adjustment}). The initial value is 1@dmn{i} and the default scaling
+unit is @samp{m}. On terminal devices, the page offset is set to zero
+by a driver-specific macro file, @file{tty.tmac}. The current page
+offset can be found in the read-only register @samp{.o}.
@cindex CSTR@tie{}#54 errata
@cindex CSTR@tie{}#54 erratum, @code{po} request
This request is incorrectly documented in the @acronym{AT&T}
-@code{troff} manual as having a default scaling indicator of @samp{v}.
-
-The current page offset can be found in the read-only register
-@samp{.o}.
-
-If @code{po} is called without an argument, the page offset is reset to
-the previous value before the last call to @code{po}.
+@code{troff} manual as using a default scaling unit of @samp{v}.
@Example
.po 3i
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 12/37: doc/groff.texi: Finish(?) fixing Savannah #58035.,
G. Branden Robinson <=