src/usr.bin/mandoc/mandoc.1 - diff

Return to mandoc.1 CVS log

Up to [local] / src / usr.bin / mandoc

Diff for /src/usr.bin/mandoc/mandoc.1 between version 1.125 and 1.126

version 1.125, 2017/06/17 23:06:43

version 1.126, 2017/06/24 14:38:27

Line 75

.Xr man 7

.Ic \&TH

macro.

This can also be used to perform style checks according to the

conventions of one operating system while running on a different

operating system; see

.Sx Style messages

for details.

.It Fl K Ar encoding

Specify the input encoding.

The supported

Line 151

Line 146

The

.Ar level

can be

.Cm base ,

.Cm style ,

.Cm warning ,

.Cm error ,

.Cm unsupp ;

.Cm unsupp .

The

.Cm base

level automatically derives the operating system from the contents of the

.Ic \&Os

macro, from the

.Fl Ios

command line option, or from the

.Xr uname 3

return value.

The levels

.Cm openbsd

and

.Cm netbsd

are variants of

.Cm base

that bypass autodetection and request validation of base system

conventions for a particular operating system.

The level

.Cm all

is an alias for

.Cm style .

.Cm base .

By default,

.Nm

is silent.

Line 224

Line 238

.It Fl T Cm lint

Parse only: produce no output.

Implies

.Fl W Cm style .

.Fl W Cm all .

.It Fl T Cm locale

Encode output using the current locale.

This is the default.

Line 596

Line 610

.Pp

.Bl -tag -width Ds -compact

.It 0

No style suggestions, warnings or errors occurred, or those that

No base system convention violations, style suggestions, warnings,

did were ignored because they were lower than the requested

or errors occurred, or those that did were ignored because they

were lower than the requested

.Ar level .

.It 1

At least one style suggestion occurred, but no warning or error, and

At least one base system convention violation or style suggestion

occurred, but no warning or error, and

.Fl W Cm base

.Fl W Cm style

was specified.

.It 2

At least one warning occurred, but no error, and

.Fl W Cm warning

or a lower

.Fl W Cm style

.Ar level

was specified.

was requested.

.It 3

At least one parsing error occurred,

but no unsupported feature was encountered, and

Line 636

Line 654

Note that selecting

.Fl T Cm lint

output mode implies

.Fl W Cm style .

.Fl W Cm all .

.Sh EXAMPLES

To page manuals to the terminal:

.Pp

Line 669

Line 687

Messages displayed by

.Nm

follow this format:

.Bd -ragged -offset indent

.Nm Ns :

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

.Pq Ar os

.Ed

.Pp

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

.Pp

Line and column numbers start at 1.

Both are omitted for messages referring to an input file as a whole.

Macro names and arguments are omitted where meaningless.

The

.Ar os

operating system specifier is omitted for messages that are relevant

for all operating systems.

Fatal messages about invalid command line arguments

or operating system errors, for example when memory is exhausted,

may also omit the

Line 732

Line 757

Please use your good judgement to decide whether any particular

.Cm style

suggestion really justifies a change to the input file.

.It Cm base

A convertion used in the base system of a specific operating system

is not adhered to.

These are not markup mistakes, and neither the quality of formatting

nor portability are in danger.

.El

.Pp

Messages of the

.Cm base ,

.Cm style ,

.Cm warning ,

.Cm error ,

Line 746

Line 777

option or

.Fl T Cm lint

output mode.

.Ss Style messages

.Pp

As indicated below, some style checks are only performed if a

As indicated below, all

specific operating system name occurs in the arguments of the

.Cm base

and some

.Cm style

checks are only performed if a specific operating system name occurs

in the arguments of the

.Fl W

command line option, of the

.Ic \&Os

macro, of the

.Fl Ios

Line 756

Line 793

of the

.Xr uname 3

function.

.Ss Conventions for base system manuals

.Bl -ohang

.It Sy "Mdocdate found"

.Pq mdoc , Nx

Line 778

Line 816

keyword substitution, but using it is conventionally expected in the

.Ox

base system.

.It Sy "RCS id missing"

.Pq Ox , Nx

The manual page lacks the comment line with the RCS identifier

generated by CVS

.Ic OpenBSD

.Ic NetBSD

keyword substitution as conventionally used in these operating systems.

.El

.Ss Style suggestions

.Bl -ohang

.It Sy "legacy man(7) date format"

.Pq mdoc

The

Line 791

Line 840

date format

.Dq "Month dd, yyyy"

instead.

.It Sy "RCS id missing"

.Pq Ox , Nx

The manual page lacks the comment line with the RCS identifier

generated by CVS

.Ic OpenBSD

.Ic NetBSD

keyword substitution as conventionally used in these operating systems.

.It Sy "duplicate RCS id"

A single manual page contains two copies of the RCS identifier for

the same operating system.