mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.1 between version 1.203 and 1.211

version 1.203, 2017/06/24 15:59:50

version 1.211, 2017/07/02 15:31:59

Line 688 Messages displayed by

.Nm

follow this format:

.Bd -ragged -offset indent

.Nm Ns :

.Nm :

.Ar file : Ns Ar line : Ns Ar column : level : message : macro args

.Pq Ar os

.Ed

Line 816 macro does not use CVS

keyword substitution, but using it is conventionally expected in the

.Ox

base system.

.It Sy "unknown architecture"

.Pq mdoc , Ox , Nx

The third argument of the

.Ic \&Dt

macro does not match any of the architectures this operating system

is running on.

.It Sy "operating system explicitly specified"

.Pq mdoc , Ox , Nx

The

Line 830 generated by CVS

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 851 A single manual page contains two copies of the RCS id

Line 865 A single manual page contains two copies of the RCS id

the same operating system.

Consider deleting the later instance and moving the first one up

to the top of the page.

.It Sy "typo in section name"

.Pq mdoc

Fuzzy string matching revealed that the argument of an

.Ic \&Sh

macro is similar, but not identical to a standard section name.

.It Sy "useless macro"

.Pq mdoc

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

Line 1097 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 1164 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

An input line begins with an

.Ic \&Ns

macro.

macro, or the next argument after an

.Ic \&Ns

macro is an isolated closing delimiter.

The macro is ignored.

.It Sy "blocks badly nested"

.Pq mdoc

Line 1205 list block contains text or macros before the first

Line 1244 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 1272 A

Line 1317 A

.Ic \&Bl ,

.Ic \&D1 ,

.Ic \&Dl ,

.Ic \&MT ,

.Ic \&RS ,

.Ic \&UR

Line 1349 list, an

Line 1395 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

Line 1407 An empty pair of square brackets is shown.

Line 1464 An empty pair of square brackets is shown.

.It Sy "missing resource identifier, using \(dq\(dq"

.Pq man

The

.Ic \&MT

.Ic \&UR

macro is invoked without any argument.

An empty pair of angle brackets is shown.

Line 1759 An

Line 1818 An

.Xr mdoc 7

block closing macro, a

.Xr man 7

.Ic \&RE

.Ic \&ME , \&RE

.Ic \&UE

macro, an

Line 1793 At the end of the document, an explicit

Line 1852 At the end of the document, an explicit

block, a

.Xr man 7

next-line scope or

.Ic \&RS

.Ic \&MT , \&RS

.Ic \&UR

block, an equation, table, or

Line 1965 A macro or request is invoked with too many arguments:

Line 2024 A macro or request is invoked with too many arguments:

.Bl -dash -offset 2n -width 2n -compact

.It

.Ic \&Fo ,

.Ic \&MT ,

.Ic \&PD ,

.Ic \&RS ,

.Ic \&UR ,

CVSweb