mirror of https://github.com/mkerrisk/man-pages
Enhanced the dscussion of font conventions.
This commit is contained in:
parent
9085070854
commit
027ebd3c4b
|
@ -393,6 +393,8 @@ where the rest of the function is specified in bold:
|
|||
.PP
|
||||
.BI " int myfunction(int " argc ", char **" argv );
|
||||
.PP
|
||||
Variable names should, like argument names, be specified in italics.
|
||||
.PP
|
||||
Filenames (whether pathnames, or references to files in the
|
||||
.I /usr/include
|
||||
directory)
|
||||
|
@ -415,6 +417,28 @@ usually uses the
|
|||
.B \&.TP
|
||||
macro).
|
||||
.PP
|
||||
Complete commands should, if long,
|
||||
be written as in an indented line on their own, for example
|
||||
.in +4n
|
||||
.nf
|
||||
|
||||
man 7 man-pages
|
||||
|
||||
.fi
|
||||
.in
|
||||
If the comamnd is short, then it can be included inline in the text,
|
||||
in italic format, for example,
|
||||
.IR "man 7 man-pages" .
|
||||
In this case, it may be worth using non-breaking spaces
|
||||
("\e\ ") at suitable places in the command.
|
||||
Command options should be written in italics, e.g.,
|
||||
.IR \-l .
|
||||
.PP
|
||||
Expressions, if not written on a separate indented line, should
|
||||
be specified in italics.
|
||||
Again, the use of non-breaking spaces may be appropriate
|
||||
if the expression is inlined with normal text.
|
||||
.PP
|
||||
Any reference to the subject of the current manual page
|
||||
should be written with the name in bold.
|
||||
If the subject is a function (i.e., this is a Section 2 or 3 page),
|
||||
|
|
Loading…
Reference in New Issue