aboutsummaryrefslogtreecommitdiff
path: root/README
blob: c124f46ac73b3214f4822989d3fb746bd743c71b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
--- Overview ---

This repository can be divided into three parts:

 * mk (top directory)
 * toc
 * list

`make install' will install all of these.  You may want to set
TMACDIR, BINDIR and MANDIR before installing.

--- Summary ---

* Mk is a simple and modern troff macro package.  It is divided
  into two files:

    k.tmac -- base macros
    kx.tmac -- extra macros (optional)

* Toc provides a simple method of creating forward references, such
  as tables of contents, in troff documents.  It consists of a
  shell script and a macro package:

    toc -- runs troff in multiple passes
    toc.tmac -- macros to be used with toc

* List provides a way to include source code in troff documents
  without needing to escape special characters.  It consists of a
  single Perl script:

    list -- escapes text between .l( and .l)