Handling concepts/terminology in a manpage

Handling concepts/terminology in a manpage

[onf]

Hi all,

I am writing a manpage reference for the dialect of roff implemented by
neatroff. In the spirit of the UNIX tradition, I try to describe all of
its various commands and registers accurately while being as concise as
possible. The problem with this is that these descriptions necessarily
include various terms and concepts specific to roff or typesetting and
the reader cannot be expected to know them all. Of course, I do plan to
describe all of them in detail, but I expect such descriptions to double
the manpage's length..

So I am wondering how to make the terminology easy to look up? Two
ideas that come to mind is either a glossary section that would provide
short explanations and point to subsections with further details, or a
separate manpage dedicated to the various concepts and terms involved.

Thanks for any ideas and suggestions.

Cheers,
onf
--
 To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv