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

Diff for /mandoc/roff.7 between version 1.1 and 1.3

version 1.1, 2010/05/16 19:08:11 version 1.3, 2010/05/17 00:37:26
Line 65  Thus, the following are equivalent:
Line 65  Thus, the following are equivalent:
 .Sh REFERENCE  .Sh REFERENCE
 This section is a canonical reference of all macros, arranged  This section is a canonical reference of all macros, arranged
 alphabetically.  alphabetically.
   .Ss \&am
   The syntax of this macro is the same as that of
   .Sx \&ig ,
   except that a leading argument must be specified.
   It is ignored, as are its children.
   .Ss \&ami
   The syntax of this macro is the same as that of
   .Sx \&ig ,
   except that a leading argument must be specified.
   It is ignored, as are its children.
   .Ss \&am1
   The syntax of this macro is the same as that of
   .Sx \&ig ,
   except that a leading argument must be specified.
   It is ignored, as are its children.
   .Ss \&de
   The syntax of this macro is the same as that of
   .Sx \&ig ,
   except that a leading argument must be specified.
   It is ignored, as are its children.
   .Ss \&dei
   The syntax of this macro is the same as that of
   .Sx \&ig ,
   except that a leading argument must be specified.
   It is ignored, as are its children.
   .Ss \&de1
   The syntax of this macro is the same as that of
   .Sx \&ig ,
   except that a leading argument must be specified.
   It is ignored, as are its children.
 .Ss \&if  .Ss \&if
 Begins a conditional.  Begins a conditional that always evaluates to false.
 Has the following syntax:  If a conditional is false, its children are not processed, but are
   syntactically interpreted to preserve the integrity of the input
   document.
   Thus,
 .Pp  .Pp
   .D1 \&.if t \e .ig
   .Pp
   will discard the
   .Sq \&.ig ,
   which may lead to interesting results, but
   .Pp
   .D1 \&.if t \e .if t \e{\e
   .Pp
   will continue to syntactically interpret to the block close of the final
   conditional.
   Sub-conditionals, in this case, obviously inherit the truth value of
   the parent.
   This macro has the following syntax:
   .Pp
 .Bd -literal -offset indent -compact  .Bd -literal -offset indent -compact
 \&.if COND \e{\e  \&.if COND \e{\e
 BODY...  BODY...
Line 76  BODY...
Line 123  BODY...
 .Ed  .Ed
 .Bd -literal -offset indent -compact  .Bd -literal -offset indent -compact
 \&.if COND \e{ BODY  \&.if COND \e{ BODY
   BODY... \e}
   .Ed
   .Bd -literal -offset indent -compact
   \&.if COND \e{ BODY
 BODY...  BODY...
 \&.\e}  \&.\e}
 .Ed  .Ed
Line 84  BODY...
Line 135  BODY...
 BODY  BODY
 .Ed  .Ed
 .Pp  .Pp
 COND is a conditional (TODO: document).  COND is a conditional (for the time being, this always evaluates to
   false).
 .Pp  .Pp
 If the BODY section is begun by an escaped brace  If the BODY section is begun by an escaped brace
 .Sq \e{ ,  .Sq \e{ ,
Line 112  The scope of a conditional is always parsed, but only 
Line 164  The scope of a conditional is always parsed, but only 
 conditional evaluates to true.  conditional evaluates to true.
 .Pp  .Pp
 Note that text subsequent a  Note that text subsequent a
   .Sq \&.\e}
   macro is discarded.
   Furthermore, if an explicit closing sequence
 .Sq \e}  .Sq \e}
 is discarded.  is specified in a free-form line, the entire line is accepted within the
   scope of the prior macro, not only the text preceding the close.
 .Ss \&ig  .Ss \&ig
 Ignore input until a  Ignore input.
 .Sq \.\.  Accepts the following syntax:
   .Pp
   .Bd -literal -offset indent -compact
   \&.ig
   BODY...
   \&..
   .Ed
   .Bd -literal -offset indent -compact
   \&.ig END
   BODY...
   \&.END
   .Ed
   .Pp
   In the first case, input is ignored until a
   .Sq \&..
 macro is encountered on its own line.  macro is encountered on its own line.
 Note that text subsequent the  In the second case, input is ignored until a
 .Sq \.\.  .Sq \&.END
   is encountered.
   Text subsequent the
   .Sq \&.END
   or
   .Sq \&..
 is discarded.  is discarded.
   .Pp
   Do not use the escape
   .Sq \e
   anywhere in the definition of END.
   It causes very strange behaviour.
   Furthermore, if you redefine a
   .Nm
   macro, such as
   .Pp
   .D1 \&.ig if
   .Pp
   the subsequent invocation of
   .Sx \&if
   will first signify the end of comment, then be invoked as a macro.
   This behaviour really shouldn't be counted upon.
   .Sh COMPATIBILITY
   This section documents compatibility between mandoc and other other
   troff implementations, at this time limited to GNU troff
   .Pq Qq groff .
   The term
   .Qq historic groff
   refers to groff versions before the
   .Pa doc.tmac
   file re-write
   .Pq somewhere between 1.15 and 1.19 .
   .Pp
   .Bl -dash -compact
   .It
   Historic groff did not accept white-space buffering the custom END tag
   for the
   .Sx \&ig
   macro.
   .El
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.3
CVSweb