mandoc/roff.7 - diff

Return to roff.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/roff.7 between version 1.6 and 1.11

-version 1.6, 2010/05/24 22:25:58
+version 1.11, 2010/06/27 16:36:22
 Line 126  which may be separated by any intervening input (or no
 Line 126  which may be separated by any intervening input (or no
 Line 126  which may be separated by any intervening input (or no
  Its syntax is equivalent to
  .Sx \&if .
  .Ss \&if
- Begins a conditional that always evaluates to false.
+ Begins a conditional.
+ Right now, the conditional evaluates to true
+ if and only if it starts with the letter
+ .Sy n ,
+ indicating processing in
+ .Xr nroff 1
+ style as opposed to
+ .Xr troff 1
+ style.
  If a conditional is false, its children are not processed, but are
  syntactically interpreted to preserve the integrity of the input
  document.
-Line 165  BODY...
+Line 173  BODY...
 Line 165  BODY...
 Line 173  BODY...
  BODY
  .Ed
  .Pp
- COND is a conditional (for the time being, this always evaluates to
+ COND is a conditional statement.
- false).
+ roff allows for complicated conditionals; mandoc is much simpler.
+ At this time, mandoc supports only
+ .Sq n ,
+ evaluating to true;
+ and
+ .Sq t ,
+ .Sq e ,
+ and
+ .Sq o ,
+ evaluating to false.
+ All other invocations are read up to the next end of line or space and
+ evaluate as false.
  .Pp
  If the BODY section is begun by an escaped brace
  .Sq \e{ ,
-Line 199  macro is discarded.
+Line 218  macro is discarded.
 Line 199  macro is discarded.
 Line 218  macro is discarded.
  Furthermore, if an explicit closing sequence
  .Sq \e}
  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.
+ scope of the prior macro, not only the text preceding the close, with the
+ .Sq \e}
+ collapsing into a zero-width space.
  .Ss \&ig
  Ignore input.
  Accepts the following syntax:
-Line 247  This macro is intended to have one argument,
+Line 268  This macro is intended to have one argument,
 Line 247  This macro is intended to have one argument,
 Line 268  This macro is intended to have one argument,
  the name of the request, macro or string to be undefined.
  Currently, it is ignored including its arguments,
  and the number of arguments is not checked.
+ .Ss \&nr
+ Define a register.
+ A register is an arbitrary string value that defines some sort of state,
+ which influences parsing and/or formatting.
+ Its syntax is as follows:
+ .Pp
+ .D1 Pf \. Sx \&nr Cm name value
+ .Pp
+ The
+ .Cm value
+ may, at the moment, only be an integer.
+ The
+ .Cm name
+ is defined up to the next whitespace.
+ The following register
+ .Cm name
+ requests are recognised:
+ .Bl -tag -width Ds
+ .It Cm nS
+ If set to a positive integer value, certain
+ .Xr mdoc 7
+ macros will behave as if they were defined in the
+ .Em SYNOPSIS
+ section.
+ Otherwise, this behaviour is unset (even if called within the
+ .Em SYNOPSIS
+ section itself).
+ Note that invoking a new
+ .Xr mdoc 7
+ section will unset this value.
+ .El
  .Ss \&tr
  Output character translation.
  This macro is intended to have one argument,
  consisting of an even number of characters.
  Currently, it is ignored including its arguments,
  and the number of arguments is not checked.
-Line 265  file re-write
+Line 317  file re-write
 Line 265  file re-write
 Line 317  file re-write
  .Pq somewhere between 1.15 and 1.19 .
  .Pp
  .Bl -dash -compact
+ .It
+ The
+ .Cm nS
+ request to
+ .Sx \&nr
+ is only compatible with OpenBSD's groff.
  .It
  Historic groff did not accept white-space buffering the custom END tag
  for the

CVSweb