aboutsummaryrefslogtreecommitdiff
path: root/HACKING.t
diff options
context:
space:
mode:
authorJohn Ankarstrom <john@ankarstrom.se>2021-07-01 22:10:09 +0200
committerJohn Ankarstrom <john@ankarstrom.se>2021-07-01 22:10:09 +0200
commit7ce1da8edd9450f662d76aa7aea223db003c0557 (patch)
tree7386bb1d3fd9e9a363fb0f007f49f43eab4ae880 /HACKING.t
parentc39dea4bf977643c36c980c4b6f661d4cd85e791 (diff)
downloadmk-7ce1da8edd9450f662d76aa7aea223db003c0557.tar.gz
Rename mu to mk
The u*.tmac namespace is already a bit busy.
Diffstat (limited to 'HACKING.t')
-rw-r--r--HACKING.t28
1 files changed, 14 insertions, 14 deletions
diff --git a/HACKING.t b/HACKING.t
index 10d2a31..9084dd3 100644
--- a/HACKING.t
+++ b/HACKING.t
@@ -1,4 +1,4 @@
-.so u.tmac
+.so k.tmac
.
.de @h
. sp |36p
@@ -12,7 +12,7 @@
.
.t
Hacking on the
-.x µ
+.x mk
macro package
.d
John Ankarström
@@ -20,9 +20,9 @@ John Ankarström
.
.h
What is
-.x µ ?
+.x mk ?
.p
-.i µ
+.i Mk
or
.i mu
is a simple macro package for troff
@@ -33,23 +33,23 @@ writing advanced documents.
.
.h
How is the source code of
-.x µ
+.x mk
organized?
.p
If you run
.c "grep -n [-]-"
on the
-.i u.tmac
+.i k.tmac
source file, you are presented with an overview of
-.i µ 's
+.i mk 's
macros:
.l
.eo
-!grep -n [-]- u.tmac
+!grep -n [-]- k.tmac
.ec
.p
This is a sufficient summary of the entire
-.i µ
+.i mk
source code, as nothing is performed outside of these macros.
All initialization is performed in the
.c @a
@@ -57,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 µ .
+.i mk .
There are internal and external macros.
The former are to be used within
-.i u.tmac
+.i k.tmac
itself, while the latter are to be used in
-.i µ
+.i mk
documents.
Among the external macros, there are inline, environment (or block-level)
and other macros.
@@ -90,7 +90,7 @@ Where is document state stored?
.p
Most state is stored by troff itself within the different environments.
In addition,
-.i µ
+.i mk
associates three extra registers with each environment:
.c sp ,
the amount of space to be added by
@@ -158,5 +158,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 µ
+.i mk
documents.