=================================================================== RCS file: /cvs/mandoc/mandoc.1,v retrieving revision 1.16 retrieving revision 1.20 diff -u -p -r1.16 -r1.20 --- mandoc/mandoc.1 2009/04/12 19:45:26 1.16 +++ mandoc/mandoc.1 2009/06/17 19:12:03 1.20 @@ -1,6 +1,6 @@ -.\" $Id: mandoc.1,v 1.16 2009/04/12 19:45:26 kristaps Exp $ +.\" $Id: mandoc.1,v 1.20 2009/06/17 19:12:03 kristaps Exp $ .\" -.\" Copyright (c) 2009 Kristaps Dzonsons +.\" Copyright (c) 2009 Kristaps Dzonsons .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above @@ -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: April 12 2009 $ +.Dd $Mdocdate: June 17 2009 $ .Dt MANDOC 1 .Os .\" SECTION @@ -37,20 +37,20 @@ The utility formats .Ux manual pages for display. The arguments are as follows: -.Bl -tag -width XXXXXXXXXXXX +.Bl -tag -width Ds .\" ITEM .It Fl f Ns Ar option... Override default compiler behaviour. See .Sx Compiler Options for details. .\" ITEM -.It Fl m +.It Fl m Ns Ar format Input format. See .Sx Input Formats for available formats. Defaults to .Fl m Ns Ar andoc . .\" ITEM -.It Fl T +.It Fl T Ns Ar output Output format. See .Sx Output Formats for available formats. Defaults to @@ -188,7 +188,7 @@ The utility accepts the following .Fl T arguments: -.Bl -tag -width XXXXXXXXXXXX +.Bl -tag -width Ds .It Fl T Ns Ar ascii Produce 7-bit ASCII output, backspace-encoded for bold and underline styles. This is the default. @@ -205,7 +205,7 @@ corresponding filter in-order. Default compiler behaviour may be overriden with the .Fl f flag. -.Bl -tag -width XXXXXXXXXXXXXX +.Bl -tag -width Ds .It Fl f Ns Ar ign-scope When rewinding the scope of a block macro, forces the compiler to ignore scope violations. This can seriously mangle the resulting tree. @@ -239,51 +239,43 @@ To page manuals to the terminal: .Pp .D1 % mandoc mandoc.1 mdoc.3 mdoc.7 | less .\" SECTION +.Sh COMPATIBILITY +This section summarises +.Nm +compatibility with +.Xr groff 1 . +.Pp +.Bl -bullet -compact +.It +A list or display following +.Sq \&.Ss +does not assert a prior vertical break, just as it doesn't with +.Sq \&.Sh . +.\" LIST-ITEM +.It +The \-literal and \-unfilled +.Sq \&.Bd +displays types are synonyms, as are \-filled and \-ragged. +.\" LIST-ITEM +.It +Words aren't hyphenated. +.El +.\" SECTION .Sh SEE ALSO .Xr mandoc_char 7 , .Xr mdoc 7 , .Xr man 7 -.\" +.\" SECTION .Sh AUTHORS The .Nm utility was written by -.An Kristaps Dzonsons Aq kristaps@openbsd.org . +.An Kristaps Dzonsons Aq kristaps@kth.se . .\" SECTION .Sh CAVEATS The .Nm -utility in -.Fl T Ns Ar ascii -mode doesn't yet know how to display the following: +utility doesn't yet know how to display \-hang lists. .Pp -.Bl -bullet -compact -.It -The \-hang -.Sq \&.Bl -list is not yet supported. -.El -.Pp Other macros still aren't supported by virtue of nobody complaining -about their absence. Please report any omissions: this is a work in -progress. -.Pp -The following list documents differences between traditional -.Xr nroff 1 -output and -.Nm : -.Pp -.Bl -bullet -compact -.It -A list of display following -.Sq \&.Ss -does not assert a prior vertical break, just as it doesn't with -.Sq \&.Sh . -.It -Special characters don't follow the current font style. -.\" LIST-ITEM -.It -The \-literal and \-unfilled -.Sq \&.Bd -displays types are synonyms, as are \-filled and \-ragged. -.El +about their absence.