version 1.207, 2017/06/25 17:43:45 |
version 1.211, 2017/07/02 15:31:59 |
Line 836 generated by CVS |
|
Line 836 generated by CVS |
|
or |
or |
.Ic NetBSD |
.Ic NetBSD |
keyword substitution as conventionally used in these operating systems. |
keyword substitution as conventionally used in these operating systems. |
|
.It Sy "referenced manual not found" |
|
.Pq mdoc |
|
An |
|
.Ic \&Xr |
|
macro references a manual page that is not found in the base system. |
|
The path to look for base system manuals is configurable at compile |
|
time and defaults to |
|
.Pa /usr/share/man : /usr/X11R6/man . |
.El |
.El |
.Ss Style suggestions |
.Ss Style suggestions |
.Bl -ohang |
.Bl -ohang |
Line 1089 The same standard section title occurs more than once. |
|
Line 1097 The same standard section title occurs more than once. |
|
.Pq mdoc |
.Pq mdoc |
A standard section header occurs in a section of the manual |
A standard section header occurs in a section of the manual |
where it normally isn't useful. |
where it normally isn't useful. |
|
.It Sy "cross reference to self" |
|
.Pq mdoc |
|
An |
|
.Ic \&Xr |
|
macro refers to a name and section matching the section of the present |
|
manual page and a name mentioned in an |
|
.Ic \&Nm |
|
macro in the NAME or SYNOPSIS section, or in an |
|
.Ic \&Fn |
|
or |
|
.Ic \&Fo |
|
macro in the SYNOPSIS. |
|
Consider using |
|
.Ic \&Nm |
|
or |
|
.Ic \&Fn |
|
instead of |
|
.Ic \&Xr . |
.It Sy "unusual Xr order" |
.It Sy "unusual Xr order" |
.Pq mdoc |
.Pq mdoc |
In the SEE ALSO section, an |
In the SEE ALSO section, an |
Line 1175 The paragraph macro is moved after the end of the list |
|
Line 1201 The paragraph macro is moved after the end of the list |
|
.Pq mdoc |
.Pq mdoc |
An input line begins with an |
An input line begins with an |
.Ic \&Ns |
.Ic \&Ns |
macro. |
macro, or the next argument after an |
|
.Ic \&Ns |
|
macro is an isolated closing delimiter. |
The macro is ignored. |
The macro is ignored. |
.It Sy "blocks badly nested" |
.It Sy "blocks badly nested" |
.Pq mdoc |
.Pq mdoc |
Line 1216 list block contains text or macros before the first |
|
Line 1244 list block contains text or macros before the first |
|
.Ic \&It |
.Ic \&It |
macro. |
macro. |
The offending children are moved before the beginning of the list. |
The offending children are moved before the beginning of the list. |
|
.It Sy "first macro on line" |
|
Inside a |
|
.Ic \&Bl Fl column |
|
list, a |
|
.Ic \&Ta |
|
macro occurs as the first macro on a line, which is not portable. |
.It Sy "fill mode already enabled, skipping" |
.It Sy "fill mode already enabled, skipping" |
.Pq man |
.Pq man |
A |
A |
|
|
.Ic \&It |
.Ic \&It |
block is empty. |
block is empty. |
An empty list item is shown. |
An empty list item is shown. |
|
.It Sy "missing argument, using next line" |
|
.Pq mdoc |
|
An |
|
.Ic \&It |
|
macro in a |
|
.Ic \&Bd Fl column |
|
list has no arguments. |
|
While |
|
.Nm |
|
uses the text or macros of the following line, if any, for the cell, |
|
other formatters may misformat the list. |
.It Sy "missing font type, using \efR" |
.It Sy "missing font type, using \efR" |
.Pq mdoc |
.Pq mdoc |
A |
A |