groff-commit
[Top][All Lists]
Advanced

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

[groff] 09/26: groff_man_style(7): Update font selection advice.


From: G. Branden Robinson
Subject: [groff] 09/26: groff_man_style(7): Update font selection advice.
Date: Sun, 14 Nov 2021 22:04:25 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit ecd7eb791a1aa057d7eb81f6e5f997162a04aef1
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Fri Nov 12 20:50:21 2021 +1100

    groff_man_style(7): Update font selection advice.
    
    * Identify C data types as italic fodder.
    * Drop identification of works of software as italic fodder; usage
      outside of man page cross reference contexts is too varied (or even
      opposed), and now that we have MR, the main motivation for this point
      has evaporated.
    * Erect shield against a Kemper notectomy.
    * Note the typographical distinction most style guides make between
      "short" works on the one hand (for man page purposes, usually journal
      articles) and long ones (books, the journal names themselves).
    
    Thanks to Alejandro Colomar for the discussion[1].
    
    [1] https://lore.kernel.org/linux-man/\
    20211112093536.hvifxgdtb2y6jzge@localhost.localdomain/\
    T/#m7cb247658ef0904ed402d24d28e07252b0dd679c
---
 tmac/groff_man.7.man.in | 18 +++++-------------
 1 file changed, 5 insertions(+), 13 deletions(-)

diff --git a/tmac/groff_man.7.man.in b/tmac/groff_man.7.man.in
index d6ac5b4..2322e42 100644
--- a/tmac/groff_man.7.man.in
+++ b/tmac/groff_man.7.man.in
@@ -1506,14 +1506,11 @@ _ifstyle()dnl
 Use italics
 for file and path names,
 for environment variables,
+for C data types,
 for enumeration or preprocessor constants in C,
 for variable (user-determined) portions of syntax synopses,
 for the first occurrence (only) of a technical concept being introduced,
-for names of works of software
-(including commands and functions,
-.\" The following is an interesting exception that seems to have arisen
-.\" organically and nearly universally.
-but excluding names of operating systems or their kernels),
+for names of journals and of literary works longer than an article,
 and anywhere a parameter requiring replacement by the user is
 encountered.
 .
@@ -1588,13 +1585,13 @@ it will be hidden from readers using such devices.
 .
 .
 .P
-Note what is
+Observe what is
 .I not
 prescribed for setting in bold or italics above:
 elements of \(lqsynopsis language\(rq such as ellipses and brackets
 around options;
 proper names and adjectives;
-titles of anything other than works of literature or software;
+titles of anything other than major works of literature;
 identifiers for standards documents or technical reports such as
 CSTR\~#54,
 RFC\~1918,
@@ -1604,17 +1601,12 @@ POSIX.1-2017;
 acronyms;
 and occurrences after the first of a technical term or piece of jargon.
 .
-Again,
-the names of operating systems and their kernels are,
-by practically universal convention,
-set in roman.
-.
 .
 .P
 Be frugal with italics for emphasis,
 and particularly with bold.
 .
-Brief runs of literal text,
+Article titles and brief runs of literal text,
 such as references to individual characters or short strings,
 including section and subsection headings of man pages,
 are suitable objects for quotation;



reply via email to

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