groff-commit
[Top][All Lists]
Advanced

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

[groff] 14/21: groff_tmac(5): Update "papersize.tmac" material.


From: G. Branden Robinson
Subject: [groff] 14/21: groff_tmac(5): Update "papersize.tmac" material.
Date: Fri, 18 Nov 2022 13:47:53 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 79225d29437d320296647f9d60b8b89786ff1910
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Nov 17 21:13:25 2022 -0600

    groff_tmac(5): Update "papersize.tmac" material.
    
    Content:
    * Rename metasyntactic variable from "size" to "format".
    * Discuss this macro file's assumptions about horizontal margins, and
      how to overcome them.
    * Discuss integration with groff's full-service macro packages.
    * Clarify that the package is only automatically loaded in troff mode.
    
    Style:
    * Double-quote multi-word literals so that they're intelligible even
      with font styling stripped.
    * Set paper format literals in bold.
    
    Markup:
    * Stop setting auxiliary package tags in a wide indentation.  It doesn't
      gain us much, and the sboxes synopses need almost as much room as we
      have.
    * Prevent paper format literals from being hyphenated.
---
 man/groff_tmac.5.man | 57 ++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 40 insertions(+), 17 deletions(-)

diff --git a/man/groff_tmac.5.man b/man/groff_tmac.5.man
index ac6af88bf..b2f06c5a0 100644
--- a/man/groff_tmac.5.man
+++ b/man/groff_tmac.5.man
@@ -476,7 +476,7 @@ documents.
 .\"   europs
 .\"   psatk
 .\"   psfig
-.TP 9n \" 'papersize'
+.TP
 .I 62bit
 provides macros for addition,
 multiplication,
@@ -510,32 +510,34 @@ See
 .TP
 .I papersize
 enables the paper format to be set on the command line by giving a
-.BI "\-d \%paper=" size
+.RB \[lq] \-d
+.BI \%paper= format\c
+\[rq]
 option to
 .IR @g@troff .
 .
 Possible values for
-.I size
+.I format
 are the ISO and DIN formats
-\[lq]A0\[en]A6\[rq],
-\[lq]B0\[en]B6\[rq],
-\[lq]C0\[en]C6\[rq],
+.RB \[lq] A0 \[en] A6 \[rq],
+.RB \[lq] B0 \[en] B6 \[rq],
+.RB \[lq] C0 \[en] C6 \[rq],
 and
-\[lq]D0\[en]D6\[rq];
+.RB \[lq] D0 \[en] D6 \[rq];
 .\" XXX: src/libs/libgroff/paper.cpp also supports [ABCD]7.
 the U.S.\& formats
-\[lq]letter\[rq],
-\[lq]legal\[rq],
-\[lq]tabloid\[rq],
-\[lq]ledger\[rq],
-\[lq]statement\[rq],
+.RB \%\[lq] letter \[rq],
+.RB \%\[lq] legal \[rq],
+.RB \%\[lq] tabloid \[rq],
+.RB \%\[lq] ledger \[rq],
+.RB \%\[lq] statement \[rq],
 and
-\[lq]executive\[rq];
+.RB \%\[lq] executive \[rq];
 and the envelope formats
-\[lq]com10\[rq],
-\[lq]monarch\[rq],
+.RB \%\[lq] com10 \[rq],
+.RB \%\[lq] monarch \[rq],
 and
-\[lq]DL\[rq].
+.RB \%\[lq] DL \[rq].
 .
 All formats,
 even those for envelopes,
@@ -545,6 +547,26 @@ the length measurement is vertical.
 Appending \[lq]l\[rq] (ell) to any of these denotes landscape
 orientation instead.
 .
+This macro file assumes one-inch horizontal margins,
+and sets registers recognized by the
+.I groff
+.IR man ,
+.IR mdoc ,
+.IR mm ,
+.IR mom ,
+and
+.I ms
+packages to configure them accordingly.
+.
+If you want different margins,
+you will need to use those packages' facilities,
+or
+.I @g@troff
+.B ll
+and/or
+.B po
+requests to adjust them.
+.
 An output device typically requires command-line options
 .B \-p
 and
@@ -560,7 +582,8 @@ of
 .
 This macro file is normally loaded at startup by the
 .I troffrc
-file.
+file when formatting for a typesetting device
+(but not a terminal).
 .
 .
 .TP



reply via email to

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