[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 03/11: groff_man*(7): Clarify \n[FT], .BT, .PT.
From: |
G. Branden Robinson |
Subject: |
[groff] 03/11: groff_man*(7): Clarify \n[FT], .BT, .PT. |
Date: |
Mon, 17 May 2021 23:02:47 -0400 (EDT) |
gbranden pushed a commit to branch master
in repository groff.
commit 45778d8672fd1a208d6f8cd01923d36394064667
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Mon May 17 11:02:11 2021 +1000
groff_man*(7): Clarify \n[FT], .BT, .PT.
* <BT, PT>: Characterize what a typical definition would look like.
Emphasize that these macros handle header and footer "text", in
distinction to all the other environment and trap rigamarole that an
experienced *roff user might suspect is involved.
* <FT>: Document that register is ignored when continuously rendering.
---
tmac/groff_man.7.man.in | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in
index e078820..61e7b52 100644
--- a/tmac/groff_man.7.man.in
+++ b/tmac/groff_man.7.man.in
@@ -2605,16 +2605,19 @@ Because these macros are hooks for
internals,
man pages have no reason to call them.
.
+A macro definition for these hooks typically consists of a \[lq].tl\[rq]
+request.
+.
.
.TP
.B .BT
-Set the page footer
+Set the page footer text
(\(lqbottom trap\(rq).
.
.
.TP
.B .PT
-Set the page header
+Set the page header text
(\(lqpage trap\(rq).
.
.
@@ -2981,6 +2984,8 @@ relative to the bottom of the page if negative or top if
positive,
to
.IR footer-distance .
.
+Ignored if continuous rendering is enabled.
+.
The default is \-0.5i.
.
.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 03/11: groff_man*(7): Clarify \n[FT], .BT, .PT.,
G. Branden Robinson <=