From: schwarze <schwarze@openbsd.org>
Date: Sun, 30 Apr 2017 15:05:27 +0000 (+0000)
Subject: Mention that escaping "^" as "\(ha" in source code samples improves
X-Git-Url: http://artulab.com/gitweb/?a=commitdiff_plain;h=56fe46ebadb584af9f8937959a922b015243e178;p=openbsd

Mention that escaping "^" as "\(ha" in source code samples improves
portability, in particular when rendering to formats such as PDF
with real typesetters such as groff.

While here, make it even more explicit that the rendering of raw
ASCII accents ( ` ' ~ ^ ) found in the input is kind of a mess and
varies among implementations, software versions, macro sets, and
output devices.

Issue noticed when reading the groff_char(7) manual, and confirmed
by testing with current groff.

OK bentley@, "certainly no objection" jmc@

N.B.: Nobody will get scolded for ignoring this subtlety.
---

diff --git a/share/man/man7/mandoc_char.7 b/share/man/man7/mandoc_char.7
index e65213adfe8..f24a2b4fb45 100644
--- a/share/man/man7/mandoc_char.7
+++ b/share/man/man7/mandoc_char.7
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: mandoc_char.7,v 1.28 2017/02/05 21:39:54 schwarze Exp $
+.\"	$OpenBSD: mandoc_char.7,v 1.29 2017/04/30 15:05:27 schwarze Exp $
 .\"
 .\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org>
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
@@ -16,7 +16,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: February 5 2017 $
+.Dd $Mdocdate: April 30 2017 $
 .Dt MANDOC_CHAR 7
 .Os
 .Sh NAME
@@ -169,6 +169,8 @@ even on request and macro lines.
 .Ss Accents
 In output modes supporting such special output characters, for example
 .Fl T Cm pdf ,
+and sometimes less consistently in
+.Fl T Cm utf8 ,
 some
 .Xr roff 7
 formatters convert the following ASCII input characters to the
@@ -177,6 +179,7 @@ following Unicode special output characters:
 .It \(ga Ta U+2018 Ta left single quotation mark
 .It \(aq Ta U+2019 Ta right single quotation mark
 .It \(ti Ta U+02DC Ta small tilde
+.It \(ha Ta U+02C6 Ta modifier letter circumflex
 .El
 .Pp
 In prose, this automatic substitution is often desirable;
@@ -187,6 +190,7 @@ escaping to render as follows:
 .It \e(ga Ta U+0060 Ta grave accent
 .It \e(aq Ta U+0027 Ta apostrophe
 .It \e(ti Ta U+007E Ta tilde
+.It \e(ha Ta U+005E Ta circumflex accent
 .El
 .Ss Periods
 The period