While you're talking about generic categories of man page bugs, one
I've seen a lot in the past (esp. but not exclusively in the CDE man pages)
was comments, copyright notices, etc. in front of the marker for
eqn, refer, tbl, or vgrind preprocessing (see man(1)).  If that line is needed,
it must AFAIK be the _first_ line in the file, preceeding everything else.
So mechanically prepending copyright notices or whatever is not smart;
some special handling is needed to make sure that special line, if present,
remains the first line in the file.

This is particularly common and annoying when tbl preprocessing is needed
(although I can imagine that it might be even more cryptic looking if some
of the other preprocessing was needed but not performed).

The marker is single-quote backslash double-quote space followed by
one or more of e, r, t, or v for eqn, refer, tbl, or vgrind respectively.
Again, all that is described in the paragraph of man(1) headed
"Preprocessing Nroff Manual Pages" (although of course it applies with troff
as well - note troff with suitable postprocessing is nice to produce
PostScript or even PDF man pages for graphical viewing; with some; in
particular, the "ansun" macros instead of the "an" macros produce very
pretty pages like the old hardcopy ones, although not as space-efficient,
and in some cases they seem to generate too long a page).
 
 
This message posted from opensolaris.org
_______________________________________________
opensolaris-code mailing list
[email protected]
http://mail.opensolaris.org/mailman/listinfo/opensolaris-code

Reply via email to