version 1.208, 2017/06/27 12:18:00 |
version 1.214, 2017/07/04 14:40:38 |
Line 762 A convertion used in the base system of a specific ope |
|
Line 762 A convertion used in the base system of a specific ope |
|
is not adhered to. |
is not adhered to. |
These are not markup mistakes, and neither the quality of formatting |
These are not markup mistakes, and neither the quality of formatting |
nor portability are in danger. |
nor portability are in danger. |
|
Messages of the |
|
.Cm base |
|
level are printed with the more intuitive |
|
.Cm style |
|
.Ar level |
|
tag. |
.El |
.El |
.Pp |
.Pp |
Messages of the |
Messages of the |
Line 836 generated by CVS |
|
Line 842 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 897 list contains two consecutive |
|
Line 911 list contains two consecutive |
|
entries describing the same |
entries describing the same |
.Ic \&Er |
.Ic \&Er |
number. |
number. |
.It Sy "description line ends with a full stop" |
.It Sy "trailing delimiter" |
.Pq mdoc |
.Pq mdoc |
Do not use punctuation at the end of an |
The last argument of an |
.Ic \&Nd |
.Ic \&Ex , \&Fo , \&Nd , \&Nm , \&Os , \&Sh , \&Ss , \&St , |
block. |
or |
|
.Ic \&Sx |
|
macro ends with a trailing delimiter. |
|
This is usually bad style and often indicates typos. |
|
Most likely, the delimiter can be removed. |
.It Sy "no blank before trailing delimiter" |
.It Sy "no blank before trailing delimiter" |
.Pq mdoc |
.Pq mdoc |
The last argument of a macro that supports trailing delimiter |
The last argument of a macro that supports trailing delimiter |
Line 973 The date given in a |
|
Line 991 The date given in a |
|
or |
or |
.Ic \&TH |
.Ic \&TH |
macro does not follow the conventional format. |
macro does not follow the conventional format. |
|
.It Sy "date in the future, using it anyway" |
|
.Pq mdoc , man |
|
The date given in a |
|
.Ic \&Dd |
|
or |
|
.Ic \&TH |
|
macro is more than a day ahead of the current system |
|
.Xr time 3 . |
.It Sy "missing Os macro, using \(dq\(dq" |
.It Sy "missing Os macro, using \(dq\(dq" |
.Pq mdoc |
.Pq mdoc |
The default or current system is not shown in this case. |
The default or current system is not shown in this case. |
Line 1089 The same standard section title occurs more than once. |
|
Line 1115 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 1218 list block contains text or macros before the first |
|
Line 1262 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 |