[Top][All Lists]

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

[groff] 39/40: groff_mdoc(7): Rename section to "Options".

From: G. Branden Robinson
Subject: [groff] 39/40: groff_mdoc(7): Rename section to "Options".
Date: Mon, 12 Dec 2022 19:28:08 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit 68a8f5c20cc78e331ac47ba4139d73acc71e60ff
Author: G. Branden Robinson <>
AuthorDate: Mon Dec 12 16:36:59 2022 -0600

    groff_mdoc(7): Rename section to "Options".
    * Align with groff_man(7) by calling this section "Options", instead of
      its obnoxious yard-long former name, which also reminds me that style
      changes should be supported in (sub)section headings and that the
      package should remap fonts as groff_man(7) does to maintain stroke
    * Copy introduction and warning from groff_man(7).
    * Set string and register names and their values with `Ql`, not `Li`.
    * Use `Dl` for example instead of ".D1 Li".
    * Stop using `Tn` to set Teletype; even if we restore type size changes
      for this macro (as наб has requested), "Teletype" is not one of those
      Cold War Defense Department acronyms that should be set in small caps.
    * Break input lines after commas.
    * Use scaling unit abbreviation for point, rather than "pt".
    * Tighten wording.
 tmac/ | 40 ++++++++++++++++++++++++++++------------
 1 file changed, 28 insertions(+), 12 deletions(-)

diff --git a/tmac/ b/tmac/
index fc46231e2..da0dc4bf4 100644
--- a/tmac/
+++ b/tmac/
@@ -4853,31 +4853,49 @@ standard error stream.
 A normal user will never need it.
-.Sh "Formatting with groff, troff, and nroff"
+.Sh Options
+The following
+.Xr groff
+options set registers
+.Fl r )
+and strings
+.Fl d )
+recognized and used by the
+.Xr mdoc
+macro package.
+To ensure rendering consistent with output device capabilities and
+reader preferences,
+man pages should never manipulate them.
 Setting string
-.Li AD
+.Ql AD
 configures the adjustment mode for most formatted text.
 Typical values are
-.Li b
+.Ql b
 for adjustment to both margins
 (the default),
-.Li l
+.Ql l
 for left alignment
 (ragged right margin).
 Any valid argument to
 .Xr groff Ns No 's
-.Li .ad
+.Ql ad
 request may be used.
 .Xr groff @MAN7EXT@
 for less-common choices.
-.D1 Li groff \-Tutf8 \-dAD=l \-mdoc groff_mdoc.7 | less \-R
+.Dl groff \-Tutf8 \-dAD=l \-mdoc groff_mdoc.7 | less \-R
@@ -4904,8 +4922,7 @@ or
 to enable more efficient viewing of the page.
 This behavior can be changed to format the page as if for 66-line
-.Tn Teletype
-output by setting the continuous rendering register
+Teletype output by setting the continuous rendering register
 .Ql cR
 to zero while calling
 .Xr groff @MAN1EXT@ .
@@ -4947,7 +4964,8 @@ swapping places with the arguments to
-To change the document font size to 11pt or 12pt, set register
+To change the document font size to 11p or 12p,
+set register
 .Ql S
@@ -5043,9 +5061,7 @@ or
 before any other macros.
-.Xr man
-program or user typing,
+A user typing,
 for example,
 .Dl groff \-mandoc page.1
 need not know which package the file

reply via email to

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