NAME

mdocmx — mdocmx reference extension mdoc manual preprocessor

SYNOPSIS

mdocmx [−t | −T Sh | sh | Ss | ss [−c]] [−v]

TABLE OF CONTENTS
NAME[1]
SYNOPSIS[2]
TABLE OF CONTENTS[3]
DESCRIPTION[4]
IMPLEMENTATION NOTES[5]
COMPATIBILITY[6]
SEE ALSO[7]
AUTHORS[8]

DESCRIPTION

mdocmx is a preprocessor for mdocmx(7)[13] that extends the mdoc(7)[14] semantic markup language with references, allowing it to create anchors and table of contents. It is needed because single-pass troff implementations cannot create forward references, and so it collects all referenceable anchors in a mdoc(7)[15] document. The result is itself a valid, compatible and distributable mdoc(7)[16] document, but which will be fully interactive if the local formatter is mdocmx(7)[17] enabled.

−c

In conjunction with −t[10] or −T[11] a compact display for the first level of the generated table of contents is used (deeper levels are always compact).

−t

Replace any ‘.Mx -toc’ command in the document with a table of content of only section headers. The result does not require further mdocmx(7)[18] processing (but which would create interactivity).

−T Sh | sh | Ss | ss

Replace any ‘.Mx -toc’ command in the document with a table of contents that either consists of only section headers (‘Sh’), or the full tree of headers and their subsections (‘Ss’). The result does not require further mdocmx(7)[19] processing (but which would create interactivity).

−v

Enable warning messages. Use multiple times to gain processing verbosity, too. Verbosity is highly recommendet when developing mdocmx(7)[20] enabled mdoc(7)[21] documents.

IMPLEMENTATION NOTES

mdocmx works without any ado for any tested real-life mdoc(7)[22] document, but its capabilities can be exceeded by making heavy use of all the possibilities that troff(1)[23] and the mdoc(7)[24] semantic markup langouage have to offer. A future multi-pass troff(1)[25] will not require any preprocessor at all.

COMPATIBILITY

mdocmx is implemented in portable sh(1)[26] and awk(1)[27] .

SEE ALSO

awk(1)[28] , sh(1)[29] , troff(1)[30] , mdoc(7)[31] , mdocmx(7)[32]

AUTHORS

Steffen Nurpmeso <[email protected]>.