diff options
author | esr <esr> | 2007-02-02 10:58:41 +0000 |
---|---|---|
committer | esr <esr> | 2007-02-02 10:58:41 +0000 |
commit | dead16a9b284306c9aceb91dc35267102f8f918d (patch) | |
tree | e0290cad4da877aaa5850b8223a4384d4e61d8d6 /tmac/TESTING-HINTS | |
parent | e5ec8a68e9d35924bfd0cae7cf1c8f7b5f0e0768 (diff) | |
download | groff-dead16a9b284306c9aceb91dc35267102f8f918d.tar.gz |
Added TESTING-HINTS based on wisdom from Werner.
Diffstat (limited to 'tmac/TESTING-HINTS')
-rw-r--r-- | tmac/TESTING-HINTS | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/tmac/TESTING-HINTS b/tmac/TESTING-HINTS new file mode 100644 index 00000000..5b51bef5 --- /dev/null +++ b/tmac/TESTING-HINTS @@ -0,0 +1,20 @@ +Here are some hints about testing modifications to macro packages +and manual pages. + +1. Use groff's `-ww' option to catch potential problems. + Ideally, there shouldn't be any warnings. + +2. For a well-formedness check, run doclifter (http://catb,org/~esr/doclifter) + against your page. This tool was written to lift pages to XML, but as a + side effect it acts as a validator that will warn you of potential problems + and non-portable constructs. + +3. The two most important groff client types are X terminal emulators + and Postscript printers. Eyeball-check your output under both. + +4. The colorized man output of the Midnight Commander (what you get by + pressing the F3 key on a man page) is good for making small errors + more visible. + +5. Try different terminal line lengths, say, 80 and 100 characters. + |