=================================================================== RCS file: /cvs/mandoc/Attic/mdoc.3,v retrieving revision 1.12 retrieving revision 1.16 diff -u -p -r1.12 -r1.16 --- mandoc/Attic/mdoc.3 2009/02/27 08:20:15 1.12 +++ mandoc/Attic/mdoc.3 2009/03/12 23:05:21 1.16 @@ -1,4 +1,4 @@ -.\" $Id: mdoc.3,v 1.12 2009/02/27 08:20:15 kristaps Exp $ +.\" $Id: mdoc.3,v 1.16 2009/03/12 23:05:21 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -16,7 +16,7 @@ .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: February 27 2009 $ +.Dd $Mdocdate: March 12 2009 $ .Dt mdoc 3 .Os .\" SECTION @@ -200,6 +200,7 @@ an asterisk and non-open-parenthesis .Sq \&* for single-character sequences; or one of a small set of standalone single characters for other escapes. +.\" PARAGRAPH .Pp Examples: .Pp @@ -230,6 +231,10 @@ prints .Dq \*q .Pq double-quote .El +.\" PARAGRAPH +.Pp +All escaped sequences are syntax-checked, but it's up to the front-end +system to correctly render them to the output device. .\" SUBSECTION .Ss Abstract Syntax Tree The @@ -355,6 +360,62 @@ parsed(mdoc, node); mdoc_free(mdoc); .Ed .\" SECTION +.Sh COMPATIBILITY +In general, only those macros specified by +.Xr mdoc.samples 7 +and +.Xr mdoc 7 +for +.Ox +and +.Nx +are supported; support for other +.Bx +systems is in progress. +.Bl -bullet +.\" LIST-ITEM +.It +.Sq \&Cd +isn't labelled as callable but is. +.\" LIST-ITEM +.It +NetBSD +.Sq \&It \-nested +is assumed for all lists: any list may be nested and +.Sq \-enum +lists will restart the sequence only for the sub-list. +.\" LIST-ITEM +.It +Newer NetBSD-style +.Sq \&It \-column +syntax, where column widths may be preceeded by other arguments (instead +of proceeded), is not supported. +.\" LIST-ITEM +.It +The +.Sq \&At +macro only accepts a single parameter. +.\" LIST-ITEM +.It +Some manuals use +.Sq \&Li +incorrectly by following it with a delimeter (see +.Xr mdoc.samples 7 ) +and expecting the delimiter to render. This is not supported. +.\" LIST-ITEM +.It +The system-name macros ( +.Ns Sq \&At , +.Sq \&Bsx , +.Sq \&Bx , +.Sq \&Fx , +.Sq \&Nx , +.Sq \&Ox , +and +.Sq \&Ux ) +are callable. +.El +.\" SECTION .Sh SEE ALSO .Xr mdoc 7 , .Xr mdoc.samples 7 , @@ -367,17 +428,11 @@ The utility was written by .An Kristaps Dzonsons Aq kristaps@kth.se . .\" SECTION -.Sh BUGS -Bugs, un-implemented macros and incompabilities are documented in this -section. The baseline for determining whether macro parsing is -.Qq incompatible -is the default -.Xr groff 1 -system bundled with -.Ox . -.\" PARAGRAPH -.Pp -Un-implemented: the +.Sh CAVEATS +.Bl -bullet +.\" LIST-ITEM +.It +The .Sq \&Xc and .Sq \&Xo @@ -385,36 +440,10 @@ macros aren't handled when used to span lines for the .Sq \&It macro. Such usage is specifically discouraged in .Xr mdoc.samples 7 . -.\" PARAGRAPH -.Pp -Bugs: when -.Sq \&It \-column -is invoked, whitespace is not stripped around -.Sq \&Ta -or tab-character separators. -.\" PARAGRAPH -.Pp -Bugs: elements within columns for -.Sq \&It \-column -are not yet supported. -.\" PARAGRAPH -.Pp -Incompatible: the -.Sq \&At -macro only accepts a single parameter. Furthermore, several macros -.Pf ( Sq \&Pp , -.Sq \&It , -and possibly others) accept multiple arguments with a warning. -.\" PARAGRAPH -.Pp -Incompatible: only those macros specified by -.Xr mdoc.samples 7 -and -.Xr mdoc 7 -for -.Ox -are supported; support for -.Nx -and other -.Bx -systems is in progress. +.\" LIST-ITEM +.It +The +.Sq \&Bsx +macro doesn't understand yet the arguments as dictated for +.Nx . +.El