summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-07-04 09:00:41 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-07-04 09:00:41 +0000
commitf2ddfbfe82c8d980d204eb501343ff94da2d568c (patch)
tree613ad022ae990d1c34c6e6ae80a58edbe72bdac1
parent843266ef22e83878a9e63d711f52a924355008a6 (diff)
downloadmandoc-f2ddfbfe82c8d980d204eb501343ff94da2d568c.tar.gz
mandoc-f2ddfbfe82c8d980d204eb501343ff94da2d568c.tar.zst
mandoc-f2ddfbfe82c8d980d204eb501343ff94da2d568c.zip
man.7/mdoc.7 properly reflect escape-character handling.
man.7 points to mdoc.7 for COMPATIBILITY. Whitespace stripping noted in mdoc.7.
-rw-r--r--man.716
-rw-r--r--mdoc.736
2 files changed, 40 insertions, 12 deletions
diff --git a/man.7 b/man.7
index b6bd47ba..fe2b2b8f 100644
--- a/man.7
+++ b/man.7
@@ -1,4 +1,4 @@
-.\" $Id: man.7,v 1.17 2009/06/25 11:35:28 kristaps Exp $
+.\" $Id: man.7,v 1.18 2009/07/04 09:00:41 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: June 25 2009 $
+.Dd $Mdocdate: July 4 2009 $
.Dt MAN 7
.Os
.\" SECTION
@@ -95,7 +95,12 @@ or a single one-character sequence.
.Pp
Characters may alternatively be escaped by a slash-asterisk,
.Sq \e* ,
-with the same combinations as described above. This form is deprecated.
+with the same combinations as described above.
+.Pp
+Terms may also be text-decorated using the
+.Sq \ef
+escape followed by a text-decoration letter: B (bold), I, (italic), or P
+and R (Roman, or reset).
.\" SUB-SECTION
.Ss Whitespace
Unless specifically escaped, consecutive blocks of whitespace are pruned
@@ -218,6 +223,11 @@ These follow the same calling conventions as the above
.Nm
macros.
.\" SECTION
+.Sh COMPATIBILITY
+See
+.Xr mdoc 7
+for groff compatibility notes.
+.\" SECTION
.Sh SEE ALSO
.Xr mandoc 1 ,
.Xr mandoc_char 7
diff --git a/mdoc.7 b/mdoc.7
index 57be6131..83313caa 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.7,v 1.34 2009/06/25 11:35:28 kristaps Exp $
+.\" $Id: mdoc.7,v 1.35 2009/07/04 09:00:41 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: June 25 2009 $
+.Dd $Mdocdate: July 4 2009 $
.Dt MDOC 7
.Os
.\" SECTION
@@ -136,7 +136,12 @@ or a single one-character sequence.
.Pp
Characters may alternatively be escaped by a slash-asterisk,
.Sq \e* ,
-with the same combinations as described above. This form is deprecated.
+with the same combinations as described above.
+.Pp
+Terms may also be text-decorated using the
+.Sq \ef
+escape followed by a text-decoration letter: B (bold), I, (italic), or P
+and R (Roman, or reset). This form is not recommended.
.\" SUB-SECTION
.Ss Whitespace
Unless in literal mode or specifically escaped, consecutive blocks of
@@ -522,13 +527,27 @@ file re-write
.Bl -dash -compact
.\" LIST-ITEM
.It
+Some character sequences in groff are not handled depending on escape
+style, e.g.,
+.Sq \e(ba
+and
+.Sq \e*(Ba
+may not be interchanged. This is no longer the case: all character
+sequences resolve to the same symbol, regardless the escape style.
+.\" LIST-ITEM
+.It
+Blocks of whitespace are stripped from both macro and free-form text
+lines (except when in literal mode), while groff would retain whitespace
+in free-form text lines.
+.\" LIST-ITEM
+.It
Historic groff has many un-callable macros. Most of these (excluding
some block-level macros) are now callable, conforming to the
non-historic groff version.
.\" LIST-ITEM
.It
The vertical bar
-.Sq \(Ba
+.Sq \(ba
made historic groff
.Qq go orbital
but is a proper delimiter in this implementation.
@@ -557,11 +576,10 @@ incorrectly by following it with a reserved character and expecting the
delimiter to render. This is not supported.
.\" LIST-ITEM
.It
-If an special-character control character
-.Sq \e
-is escaped, it will
-obviously not render the sequence. Even newer versions of groff seem to
-dither on this.
+If an special-character control character is escaped
+.Sq \e\e ,
+it will obviously not render the subsequent sequence. Even newer
+versions of groff seem to dither on this.
.El
.\" SECTION
.Sh SEE ALSO