BUGS section of man pages
rsimmons0 at gmail.com
Mon Feb 20 20:58:19 UTC 2012
Can someone clarify the usage for the "BUGS" section of man pages?
My assumption is that it is for listing known bugs, as in defects that
are correctable but not yet corrected. The section exists as a list
of the existence of these defects until the defect is fixed. Similar
to a section of known problems or known bugs in the release notes of a
piece of software.
However, I have noticed that some man pages use the section as a list
of warnings or gotchas that the user should know about, but are not
really defects or bugs in the software.
For example, the cat(1) man page's bugs section lists "Because of the
shell language mechanism used to perform output redirection, the
command ``cat file1 file2 > file1'' will cause the original data in
file1 to be destroyed!" This does not seem like a bug to me.
Perhaps a "WARNINGS" section should be used for this type of information?
More information about the freebsd-doc