* src/preproc/html/pre-html.cpp (usage): Don't describe options but
[s-roff.git] / tmac / TESTING-HINTS
blob818d539a6f09ad7dc0980ea1196e6a54c877f086
1 Here are some hints about testing modifications to macro packages 
2 and manual pages.
4 1. Use groff's `-ww' option to catch potential problems.
5    Ideally, there shouldn't be any warnings.
7 2. For a well-formedness check, run doclifter (http://catb.org/~esr/doclifter)
8    against your page.  This tool was written to lift pages to XML, but as a 
9    side effect it acts as a validator that will warn you of potential problems 
10    and non-portable constructs.
12 3. The two most important groff client types are X terminal emulators 
13    and Postscript printers.  Eyeball-check your output under both.
15 4. The colorized man output of the Midnight Commander (what you get by 
16    pressing the F3 key on a man page) is good for making small errors
17    more visible.
19 5. Try different terminal line lengths, say, 80 and 100 characters.