=================================================================== RCS file: /cvs/mandoc/mandoc.1,v retrieving revision 1.203 retrieving revision 1.210 diff -u -p -r1.203 -r1.210 --- mandoc/mandoc.1 2017/06/24 15:59:50 1.203 +++ mandoc/mandoc.1 2017/07/01 09:47:30 1.210 @@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.203 2017/06/24 15:59:50 schwarze Exp $ +.\" $Id: mandoc.1,v 1.210 2017/07/01 09:47:30 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons .\" Copyright (c) 2012, 2014-2017 Ingo Schwarze @@ -15,7 +15,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: June 24 2017 $ +.Dd $Mdocdate: July 1 2017 $ .Dt MANDOC 1 .Os .Sh NAME @@ -688,7 +688,7 @@ 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 @@ -816,6 +816,12 @@ 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 @@ -830,6 +836,14 @@ generated by CVS or .Ic NetBSD 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 .Ss Style suggestions .Bl -ohang @@ -851,6 +865,11 @@ 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 A @@ -1164,7 +1183,9 @@ 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 @@ -1205,6 +1226,12 @@ 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 A @@ -1272,6 +1299,7 @@ A .Ic \&Bl , .Ic \&D1 , .Ic \&Dl , +.Ic \&MT , .Ic \&RS , or .Ic \&UR @@ -1349,6 +1377,17 @@ list, an .Ic \&It block is empty. 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" .Pq mdoc A @@ -1407,6 +1446,8 @@ An empty pair of square brackets is shown. .It Sy "missing resource identifier, using \(dq\(dq" .Pq man The +.Ic \&MT +or .Ic \&UR macro is invoked without any argument. An empty pair of angle brackets is shown. @@ -1759,7 +1800,7 @@ An .Xr mdoc 7 block closing macro, a .Xr man 7 -.Ic \&RE +.Ic \&ME , \&RE or .Ic \&UE macro, an @@ -1793,7 +1834,7 @@ At the end of the document, an explicit block, a .Xr man 7 next-line scope or -.Ic \&RS +.Ic \&MT , \&RS or .Ic \&UR block, an equation, table, or @@ -1965,6 +2006,7 @@ 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 ,