=================================================================== RCS file: /cvs/mandoc/mandoc.1,v retrieving revision 1.148 retrieving revision 1.153 diff -u -p -r1.148 -r1.153 --- mandoc/mandoc.1 2015/02/06 08:28:35 1.148 +++ mandoc/mandoc.1 2015/02/16 16:23:54 1.153 @@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.148 2015/02/06 08:28:35 schwarze Exp $ +.\" $Id: mandoc.1,v 1.153 2015/02/16 16:23:54 schwarze Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons .\" Copyright (c) 2012, 2014, 2015 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: February 6 2015 $ +.Dd $Mdocdate: February 16 2015 $ .Dt MANDOC 1 .Os .Sh NAME @@ -23,7 +23,7 @@ .Nd format and display UNIX manuals .Sh SYNOPSIS .Nm mandoc -.Op Fl acfhklV +.Op Fl acfhkl .Sm off .Op Fl I Cm os Li = Ar name .Sm on @@ -150,8 +150,6 @@ See for available formats. Defaults to .Fl T Ns Cm locale . -.It Fl V -Print version and exit. .It Fl W Ns Ar level Specify the minimum message .Ar level @@ -729,9 +727,9 @@ macro occurs after some non-prologue macro, but still .Pq mdoc The .Ic \&Dt -macro can only occur before the first non-prologue macro -because traditional formatters write the page header -before parsing the document body. +macro appears after the first non-prologue macro. +Traditional formatters cannot handle this because +they write the page header before parsing the document body. Even though this technical restriction does not apply to .Nm , traditional semantics is preserved. @@ -836,7 +834,7 @@ manual for replacements. .Pq mdoc The name of a macro that is not callable appears on a macro line. It is printed verbatim. -If the intention is to call it, move it to its own line; +If the intention is to call it, move it to its own input line; otherwise, escape it by prepending .Sq \e& . .It Sy "skipping paragraph macro" @@ -1080,21 +1078,18 @@ list, an .Ic \&It block is empty. An empty list item is shown. -.It Sy "missing font type" +.It Sy "missing font type, using \efR" .Pq mdoc A .Ic \&Bf macro has no argument. -It switches to the default font, -.Cm \efR . -.It Sy "unknown font type" +It switches to the default font. +.It Sy "unknown font type, using \efR" .Pq mdoc The .Ic \&Bf argument is invalid. -The default font -.Cm \efR -is used instead. +The default font is used instead. .It Sy "nothing follows prefix" .Pq mdoc A @@ -1125,6 +1120,18 @@ The utility assumes .Fl std even when it is not specified, but other implementations may not. +.It Sy "missing option string, using \(dq\(dq" +.Pq man +The +.Ic \&OP +macro is invoked without any argument. +An empty pair of square brackets is shown. +.It Sy "missing resource identifier, using \(dq\(dq" +.Pq man +The +.Ic \&UR +macro is invoked without any argument. +An empty pair of angle brackets is shown. .It Sy "missing eqn box, using \(dq\(dq" .Pq eqn A diacritic mark or a binary operator is found, @@ -1189,6 +1196,15 @@ list has a .Fl width argument. That has no effect. +.It Sy "wrong number of cells" +In a line of a +.Ic \&Bl Fl column +list, the number of tabs or +.Ic \&Ta +macros is less than the number expected from the list header line +or exceeds the expected number by more than one. +Missing cells remain empty, and all cells exceeding the number of +columns are joined into one single cell. .It Sy "unknown AT&T UNIX version" .Pq mdoc An @@ -1240,6 +1256,12 @@ request or a layout modifier has an unknown .Ar font argument. +.It Sy "odd number of characters in request" +.Pq roff +A +.Ic \&tr +request contains an odd number of characters. +The last character is mapped to the blank character. .El .Ss "Warnings related to plain text" .Bl -ohang @@ -1476,7 +1498,7 @@ macros as well as tables require explicit closing by d A block that doesn't support bad nesting ends before all of its children are properly closed. The open child nodes are closed implicitly. -.It Sy "scope open on exit" +.It Sy "appending missing end of block" .Pq mdoc , man , eqn , tbl , roff At the end of the document, an explicit .Xr mdoc 7 @@ -1526,12 +1548,6 @@ When parsing for a request or a user-defined macro nam only the escape sequence is discarded. The characters preceding it are used as the request or macro name, the characters following it are used as the arguments to the request or macro. -.It Sy "argument count wrong" -.Pq mdoc , man , roff -The indicated request or macro has too few or too many arguments. -The syntax tree will contain the wrong number of arguments as given. -Formatting behaviour depends on the specific request or macro in question. -Note that the same message may also occur as a WARNING, see above. .It Sy "NOT IMPLEMENTED: Bd -file" .Pq mdoc For security reasons, the @@ -1645,26 +1661,41 @@ block closing request is invoked with at least one arg All arguments are ignored. .It Sy "skipping excess arguments" .Pq mdoc , man , roff -The +A macro or request is invoked with too many arguments: +.Bl -dash -offset 2n -width 2n -compact +.It +.Ic \&Fo , +.Ic \&PD , +.Ic \&RS , +.Ic \&UR , +.Ic \&ft , +or +.Ic \&sp +with more than one argument +.It .Ic \&An -macro is invoked with another argument after +with another argument after .Fl split or -.Fl nosplit , -.Ic \&Fo -is invoked with more than one argument, +.Fl nosplit +.It +.Ic \&RE +with more than one argument or with a non-integer argument +.It +.Ic \&OP +or a request of the +.Ic \&de +family with more than two arguments +.It +.Ic \&TH +with more than five arguments +.It .Ic \&Bd , .Ic \&Bk , or .Ic \&Bl -are invoked with invalid arguments, the -.Ic \&RE -macro is invoked with more than one argument -or with a non-integer argument, the -.Ic \&sp -request is invoked with more than one argument, or a request of the -.Ic \&de -family is invoked with more than two arguments. +with invalid arguments +.El The excess arguments are ignored. .El .Ss Unsupported features