aboutsummaryrefslogtreecommitdiff
path: root/hacking.t
diff options
context:
space:
mode:
authorJohn Ankarström <john@ankarstrom.se>2021-06-24 16:25:32 +0200
committerJohn Ankarström <john@ankarstrom.se>2021-06-24 16:25:32 +0200
commitb8fb8ad8ab2e5cbb245b35f20d050d50be2842d3 (patch)
treee8e2ca0bf6a0667da8ae690247d73ab9dd7a491f /hacking.t
parent5f1752fa417f32956827825d4cc4f09941d029b6 (diff)
downloadmk-b8fb8ad8ab2e5cbb245b35f20d050d50be2842d3.tar.gz
Change name to mu
It turns out that Heirloom troff includes an (m)g macro set for groff compatibility. I liked the name mg, because of the association with milligram, but mu is pretty good too. (And mu is the symbol for the SI micro prefix, which is even smaller than milli!)
Diffstat (limited to 'hacking.t')
-rw-r--r--hacking.t30
1 files changed, 16 insertions, 14 deletions
diff --git a/hacking.t b/hacking.t
index 4233794..629b976 100644
--- a/hacking.t
+++ b/hacking.t
@@ -1,4 +1,4 @@
-.so g.tmac
+.so u.tmac
.
.de @h
. sp |36p
@@ -12,7 +12,7 @@
.
.t
Hacking on the
-.x mg
+.x µ
macro package
.d
John Ankarström
@@ -20,9 +20,11 @@ John Ankarström
.
.h
What is
-.x mg ?
+.x µ ?
.p
-.i Mg
+.i µ
+or
+.i mu
is a simple macro package for troff
designed to abstract as little as possible from troff itself,
while still providing a powerful framework for
@@ -31,23 +33,23 @@ writing advanced documents.
.
.h
How is the source code of
-.x mg
+.x µ
organized?
.p
If you run
.c "grep -n [-]-"
on the
-.i g.tmac
+.i u.tmac
source file, you are presented with an overview of
-.i mg 's
+.i µ 's
macros:
.l
.eo
-!grep -n [-]- g.tmac
+!grep -n [-]- u.tmac
.ec
.p
This is a sufficient summary of the entire
-.i mg
+.i µ
source code, as nothing is performed outside of these macros.
All initialization is performed in the
.c @a
@@ -55,12 +57,12 @@ macro, which is automatically called at the first invocation
of any other macro.
.p
The above summary reflects a categorization in the macros defined by
-.i mg .
+.i µ .
There are internal and external macros.
The former are to be used within
-.i g.tmac
+.i u.tmac
itself, while the latter are to be used in
-.i mg
+.i µ
documents.
Among the external macros, there are inline, environment (or block-level),
hybrid and other macros.
@@ -90,7 +92,7 @@ Where is document state stored?
.p
Most state is stored by troff itself within the different environments.
In addition,
-.i mg
+.i µ
associates three extra registers with each environment:
.c sp ,
the amount of space to be added by
@@ -158,5 +160,5 @@ contains the total number of collected footnotes.
.p
Note that none of these registers and strings should be
directly accessed or modified by
-.i mg
+.i µ
documents.