groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 01/01: groff_man(7): Fix errors in footer description.


From: G. Branden Robinson
Subject: [groff] 01/01: groff_man(7): Fix errors in footer description.
Date: Thu, 16 Jan 2020 07:36:51 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 0a243ee97d801609afb41807aaf764d135d1a6d1
Author: G. Branden Robinson <address@hidden>
AuthorDate: Thu Jan 16 23:28:27 2020 +1100

    groff_man(7): Fix errors in footer description.
    
    After my previous fix, I wondered, "yeah, but aren't page numbers
    generally toward the edge of the page in bound material, not toward the
    spine?"
    
    Thus did I experiment, and discover that I had committed further
    face-palming, head-bagging sins against documentation accuracy.
    
    Fix reversal of "inside footer" and "outside footer" concepts in man
    page.
    
    Change terminology: "double-sided printing" to "double-sided layout".
    It's not groff's problem whether your printer can or will duplex a job.
    
    Pull a one-sentence paragraph into the preceding one.  It didn't help
    much; these changes have left widows and orphans all over the place (on
    U.S. letter paper).  Maybe when 1.22.5 gets closer I can see about
    tidying up.
---
 ChangeLog            |  4 ++++
 tmac/groff_man.7.man | 38 +++++++++++++++++++++-----------------
 2 files changed, 25 insertions(+), 17 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 6b83c52..742997e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2020-01-16  G. Branden Robinson <address@hidden>
+
+       * tmac/groff_man.7.man: Fix errors in footer description.
+
 2020-01-12  G. Branden Robinson <address@hidden>
 
        * tmac/tests/an-old_CS_register_on.sh: Tweak flags; all the
diff --git a/tmac/groff_man.7.man b/tmac/groff_man.7.man
index 6352c7c..f06bbaa 100644
--- a/tmac/groff_man.7.man
+++ b/tmac/groff_man.7.man
@@ -204,7 +204,7 @@ macros.
 .TP
 .BI .TH " title section"\c
 .RI " [" footer-middle ]\c
-.RI " [" footer-outside ]\c
+.RI " [" footer-inside ]\c
 .RI " [" header-middle ]
 Define the title of the man page as
 .I title
@@ -228,16 +228,22 @@ in parentheses immediately appended to
 .I footer-middle
 is centered in the footer line.
 .
-.I footer-outside
-is positioned at the left in the footer line (or at the left on
-even pages and at the right on odd pages if double-sided printing is
-active).
+The arragement of the rest of the footer depends on whether double-sided
+layout is enabled with the option
+.BR \-rD1 .
 .
-The inside footer is the page number,
-except in continuous-rendering mode
-(see
-.B \-rcR=1
-in section \(lqOptions\(rq, below),
+When disabled (the default),
+.I footer-inside
+is positioned at the bottom left.
+.
+Otherwise,
+.I footer-inside
+appears at the bottom left on odd-numbered (recto) pages,
+and at the bottom right on even-numbered (verso) pages.
+.
+The outside footer is the page number,
+except in the continuous-rendering mode enabled by the option
+.BR \-rcR=1 ,
 in which case it is the
 .I title
 and
@@ -255,8 +261,6 @@ there is no need to specify
 .IR header-middle ;
 the macro package will supply text for it.
 .
-.
-.IP
 For HTML output, headers and footers are completely suppressed.
 .
 .
@@ -282,7 +286,7 @@ By convention,
 .I footer-middle
 is the most recent modification date of the man page source document,
 and
-.I footer-outside
+.I footer-inside
 is the name and version or release of the project providing it.
 .
 .
@@ -1987,7 +1991,7 @@ Use of the following is discouraged.
 .IR system " [" release ]]
 Alter the footer for use with legacy AT&T man pages,
 overriding any definition of the
-.I footer-outside
+.I footer-inside
 argument to
 .BR .TH .
 .
@@ -2123,7 +2127,7 @@ Redefine this macro to get control of the header.
 .IR version ]
 Alter the footer for use with legacy BSD man pages,
 overriding any definition of the
-.I footer-outside
+.I footer-inside
 argument to
 .BR .TH .
 .
@@ -2274,9 +2278,9 @@ distinction information.
 .
 .TP
 .B \-rD1
-Enable double-sided printing.
+Enable double-sided layout.
 .
-Footers for even and odd pages are formatted differently;
+Format footers for even and odd pages differently;
 see the description of
 .B .TH
 in \(lqDocument structure macros\(rq,



reply via email to

[Prev in Thread] Current Thread [Next in Thread]