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

Diff for /mandoc/mdoc.7 between version 1.27 and 1.28

version 1.27, 2009/06/12 09:18:00 version 1.28, 2009/06/12 12:40:44
Line 31  language is used to format 
Line 31  language is used to format 
 manuals.  In this reference document, we describe the syntax, ontology  manuals.  In this reference document, we describe the syntax, ontology
 and structure of the  and structure of the
 .Nm  .Nm
 language.  language.  Our reference implementation is
   .Xr mandoc 1 .
   The
   .Sx COMPATIBILITY
   section describes compatibility with
   .Xr groff 1 .
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 An  An
Line 96  Within a macro line, the following characters are rese
Line 101  Within a macro line, the following characters are rese
 .Pq question  .Pq question
 .It \&!  .It \&!
 .Pq exclamation  .Pq exclamation
   .It \&|
   .Pq vertical bar
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
Line 470  and
Line 477  and
 macros are obsolete.  macros are obsolete.
 .\" SECTION  .\" SECTION
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 The mdoc language was traditionally a  This section documents compatibility with other roff implementations, at
 .Qq roff  this time limited to
 macro package; most existing manuals were written with mdoc syntax  .Xr groff 1 .
 dictated by system-dependent roff installations.  This section documents  The term
 compatibility with these systems.  .Qq historic groff
   refers to those versions before the
   .Pa doc.tmac
   file re-write
   .Pq somewhere between 1.15 and 1.19 .
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 .Sq \&.An ,  Historic groff has many un-callable macros.  Most of these (excluding
 .Sq \&.Fo ,  some block-level macros) are now callable, conforming to the
 .Sq \&.Lk ,  non-historic groff version.
 .Sq \&.Ms ,  
 .Sq \&.Mt ,  
 and  
 .Sq \&.St  
 historically weren't callable.  
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
   The vertical bar
   .Sq \(Ba
   made historic groff
   .Qq go orbital
   but is a proper delimiter in this implementation.
   .\" LIST-ITEM
   .It
 .Sq \&.It \-nested  .Sq \&.It \-nested
 is assumed for all lists: any list may be nested and  is assumed for all lists (it wasn't in historic groff): any list may be
   nested and
 .Sq \-enum  .Sq \-enum
 lists will restart the sequence only for the sub-list.  lists will restart the sequence only for the sub-list.
 .\" LIST-ITEM  .\" LIST-ITEM
Line 505  The 
Line 519  The 
 macro only accepts a single parameter.  macro only accepts a single parameter.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 The system-name macros (  
 .Ns Sq \&.At ,  
 .Sq \&.Bsx ,  
 .Sq \&.Bx ,  
 .Sq \&.Fx ,  
 .Sq \&.Nx ,  
 .Sq \&.Ox ,  
 and  
 .Sq \&.Ux )  
 are callable.  
 .\" LIST-ITEM  
 .It  
 Some manuals use  Some manuals use
 .Sq \&.Li  .Sq \&.Li
 incorrectly by following it with a reserved character and expecting the  incorrectly by following it with a reserved character and expecting the
 delimiter to render.  This is not supported.  delimiter to render.  This is not supported.
 .\" LIST-ITEM  .\" LIST-ITEM
 .It  .It
 .Sq \&.Cd  If an special-character control character
 is callable.  .Sq \e
   is escaped, it will
   obviously not render the sequence.  Even newer versions of groff seem to
   dither on this.
 .El  .El
 .\" SECTION  .\" SECTION
 .Sh SEE ALSO  .Sh SEE ALSO
Line 538  utility was written by 
Line 543  utility was written by 
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .\" SECTION  .\" SECTION
 .Sh CAVEATS  .Sh CAVEATS
 There are several ambiguous parts of mdoc.  There are many ambiguous parts of mdoc.
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .\" LIST-ITEM  .\" LIST-ITEM

Legend:
Removed from v.1.27  
changed lines
  Added in v.1.28

CVSweb