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

Diff for /mandoc/roff.7 between version 1.7 and 1.14

version 1.7, 2010/05/24 23:54:18 version 1.14, 2010/07/27 13:16:00
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
   .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above  .\" purpose with or without fee is hereby granted, provided that the above
Line 91  The syntax of this macro is the same as that of
Line 92  The syntax of this macro is the same as that of
 except that a leading argument must be specified.  except that a leading argument must be specified.
 It is ignored, as are its children.  It is ignored, as are its children.
 .Ss \&ds  .Ss \&ds
 Define a string.  Define a reserved word.
 This macro is intended to have two arguments,  Its syntax is as follows:
 the name of the string to define and its content.  .Pp
 Currently, it is ignored including its arguments,  .D1 Pf \. Sx \&ds No Cm key val
 and the number of arguments is not checked.  .Pp
   The
   .Cm key
   and
   .Cm val
   strings are space-separated.
   The
   .Cm key
   values may be invoked in subsequent text by using \e*(NN for two-letter
   pairs, \e*N for one-letter, and \e*[NNN] for arbitrary-length values.
   .Pp
   If
   .Cm val
   is begun with a double-quote mark, the mark is passed over.
   .Cm val
   consists of
   .Em all
   text following this point, including whitespace and trailing
   double-quotes.
 .Ss \&de1  .Ss \&de1
 The syntax of this macro is the same as that of  The syntax of this macro is the same as that of
 .Sx \&ig ,  .Sx \&ig ,
Line 173  BODY...
Line 192  BODY...
 BODY  BODY
 .Ed  .Ed
 .Pp  .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  .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 207  macro is discarded.
Line 237  macro is discarded.
 Furthermore, if an explicit closing sequence  Furthermore, if an explicit closing sequence
 .Sq \e}  .Sq \e}
 is specified in a free-form line, the entire line is accepted within the  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  .Ss \&ig
 Ignore input.  Ignore input.
 Accepts the following syntax:  Accepts the following syntax:
Line 255  This macro is intended to have one argument,
Line 287  This macro is intended to have one argument,
 the name of the request, macro or string to be undefined.  the name of the request, macro or string to be undefined.
 Currently, it is ignored including its arguments,  Currently, it is ignored including its arguments,
 and the number of arguments is not checked.  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  .Ss \&tr
 Output character translation.  Output character translation.
 This macro is intended to have one argument,  This macro is intended to have one argument,
Line 273  file re-write
Line 336  file re-write
 .Pq somewhere between 1.15 and 1.19 .  .Pq somewhere between 1.15 and 1.19 .
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
   .It
   The
   .Cm nS
   request to
   .Sx \&nr
   is only compatible with OpenBSD's groff.
 .It  .It
 Historic groff did not accept white-space buffering the custom END tag  Historic groff did not accept white-space buffering the custom END tag
 for the  for the
Legend:
Removed from v.1.7  
changed lines
  Added in v.1.14
CVSweb