[BACK]Return to mdoc.3 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/mdoc.3 between version 1.11 and 1.15

version 1.11, 2009/02/25 17:02:47 version 1.15, 2009/03/12 16:30:50
Line 184  The
Line 184  The
 .Xr mdoc 3  .Xr mdoc 3
 library accepts only printable ASCII characters as defined by  library accepts only printable ASCII characters as defined by
 .Xr isprint 3 .  .Xr isprint 3 .
 Non-ASCII character sequences are escaped with an escape character  Non-ASCII character sequences are delimited in various ways.  All are
   preceeded by an escape character
 .Sq \\  .Sq \\
 and followed by either an open-parenthesis  and followed by either an open-parenthesis
 .Sq \&(  .Sq \&(
Line 192  for two-character sequences; an open-bracket
Line 193  for two-character sequences; an open-bracket
 .Sq \&[  .Sq \&[
 for n-character sequences (terminated at a close-bracket  for n-character sequences (terminated at a close-bracket
 .Sq \&] ) ;  .Sq \&] ) ;
 or one of a small set of single characters for other escapes.  an asterisk and open-parenthesis
   .Sq \&*(
   for two-character sequences;
   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
   .Bl -tag -width "XXXXXXXX" -offset "XXXX" -compact
   .\" LIST-ITEM
   .It \\*(<=
   prints
   .Dq \*(<=
   .Pq greater-equal
   .\" LIST-ITEM
   .It \\(<-
   prints
   .Dq \(<-
   .Pq left-arrow
   .\" LIST-ITEM
   .It \\[<-]
   also prints
   .Dq \(<-
   .Pq left-arrow
   .\" LIST-ITEM
   .It \\*(Ba
   prints
   .Dq \*(Ba
   .Pq bar
   .\" LIST-ITEM
   .It \\*q
   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  .\" SUBSECTION
 .Ss Abstract Syntax Tree  .Ss Abstract Syntax Tree
 The  The
Line 318  parsed(mdoc, node);
Line 360  parsed(mdoc, node);
 mdoc_free(mdoc);  mdoc_free(mdoc);
 .Ed  .Ed
 .\" SECTION  .\" 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
   .Sq Bx
   family of macros (
   .Sq Ux ,
   .Sq Nx
   and so on) are not callable as they are in NetBSD.
   .El
   .\" SECTION
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mdoc 7 ,  .Xr mdoc 7 ,
 .Xr mdoc.samples 7 ,  .Xr mdoc.samples 7 ,
Line 330  The
Line 424  The
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .\" SECTION  .\" SECTION
 .Sh BUGS  .Sh CAVEATS
 Bugs, un-implemented macros and incompabilities are documented in this  .Bl -bullet
 section.  The baseline for determining whether macro parsing is  .\" LIST-ITEM
 .Qq incompatible  .It
 is the default  The
 .Xr groff 1  
 system bundled with  
 .Ox .  
 .\" PARAGRAPH  
 .Pp  
 Un-implemented: the  
 .Sq \&Xc  .Sq \&Xc
 and  and
 .Sq \&Xo  .Sq \&Xo
Line 348  macros aren't handled when used to span lines for the
Line 436  macros aren't handled when used to span lines for the
 .Sq \&It  .Sq \&It
 macro.  Such usage is specifically discouraged in  macro.  Such usage is specifically discouraged in
 .Xr mdoc.samples 7 .  .Xr mdoc.samples 7 .
 .\" PARAGRAPH  .El
 .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.  
Legend:
Removed from v.1.11  
changed lines
  Added in v.1.15
CVSweb