version 1.189, 2017/05/30 19:30:38 |
version 1.198, 2017/06/11 17:16:51 |
|
|
.Xr man 7 |
.Xr man 7 |
.Ic \&TH |
.Ic \&TH |
macro. |
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 |
.It Fl K Ar encoding |
Specify the input encoding. |
Specify the input encoding. |
The supported |
The supported |
|
|
.It Fl T Cm lint |
.It Fl T Cm lint |
Parse only: produce no output. |
Parse only: produce no output. |
Implies |
Implies |
.Fl W Cm warning . |
.Fl W Cm style . |
.It Fl T Cm locale |
.It Fl T Cm locale |
Encode output using the current locale. |
Encode output using the current locale. |
This is the default. |
This is the default. |
Line 632 to exit at once, possibly in the middle of parsing or |
|
Line 637 to exit at once, possibly in the middle of parsing or |
|
Note that selecting |
Note that selecting |
.Fl T Cm lint |
.Fl T Cm lint |
output mode implies |
output mode implies |
.Fl W Cm warning . |
.Fl W Cm style . |
.Sh EXAMPLES |
.Sh EXAMPLES |
To page manuals to the terminal: |
To page manuals to the terminal: |
.Pp |
.Pp |
|
|
.Fl T Cm lint |
.Fl T Cm lint |
output mode. |
output mode. |
.Ss Style messages |
.Ss Style messages |
|
As indicated below, some style checks are only performed if a |
|
specific operating system name occurs in the arguments of the |
|
.Ic \&Os |
|
macro, of the |
|
.Fl Ios |
|
command line option, or, if neither are present, in the return value |
|
of the |
|
.Xr uname 3 |
|
function. |
.Bl -ohang |
.Bl -ohang |
.It Sy "useless macro" |
.It Sy "useless macro" |
.Pq mdoc |
.Pq mdoc |
|
|
.Ic \&Bt , |
.Ic \&Bt , |
.Ic \&Tn , |
.Ic \&Tn , |
or |
or |
.Ic \Ud |
.Ic \&Ud |
macro was found. |
macro was found. |
Simply delete it, it serves no useful purpose. |
Simply delete it: it serves no useful purpose. |
|
.It Sy "consider using OS macro" |
|
.Pq mdoc |
|
A string was found in plain text or in a |
|
.Ic \&Bx |
|
macro that could be represented using |
|
.Ic \&Ox , |
|
.Ic \&Nx , |
|
.Ic \&Fx , |
|
or |
|
.Ic \&Dx . |
|
.It Sy "errnos out of order" |
|
.Pq mdoc, Nx |
|
The |
|
.Ic \&Er |
|
items in a |
|
.Ic \&Bl |
|
list are not in alphabetical order. |
|
.It Sy "duplicate errno" |
|
.Pq mdoc, Nx |
|
A |
|
.Ic \&Bl |
|
list contains two consecutive |
|
.Ic \&It |
|
entries describing the same |
|
.Ic \&Er |
|
number. |
|
.It Sy "description line ends with a full stop" |
|
.Pq mdoc |
|
Do not use punctuation at the end of an |
|
.Ic \&Nd |
|
block. |
|
.It Sy "no blank before trailing delimiter" |
|
.Pq mdoc |
|
The last argument of a macro that supports trailing delimiter |
|
arguments is longer than one byte and ends with a trailing delimiter. |
|
Consider inserting a blank such that the delimiter becomes a separate |
|
argument, thus moving it out of the scope of the macro. |
|
.It Sy "function name without markup" |
|
.Pq mdoc |
|
A word followed by an empty pair of parentheses occurs on a text line. |
|
Consider using an |
|
.Ic \&Fn |
|
or |
|
.Ic \&Xr |
|
macro. |
.El |
.El |
.Ss Warnings related to the document prologue |
.Ss Warnings related to the document prologue |
.Bl -ohang |
.Bl -ohang |
|
|
.Ic \&Fn |
.Ic \&Fn |
macro contains an opening or closing parenthesis; that's probably wrong, |
macro contains an opening or closing parenthesis; that's probably wrong, |
parentheses are added automatically. |
parentheses are added automatically. |
|
.It Sy "unknown library name" |
|
.Pq mdoc, not on Ox |
|
An |
|
.Ic \&Lb |
|
macro has an unknown name argument and will be rendered as |
|
.Qq library Dq Ar name . |
.It Sy "invalid content in Rs block" |
.It Sy "invalid content in Rs block" |
.Pq mdoc |
.Pq mdoc |
An |
An |
Line 1701 whatever mode was active before the block. |
|
Line 1766 whatever mode was active before the block. |
|
A |
A |
.Ic \&Bl |
.Ic \&Bl |
macro fails to specify the list type. |
macro fails to specify the list type. |
|
.It Sy "argument is not numeric, using 1" |
|
.Pq roff |
|
The argument of a |
|
.Ic \&ce |
|
request is not a number. |
.It Sy "missing manual name, using \(dq\(dq" |
.It Sy "missing manual name, using \(dq\(dq" |
.Pq mdoc |
.Pq mdoc |
The first call to |
The first call to |