[Top][All Lists]

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

[groff] 01/08: groff_man(7): Make style fixes to Files section.

From: G. Branden Robinson
Subject: [groff] 01/08: groff_man(7): Make style fixes to Files section.
Date: Sun, 1 Jul 2018 20:15:35 -0400 (EDT)

gbranden pushed a commit to branch master
in repository groff.

commit c69d91b9b4fc100fa4ef889bc97b359e50fb6a29
Author: G. Branden Robinson <address@hidden>
Date:   Sat Jun 30 10:17:54 2018 -0400

    groff_man(7): Make style fixes to Files section.
    * Set filespecs in italics, not boldface.
    * Remove the paragraph in the introduction encouraging people to add
      customizations to man.local.  That's an advanced use case and not
      necessarily one to be encouraged, for the sake of man page
    * Help the user actually find the macro package's files by adding
      @MACRODIR@ and @LOCALMACRODIR@ substitutions.
    * Add a discretionary break after the aforementioned substitutions
      because they can be large and are under the user's (./configurer's)
    * Recast some of the language describing the files.
    Signed-off-by: G. Branden Robinson <address@hidden>
 tmac/ | 96 +++++++++++++++++++++++++++++++---------------------
 1 file changed, 58 insertions(+), 38 deletions(-)

diff --git a/tmac/ b/tmac/
index 143b9d7..1dd3982 100644
--- a/tmac/
+++ b/tmac/
@@ -127,15 +127,6 @@ and
 are described in subsection \(lqDeprecated features\(rq, below.
-For further customization, put additional macros and requests into the
-.BR man.local ,
-which is loaded immediately after the
-.B man
 .\" ====================================================================
 .SS "Document structure macros"
 .\" ====================================================================
@@ -1692,63 +1683,92 @@ numbers: 1, 2, 2a, 2b, 2c, etc.
 .\" ====================================================================
-.B man.tmac
+.I @MACRODIR@/\:man.tmac
-.B an.tmac
+.I @MACRODIR@/\:an.tmac
 These are wrapper files to call
-.BR andoc.tmac .
+.IR andoc.tmac .
-.B andoc.tmac
-Use this file in case you don't know whether the
-.B man
-macros or the
-.B mdoc
-package should be used.
-Multiple man pages (in either format) can be handled.
+.I @MACRODIR@/\:andoc.tmac
+This brief
+.I groff
+program detects whether the
+.I man
+.I mdoc
+macro package is being used by a document and loads the correct macro
+taking advantage of the fact that pages using them must call
+.B .TH
+.BR .Dd ,
+as their first macro.
+Because the wrappers above load this file,
+.I man
+program or user typing,
+for example,
+\(lqgroff \-man page.1\(rq,
+need not know which package the file
+.I page.1
+Multiple man pages, in either format, can be handled.
-.B an-old.tmac
+.I @MACRODIR@/\:an\-old.tmac
-.B man
+.I man
 macros are contained in this file.
+It also loads the GNU extensions from
+.I an\-ext.tmac
+(see below).
-.B an-ext.tmac
+.I @MACRODIR@/\:an\-ext.tmac
 The extension macro definitions for
 .BR .SY ,
 .BR .OP ,
 .BR .YS ,
 .BR .TQ ,
-.BR .EX/.EE ,
-.BR .UR/.UE ,
+.BR .EX / .EE ,
+.BR .UR / .UE ,
-.BR .MT/.ME
-are contained in this file.
+.BR .MT / .ME
+are contained in this file,
+which is written in classic
+.I troff
+and permissively licensed\(emnot copylefted.
-It is written in classic troff, and released for free re-use,
-and not copylefted; manual page authors concerned about
-portability to legacy Unix systems are encouraged to copy these
-definitions into their pages, and maintainers of troff
-or its workalikes are encouraged to re-use them.
+Man page authors concerned about portability to legacy Unix systems are
+encouraged to copy these definitions into their pages,
+and maintainers of
+.I troff
+implementations or work-alike systems that format man pages are
+encouraged to re-use them.
 Note that the definitions for these macros are read after the call of
-.BR TH ,
-so they will replace macros of the same names given at the beginning of
-your file.
+.BR .TH ,
+so they will replace any macros of the same names preceding it in your
-If you must use your own definitions for these macros, they must be
-given after calling
-.BR TH .
+If you use your own implementations of these macros,
+they must be defined after calling
+.B .TH
+to have any effect.
-.B man.local
+.I @LOCALMACRODIR@/\:man.local
 Local changes and customizations should be put into this file.

reply via email to

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