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

Diff for /mandoc/mdoc.7 between version 1.23 and 1.30

version 1.23, 2009/06/10 20:18:43 version 1.30, 2009/06/17 14:08:47
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 73  or
Line 78  or
 .Sq \&.Bd \-unfilled  .Sq \&.Bd \-unfilled
 contexts.  contexts.
 .\" SUB-SECTION  .\" SUB-SECTION
   .Ss Comments
   Anything following a
   .Sq \e"
   delimiter is considered a comment (unless the
   .Sq \e
   itself has been escaped) and is ignored to the end of line.
   Furthermore, a macro line with only a control character
   .Sq \. ,
   optionally followed by whitespace, is ignored.
   .\" SUB-SECTION
 .Ss Reserved Characters  .Ss Reserved Characters
 Within a macro line, the following characters are reserved:  Within a macro line, the following characters are reserved:
 .Bl -tag -width 12n -offset XXXX -compact  .Bl -tag -width Ds -offset XXXX -compact
 .It \&.  .It \&.
 .Pq period  .Pq period
 .It \&,  .It \&,
Line 96  Within a macro line, the following characters are rese
Line 111  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 284  some 
Line 301  some 
 .Pc  .Pc
 don't have heads.  don't have heads.
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "Closing" -compact -offset XXXX  .Bl -column -compact -offset XXXX "MacroX" "CallableX" "ParsableX" "Closing"
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Closing
 .It \&.Sh    Ta    \&No    Ta    \&No    Ta    \&.Sh  .It \&.Sh    Ta    \&No    Ta    \&No    Ta    \&.Sh
 .It \&.Ss    Ta    \&No    Ta    \&No    Ta    \&.Sh, \&.Ss  .It \&.Ss    Ta    \&No    Ta    \&No    Ta    \&.Sh, \&.Ss
Line 296  None of these macros are callable or parsed.  The last
Line 313  None of these macros are callable or parsed.  The last
 the explicit scope rules.  All contains bodies, some may contain heads  the explicit scope rules.  All contains bodies, some may contain heads
 .Pq So \&Bf Sc .  .Pq So \&Bf Sc .
 .Pp  .Pp
 .Bl -column "MacroX" "CallableX" "ParsableX" "closed by XXX" -compact -offset XXXX  .Bl -column -compact -offset XXXX "MacroX" "CallableX" "ParsableX" "closed by XXX"
 .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope  .It Em Macro Ta Em Callable Ta Em Parsable Ta Em Scope
 .It \&.Bd    Ta    \&No    Ta    \&No    Ta    closed by \&.Ed  .It \&.Bd    Ta    \&No    Ta    \&No    Ta    closed by \&.Ed
 .It \&.Ed    Ta    \&No    Ta    \&No    Ta    opened by \&.Bd  .It \&.Ed    Ta    \&No    Ta    \&No    Ta    opened by \&.Bd
Line 393  then the macro accepts an arbitrary number of argument
Line 410  then the macro accepts an arbitrary number of argument
 .It \&.Os    Ta    \&No  Ta    \&No    Ta    n  .It \&.Os    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Pp    Ta    \&No  Ta    \&No    Ta    0  .It \&.Pp    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Ad    Ta    Yes   Ta    Yes     Ta    n  .It \&.Ad    Ta    Yes   Ta    Yes     Ta    n
 .It \&.An    Ta    \&No  Ta    Yes     Ta    n  .It \&.An    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ar    Ta    Yes   Ta    Yes     Ta    n  .It \&.Ar    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Cd    Ta    Yes   Ta    \&No    Ta    >0  .It \&.Cd    Ta    Yes   Ta    \&No    Ta    >0
 .It \&.Cm    Ta    Yes   Ta    Yes     Ta    n  .It \&.Cm    Ta    Yes   Ta    Yes     Ta    n
Line 405  then the macro accepts an arbitrary number of argument
Line 422  then the macro accepts an arbitrary number of argument
 .It \&.Fd    Ta    \&No  Ta    \&No    Ta    >0  .It \&.Fd    Ta    \&No  Ta    \&No    Ta    >0
 .It \&.Fl    Ta    Yes   Ta    Yes     Ta    n  .It \&.Fl    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Fn    Ta    Yes   Ta    Yes     Ta    >0  .It \&.Fn    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Ft    Ta    \&No  Ta    Yes     Ta    n  .It \&.Ft    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ic    Ta    Yes   Ta    Yes     Ta    >0  .It \&.Ic    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.In    Ta    \&No  Ta    \&No    Ta    n  .It \&.In    Ta    \&No  Ta    \&No    Ta    n
 .It \&.Li    Ta    Yes   Ta    Yes     Ta    n  .It \&.Li    Ta    Yes   Ta    Yes     Ta    n
Line 436  then the macro accepts an arbitrary number of argument
Line 453  then the macro accepts an arbitrary number of argument
 .It \&.Db    Ta    \&No  Ta    \&No    Ta    1  .It \&.Db    Ta    \&No  Ta    \&No    Ta    1
 .It \&.Em    Ta    Yes   Ta    Yes     Ta    >0  .It \&.Em    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n  .It \&.Fx    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Ms    Ta    \&No  Ta    Yes     Ta    >0  .It \&.Ms    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.No    Ta    Yes   Ta    Yes     Ta    0  .It \&.No    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Ns    Ta    Yes   Ta    Yes     Ta    0  .It \&.Ns    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Nx    Ta    Yes   Ta    Yes     Ta    n  .It \&.Nx    Ta    Yes   Ta    Yes     Ta    n
Line 455  then the macro accepts an arbitrary number of argument
Line 472  then the macro accepts an arbitrary number of argument
 .It \&.Lb    Ta    \&No  Ta    \&No    Ta    1  .It \&.Lb    Ta    \&No  Ta    \&No    Ta    1
 .It \&.Ap    Ta    Yes   Ta    Yes     Ta    0  .It \&.Ap    Ta    Yes   Ta    Yes     Ta    0
 .It \&.Lp    Ta    \&No  Ta    \&No    Ta    0  .It \&.Lp    Ta    \&No  Ta    \&No    Ta    0
 .It \&.Lk    Ta    \&No  Ta    Yes     Ta    >0  .It \&.Lk    Ta    Yes   Ta    Yes     Ta    n
 .It \&.Mt    Ta    \&No  Ta    Yes     Ta    >0  .It \&.Mt    Ta    Yes   Ta    Yes     Ta    >0
 .It \&.Es    Ta    \&No  Ta    \&No    Ta    0  .It \&.Es    Ta    \&No  Ta    \&No    Ta    0
 .It \&.En    Ta    \&No  Ta    \&No    Ta    0  .It \&.En    Ta    \&No  Ta    \&No    Ta    0
 .El  .El
Line 470  and
Line 487  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 \&.Fo  Historic groff has many un-callable macros.  Most of these (excluding
 and  some block-level macros) are now callable, conforming to the
 .Sq \&.St  non-historic groff version.
 historically weren't always callable.  Both are now correctly 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 501  The 
Line 529  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 531  is callable.
Line 550  is callable.
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@openbsd.org .  .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.23  
changed lines
  Added in v.1.30
CVSweb