[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 15/31: groff_tmac(5): Fix content nits.
From: |
G. Branden Robinson |
Subject: |
[groff] 15/31: groff_tmac(5): Fix content nits. |
Date: |
Mon, 31 Jan 2022 11:28:10 -0500 (EST) |
gbranden pushed a commit to branch master
in repository groff.
commit 830cb588c1026b0e229666d430ed40401111695b
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Sun Jan 30 06:13:28 2022 +1100
groff_tmac(5): Fix content nits.
Content:
* Heighten distinction between "macro files" and "macro packages".
Macro _packages_ are macro files that can be loaded with the `-m`
flag.
* Elaborate definition of a macro file so that the reader doesn't assume
too much.
* (Localization): Say what we do for Eastern languages. Note fact that
man(7) is localized (for Western languages) now.
---
doc/groff.texi | 1 +
man/groff_tmac.5.man | 51 ++++++++++++++++++++++++++++++++++++++-------------
2 files changed, 39 insertions(+), 13 deletions(-)
diff --git a/doc/groff.texi b/doc/groff.texi
index 126fcac5..43303348 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -5207,6 +5207,7 @@ that they are most easily understood when read from
beginning to end.
@cindex macro package
@cindex package, macro
+@c TODO: Consider parallelizing with groff_tmac(5) "Description".
Macro definitions can be collected into @dfn{macro files}, @code{roff}
input files designed to produce no output themselves but instead ease
the preparation of other @code{roff} documents. There is no syntactical
diff --git a/man/groff_tmac.5.man b/man/groff_tmac.5.man
index 6f2ce89b..36fc652c 100644
--- a/man/groff_tmac.5.man
+++ b/man/groff_tmac.5.man
@@ -26,6 +26,7 @@ groff_tmac \- macro files in the GNU roff typesetting system
.cp 0
.
.
+.\" TODO: Consider parallelizing with our Texinfo node "Macro Packages".
.\" ====================================================================
.SH Description
.\" ====================================================================
@@ -47,24 +48,19 @@ There is no syntactical difference between a macro file and
any other
document;
only its purpose distinguishes it.
.
-When a macro file is installed at a standard location and suitable for
-use by a general audience,
-it is often termed a
+When a macro file is installed at a standard location,
+named according to a certain convention,
+and suitable for use by a general audience,
+it is termed a
.IR "macro package" .
.
Macro packages can be loaded by supplying the
.B \-m
option to
-.MR groff @MAN1EXT@
-or
-.MR @g@troff @MAN1EXT@ .
-.
-Alternatively,
-a
+.MR @g@troff @MAN1EXT@
+or a
.I groff
-document wishing to use a macro package can load it with the
-.B mso
-(\[lq]macro source\[rq]) request.
+front end.
.
.
.P
@@ -92,15 +88,36 @@ Section \[lq]Environment\[rq] of
.MR @g@troff @MAN1EXT@
lists these directories.
.
+Alternatively,
+a
+.I groff
+document wishing to use a macro file can load it with the
+.B mso
+(\[lq]macro source\[rq]) request.
+.
+.
+.P
Like any other
.I roff
document,
-a macro package can use the
+a macro file can use the
.RB \[lq] so \[rq]
request (\[lq]source\[rq]) to load further files relative to its own
location.
.
.
+.P
+Macro files are named for their most noteworthy application,
+but a macro file need not define any macros.
+.
+It can restrict itself to defining registers and strings or invoking
+other
+.I groff
+requests.
+.
+It can even be empty.
+.
+.
.\" ====================================================================
.SH "Macro packages"
.\" ====================================================================
@@ -263,6 +280,9 @@ alter the input encoding
(see the next section);
and change the amount of inter-sentence space.
.
+For Eastern languages,
+the localization file defines character classes and sets flags on them.
+.
By default,
.I troffrc
loads the localization file for English.
@@ -279,6 +299,7 @@ the following localization files exist.
.I cs
Czech;
localizes
+.IR man ,
.IR me ,
.IR mm ,
.IR mom ,
@@ -295,6 +316,7 @@ Sets the input encoding to Latin-2 by loading
.I den
German;
localizes
+.IR man ,
.IR me ,
.IR mm ,
.IR mom ,
@@ -323,6 +345,7 @@ English.
.I fr
French;
localizes
+.IR man ,
.IR me ,
.IR mm ,
.IR mom ,
@@ -337,6 +360,7 @@ Sets the input encoding to Latin-9 by loading
.I it
Italian;
localizes
+.IR man ,
.IR me ,
.IR mm ,
.IR mom ,
@@ -353,6 +377,7 @@ Japanese.
.I sv
Swedish;
localizes
+.IR man ,
.IR me ,
.IR mm ,
.IR mom ,
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 15/31: groff_tmac(5): Fix content nits.,
G. Branden Robinson <=