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

Diff for /mandoc/mdoc.7 between version 1.45 and 1.46

version 1.45, 2009/07/17 12:40:48 version 1.46, 2009/07/17 14:51:04
Line 49  prior macros:
Line 49  prior macros:
 Other lines are interpreted within the current state.  Other lines are interpreted within the current state.
 .Ed  .Ed
 .\" SECTION---------------------------------------------  .\" SECTION---------------------------------------------
 .Sh INPUT ENCODING  .Sh LANGUAGE SYNTAX
 .Nm  .Nm
 documents may contain only graphable 7-bit ASCII characters, the space  documents may contain only graphable 7-bit ASCII characters, the space
 character, and, in certain circumstances, the tab character.  All  character, and, in certain circumstances, the tab character.  All
 manuals must have  manuals must have
 .Ux  .Ux
 line termination.  line terminators.
 .\" SUB-SECTION----------------------  .\" SUB-SECTION----------------------
 .Ss Comments  .Ss Comments
 Text following a  Text following a
Line 133  escape followed by an indicator: B (bold), I, (italic)
Line 133  escape followed by an indicator: B (bold), I, (italic)
 (Roman, or reset).  This form is not recommended.  (Roman, or reset).  This form is not recommended.
 .\" SUB-SECTION----------------------  .\" SUB-SECTION----------------------
 .Ss Whitespace  .Ss Whitespace
 In general, consecutive blocks of whitespace are pruned from input.  In non-literal free-form lines, consecutive blocks of whitespace are
 These are later re-added, when applicable, by  pruned from input and added later in the output filter, if applicable:
 .Xr mandoc 1 .  .Bd -literal -offset indent
   These     spaces   are    pruned       from    input.
   \&.Bd \-literal
   These         are              not.
   \&.Ed
   .Ed
 .\" PARAGRAPH------------  .\" PARAGRAPH------------
 .Pp  .Pp
 Blank lines are permitted within  In macro lines, whitespace delimits arguments and is discarded.  If
 .Sq \&Bd \-literal  arguments are quoted, whitespace is conditionally retained within the
 or  quotes.
 .Sq \&Bd \-unfilled  .\" TODO: which do and which don't?
 contexts.  Tab characters are only acceptable when delimiting  .\" PARAGRAPH------------
   .Pp
   Blank lines are only permitted within literal contexts, as are lines
   containing only whitespace.  Tab characters are only acceptable when
   delimiting
 .Sq \&Bl \-column  .Sq \&Bl \-column
 and in  or when in a literal context.
 .Sq \&Bd \-literal  .\" SUB-SECTION----------------------
 or  .Ss Quotation
 .Sq \&Bd \-unfilled  Macro arguments may be quoted with a double-quote to group
 contexts.  space-delimited terms or to retain blocks of whitespace.  A quoted
   argument begins with a double-quote preceded by whitespace.  The next
   double-quote terminates the term, regardless of surrounding whitespace.
   .\" PARAGRAPH------------
   .Pp
   In free-form mode, quotes are regarded as opaque text.
 .\" SECTION---------------------------------------------  .\" SECTION---------------------------------------------
 .Sh MANUAL STRUCTURE  .Sh MANUAL STRUCTURE
 Each  Each
Line 157  document must begin with a document prologue, containi
Line 171  document must begin with a document prologue, containi
 .Sq \&Dd ,  .Sq \&Dd ,
 .Sq \&Dt ,  .Sq \&Dt ,
 and  and
 .Sq \&Os  .Sq \&Os ,
 (using this manual as an example):  then the NAME section containing at least one
   .Sq \&Nm
   followed by
   .Sq \&Nd :
 .Bd -literal -offset indent  .Bd -literal -offset indent
 \&.Dd $\&Mdocdate$  \&.Dd $\&Mdocdate$
 \&.Dt mdoc 7  \&.Dt mdoc 7
Line 167  and
Line 184  and
 \&.Nm mdoc  \&.Nm mdoc
 \&.Nd mdoc language reference  \&.Nd mdoc language reference
 .Ed  .Ed
 .Pp  
 Following these, the document body must begin with the NAME section  
 containing at least one  
 .Sq \&Nm  
 followed by  
 .Sq \&Nd .  
 .\" PARAGRAPH------------  .\" PARAGRAPH------------
 .Pp  .Pp
 Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,  Subsequent SYNOPSIS and DESCRIPTION sections are strongly encouraged,
Line 181  but non-compulsory. 
Line 192  but non-compulsory. 
 .Sh MACRO SYNTAX  .Sh MACRO SYNTAX
 Every line beginning with the control character  Every line beginning with the control character
 .Sq \.  .Sq \.
 is processed for macros, two- or three-character semantic annotations.  is processed for macros, two- or three-character sequences.
 .\" PARAGRAPH------------  .\" PARAGRAPH------------
 .Pp  .Pp
 The syntax of macro depends on its classification.  In this section,  The syntax of a macro depends on its classification.  In this section,
 .Sq \-arg  .Sq \-arg
 refers to macro arguments, which may be followed by zero or more  refers to macro arguments, which may be followed by zero or more
 .Sq parm  .Sq parm
Line 199  The
Line 210  The
 .Em Callable  .Em Callable
 column indicates that the macro may be called subsequent to the initial  column indicates that the macro may be called subsequent to the initial
 line-macro.  The  line-macro.  The
 .Qq Parsable  .Em Parsable
 column indicates whether the macro may be followed by further  column indicates whether the macro may be followed by further
 (ostensibly callable) macros.  The  (ostensibly callable) macros.  The
 .Em Scope  .Em Scope
Line 504  macro only produces the first parameter.  This is no l
Line 515  macro only produces the first parameter.  This is no l
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  reference was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons Aq kristaps@kth.se .
 .\" SECTION---------------------------------------------  .\" SECTION---------------------------------------------
 .Sh CAVEATS  .Sh CAVEATS

Legend:
Removed from v.1.45  
changed lines
  Added in v.1.46

CVSweb