mirror of https://github.com/mkerrisk/man-pages
Minor updates after comments by AEB.
This commit is contained in:
parent
04bc882719
commit
f8843c2ecd
|
@ -331,7 +331,7 @@ If the call is Linux specific, note this.
|
|||
.TP
|
||||
.B NOTES
|
||||
provides miscellaneous notes.
|
||||
For Section 2 and 3 man pages you may find it usful to include
|
||||
For Section 2 and 3 man pages you may find it useful to include
|
||||
subsections (\fBSS\fP) named \fILinux Notes\fP and \fIGlibc Notes\fP.
|
||||
.TP
|
||||
.B BUGS
|
||||
|
@ -345,16 +345,14 @@ For details on writing example programs,
|
|||
see \fIExample Programs\fP below.
|
||||
.TP
|
||||
.B AUTHOR
|
||||
lists authors of the documentation or program so you can mail in bug
|
||||
reports.
|
||||
\fBUse of an AUTHOR section is discouraged\fP for pages in
|
||||
the \fIman-pages\fP package.
|
||||
(One exception is Section 4 pages that list the authors of
|
||||
device drivers, to whom software bugs should be sent.)
|
||||
lists authors of the documentation or program.
|
||||
\fBUse of an AUTHOR section is discouraged\fP.
|
||||
Generally, it is better not to clutter every page with a list
|
||||
of (over time potentially numerous) authors;
|
||||
if you write or significantly amend a page,
|
||||
add a copyright notice as a comment in the source file.
|
||||
If you are the author a device driver and what to include
|
||||
an address for reporting bugs, place this under the BUGS section.
|
||||
.TP
|
||||
.B SEE ALSO
|
||||
lists related man pages, ordered by section number and
|
||||
|
@ -385,14 +383,18 @@ usually uses the
|
|||
macro).
|
||||
.PP
|
||||
Any reference to the subject of the current manual page
|
||||
should be written with the name in bold,
|
||||
followed by a pair of parentheses in Roman (normal) font,
|
||||
e.g.,
|
||||
.BR man ().
|
||||
should be written with the name in bold.
|
||||
If the subject is a function (i.e., this is a Section 2 or 3 page),
|
||||
then the name should be followed by a pair of parentheses
|
||||
in Roman (normal) font.
|
||||
For example, in the
|
||||
.BR fcntl (2)
|
||||
man page, references to the subject of the page would be written as:
|
||||
.BR fcntl ().
|
||||
The preferred way to write this in the source file is:
|
||||
.nf
|
||||
|
||||
.BR man ()
|
||||
.BR fcntl ()
|
||||
|
||||
.fi
|
||||
(Using this format, rather than the use of "\\fB...\\fP()"
|
||||
|
|
Loading…
Reference in New Issue