mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.208 and 1.213

version 1.208, 2017/06/27 12:18:00

version 1.213, 2017/07/03 17:33:05

Line 836 generated by CVS

.Ic NetBSD

keyword substitution as conventionally used in these operating systems.

.It Sy "referenced manual not found"

.Pq mdoc

.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

.Ss Style suggestions

.Bl -ohang

Line 897 list contains two consecutive

Line 905 list contains two consecutive

entries describing the same

.Ic \&Er

number.

.It Sy "description line ends with a full stop"

.It Sy "trailing delimiter"

.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.

.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"

.Pq mdoc

The last argument of a macro that supports trailing delimiter

Line 973 The date given in a

Line 985 The date given in a

.Ic \&TH

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

.Ic \&TH

macro is more than a day ahead of the current system

.Xr time 3 .

.It Sy "missing Os macro, using \(dq\(dq"

.Pq mdoc

The default or current system is not shown in this case.

Line 1089 The same standard section title occurs more than once.

Line 1109 The same standard section title occurs more than once.

.Pq mdoc

A standard section header occurs in a section of the manual

where it normally isn't useful.

.It Sy "cross reference to self"

.Pq mdoc

.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

.Ic \&Fo

macro in the SYNOPSIS.

Consider using

.Ic \&Nm

.Ic \&Fn

instead of

.Ic \&Xr .

.It Sy "unusual Xr order"

.Pq mdoc

In the SEE ALSO section, an

Line 1218 list block contains text or macros before the first

Line 1256 list block contains text or macros before the first

.Ic \&It

macro.

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"

.Pq man

Line 1363 list, an

Line 1407 list, an

.Ic \&It

block is empty.

An empty list item is shown.

.It Sy "missing argument, using next line"

.Pq mdoc

.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"

.Pq mdoc

CVSweb