=================================================================== RCS file: /cvs/mandoc/mandoc.1,v retrieving revision 1.26 retrieving revision 1.30 diff -u -p -r1.26 -r1.30 --- mandoc/mandoc.1 2009/07/20 13:45:11 1.26 +++ mandoc/mandoc.1 2009/08/19 09:14:50 1.30 @@ -1,4 +1,4 @@ -.\" $Id: mandoc.1,v 1.26 2009/07/20 13:45:11 kristaps Exp $ +.\" $Id: mandoc.1,v 1.30 2009/08/19 09:14:50 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -14,7 +14,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: July 20 2009 $ +.Dd $Mdocdate: August 19 2009 $ .Dt MANDOC 1 .Os .\" SECTION @@ -130,7 +130,7 @@ replaced on output by a single space. Thus, if you wi multiple spaces, they must be space-escaped .Sq \e\ or used in a literal display mode, e.g., -.Sq \&.Bd \-literal +.Sq \&Bd \-literal in .Xr mdoc 7 . .\" SUB-SECTION @@ -157,9 +157,9 @@ A third option, .Fl m Ns Ar andoc , which is also the default, determines encoding on-the-fly: if the first non-comment macro is -.Sq \&.Dd +.Sq \&Dd or -.Sq \&.Dt , +.Sq \&Dt , the .Xr mdoc 7 parser is used; otherwise, the @@ -227,6 +227,10 @@ Implies .Fl f Ns Ar no-ign-macro and .Fl f Ns Ar no-ign-chars . +.It Fl f Ns Ar ign-errors +Don't halt when encountering parse errors. Useful with +.Fl T Ns Ar lint +over a large set of manuals passed on the command line. .El .\" PARAGRAPH .Pp @@ -245,6 +249,12 @@ To page manuals to the terminal: .Pp .D1 % mandoc \-Wall,error \-fstrict mandoc.1 2>&1 | less .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less +.\" PARAGRAPH +.Pp +To check over a large set of manuals: +.\" PARAGRAPH +.Pp +.Dl % mandoc \-Tlint \-fign-errors `find /usr/src -name \e*\e.[1-9]` .\" SECTION .Sh COMPATIBILITY This section summarises @@ -253,21 +263,38 @@ compatibility with .Xr groff 1 . .Pp .Bl -bullet -compact +.\" LIST-ITEM .It +The +.Sq \e~ +special character doesn't produce expected behaviour. +.\" LIST-ITEM +.It +In +.Xr groff 1 , +the +.Sq \&Pa +macro does not underline when under a +.Sq \&It +in the FILES section. This behaves correctly in +.Nm . +.\" LIST-ITEM +.It A list or display following -.Sq \&.Ss +.Sq \&Ss does not assert a prior vertical break, just as it doesn't with -.Sq \&.Sh . +.Sq \&Sh . .It The \-literal and \-unfilled -.Sq \&.Bd +.Sq \&Bd displays types are synonyms, as are \-filled and \-ragged. +.\" LIST-ITEM .It Words aren't hyphenated. +.\" LIST-ITEM .It In normal mode (not a literal block), blocks of spaces aren't preserved, -so double spaces following sentence closure are reduced to a single space -.Pq Dq French spacing . +so double spaces following sentence closure are reduced to a single space. .El .\" SECTION .Sh SEE ALSO