diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:44:05 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:44:05 +0000 |
commit | d318611dd6f23fcfedd50e9b9e24620b102ba96a (patch) | |
tree | 8b9eef82ca40fdd5a8deeabf07572074c236095d /tmac/TESTING-HINTS | |
parent | Initial commit. (diff) | |
download | groff-upstream.tar.xz groff-upstream.zip |
Adding upstream version 1.23.0.upstream/1.23.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'tmac/TESTING-HINTS')
-rw-r--r-- | tmac/TESTING-HINTS | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/tmac/TESTING-HINTS b/tmac/TESTING-HINTS new file mode 100644 index 0000000..6e21564 --- /dev/null +++ b/tmac/TESTING-HINTS @@ -0,0 +1,19 @@ +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. |