diff options
author | Kristaps Dzonsons <kristaps@bsd.lv> | 2010-05-17 00:37:26 +0000 |
---|---|---|
committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2010-05-17 00:37:26 +0000 |
commit | ed77c8c0f32c51892ac65e7c6483243843597b43 (patch) | |
tree | de89f9109adfc6af2690c6d32289610ee4fb51ce /roff.7 | |
parent | 218a7feb401f88a33b42705d4480f2b85b9044d5 (diff) | |
download | mandoc-ed77c8c0f32c51892ac65e7c6483243843597b43.tar.gz |
libroff now intelligently throws away `am', `ami', `am1', `de', `dei',
and `de1'. This is also documented in roff.7.
Diffstat (limited to 'roff.7')
-rw-r--r-- | roff.7 | 54 |
1 files changed, 51 insertions, 3 deletions
@@ -65,9 +65,56 @@ Thus, the following are equivalent: .Sh REFERENCE This section is a canonical reference of all macros, arranged 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 -Begins a conditional. -Has the following syntax: +Begins a conditional that always evaluates to false. +If a conditional is false, its children are not processed, but are +syntactically interpreted to preserve the integrity of the input +document. +Thus, +.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 \&.if COND \e{\e @@ -88,7 +135,8 @@ BODY... BODY .Ed .Pp -COND is a conditional (TODO: document). +COND is a conditional (for the time being, this always evaluates to +false). .Pp If the BODY section is begun by an escaped brace .Sq \e{ , |