summaryrefslogtreecommitdiffstatshomepage
path: root/README.addmacro
blob: 8bdea891f65abb65f751994cbcc7923ec1b4f986 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
$Id: README.addmacro,v 1.1 2009/02/23 13:05:06 kristaps Exp $

This documents how to go about adding a macro to mdoc.3.

(1) Add the macro to the #define list in mdoc.h.
(2) Add the macro to __mdoc_macronames in mdoc.c.
(3) Add the macro to __mdoc_macros in mdoc.c.
(4) Add the macro to mdoc_valids in validate.c.
(5) Add the macro to mdoc_actions in action.c.
(6) Add the macro to mdoc_argflags in argv.c.
(7) Modify the hash routine in hash.c (may not be required).

If the macro has arguments:

(1) Add arguments to the #define list in mdoc.h.
(2) Add the arguments to __mdoc_argnames in mdoc.c.
(3) Modify parts of argv.c (lookup() and mdoc_args()).

You'll certainly want to change the front-ends:

(1) Add the macro to __termacts in term.c.