source@mandoc.bsd.lv
 help / color / mirror / Atom feed
* mdocml: Escape punctuation characters that have a different meaning in
@ 2015-03-30 16:06 schwarze
  0 siblings, 0 replies; only message in thread
From: schwarze @ 2015-03-30 16:06 UTC (permalink / raw)
  To: source

Log Message:
-----------
Escape punctuation characters that have a different meaning in -Tpdf.

~, `, and ' get translated to non-ASCII characters by most troff
implementations when generating PostScript/PDF output.  When the
original ASCII character is meant, it needs to be manually escaped.

Patch from bentley@.

Modified Files:
--------------
    mdocml:
        apropos.1
        eqn.7
        mandoc.1
        mandoc_char.7

Revision Data
-------------
Index: apropos.1
===================================================================
RCS file: /home/cvs/mdocml/mdocml/apropos.1,v
retrieving revision 1.37
retrieving revision 1.38
diff -Lapropos.1 -Lapropos.1 -u -p -r1.37 -r1.38
--- apropos.1
+++ apropos.1
@@ -210,7 +210,7 @@ This has syntax
 .Sm off
 .Oo
 .Op Ar key Op , Ar key ...
-.Pq Cm = | ~
+.Pq Cm = | \(ti
 .Oc
 .Ar val ,
 .Sm on
@@ -227,7 +227,7 @@ for a list of available keys.
 Operator
 .Cm =
 evaluates a substring, while
-.Cm ~
+.Cm \(ti
 evaluates a regular expression.
 .It Fl i Ar term
 If
@@ -398,7 +398,7 @@ as well:
 .Pp
 Search in names and descriptions using a regular expression:
 .Pp
-.Dl $ apropos '~set.?[ug]id'
+.Dl $ apropos \(aq\(tiset.?[ug]id\(aq
 .Pp
 Search for manuals in the library section mentioning both the
 .Qq optind
@@ -413,15 +413,15 @@ Do exactly the same as calling
 with the argument
 .Qq ssh :
 .Pp
-.Dl $ apropos \-\- \-i 'Nm~[[:<:]]ssh[[:>:]]'
+.Dl $ apropos \-\- \-i \(aqNm\(ti[[:<:]]ssh[[:>:]]\(aq
 .Pp
 The following two invocations are equivalent:
 .Pp
 .D1 Li $ apropos -S Ar arch Li -s Ar section expression
 .Bd -ragged -offset indent
 .Li $ apropos \e( Ar expression Li \e)
-.Li -a arch~^( Ns Ar arch Ns Li |any)$
-.Li -a sec~^ Ns Ar section Ns Li $
+.Li -a arch\(ti^( Ns Ar arch Ns Li |any)$
+.Li -a sec\(ti^ Ns Ar section Ns Li $
 .Ed
 .Sh SEE ALSO
 .Xr man 1 ,
Index: eqn.7
===================================================================
RCS file: /home/cvs/mdocml/mdocml/eqn.7,v
retrieving revision 1.34
retrieving revision 1.35
diff -Leqn.7 -Leqn.7 -u -p -r1.34 -r1.35
--- eqn.7
+++ eqn.7
@@ -146,7 +146,7 @@ is used as the delimiter for the value
 .Ar val .
 This allows for arbitrary enclosure of terms (not just quotes), such as
 .Pp
-.D1 Cm define Ar foo 'bar baz'
+.D1 Cm define Ar foo \(aqbar baz\(aq
 .D1 Cm define Ar foo cbar bazc
 .Pp
 It is an error to have an empty
@@ -166,8 +166,8 @@ created.
 Definitions can create arbitrary strings, for example, the following is
 a legal construction.
 .Bd -literal -offset indent
-define foo 'define'
-foo bar 'baz'
+define foo \(aqdefine\(aq
+foo bar \(aqbaz\(aq
 .Ed
 .Pp
 Self-referencing definitions will raise an error.
Index: mandoc.1
===================================================================
RCS file: /home/cvs/mdocml/mdocml/mandoc.1,v
retrieving revision 1.157
retrieving revision 1.158
diff -Lmandoc.1 -Lmandoc.1 -u -p -r1.157 -r1.158
--- mandoc.1
+++ mandoc.1
@@ -566,7 +566,7 @@ as the style-sheet:
 .Pp
 To check over a large set of manuals:
 .Pp
-.Dl $ mandoc \-T lint `find /usr/src -name \e*\e.[1-9]`
+.Dl $ mandoc \-T lint \(gafind /usr/src -name \e*\e.[1-9]\(ga
 .Pp
 To produce a series of PostScript manuals for A4 paper:
 .Pp
Index: mandoc_char.7
===================================================================
RCS file: /home/cvs/mdocml/mdocml/mandoc_char.7,v
retrieving revision 1.61
retrieving revision 1.62
diff -Lmandoc_char.7 -Lmandoc_char.7 -u -p -r1.61 -r1.62
--- mandoc_char.7
+++ mandoc_char.7
@@ -218,7 +218,7 @@ Spacing:
 .Bl -column "Input" "Description" -offset indent -compact
 .It Em Input Ta Em Description
 .It Sq \e\ \& Ta unpaddable non-breaking space
-.It \e~      Ta paddable non-breaking space
+.It \e\(ti   Ta paddable non-breaking space
 .It \e0      Ta unpaddable, breaking digit-width space
 .It \e|      Ta one-sixth \e(em narrow space, zero width in nroff mode
 .It \e^      Ta one-twelfth \e(em half-narrow space, zero width in nroff
@@ -393,9 +393,9 @@ Mathematical:
 .It \e(ne    Ta \(ne        Ta not equivalent
 .It \e(ap    Ta \(ap        Ta tilde operator
 .It \e(|=    Ta \(|=        Ta asymptotically equal
-.It \e(=~    Ta \(=~        Ta approximately equal
-.It \e(~~    Ta \(~~        Ta almost equal
-.It \e(~=    Ta \(~=        Ta almost equal
+.It \e(=\(ti Ta \(=~        Ta approximately equal
+.It \e(\(ti\(ti Ta \(~~        Ta almost equal
+.It \e(\(ti= Ta \(~=        Ta almost equal
 .It \e(pt    Ta \(pt        Ta proportionate
 .It \e(es    Ta \(es        Ta empty set
 .It \e(mo    Ta \(mo        Ta element
@@ -458,15 +458,15 @@ Accents:
 .It \e(a.    Ta \(a.        Ta dotted
 .It \e(a^    Ta \(a^        Ta circumflex
 .It \e(aa    Ta \(aa        Ta acute
-.It \e'      Ta \'          Ta acute
+.It \e\(aq   Ta \'          Ta acute
 .It \e(ga    Ta \(ga        Ta grave
-.It \e`      Ta \`          Ta grave
+.It \e\(ga   Ta \`          Ta grave
 .It \e(ab    Ta \(ab        Ta breve
 .It \e(ac    Ta \(ac        Ta cedilla
 .It \e(ad    Ta \(ad        Ta dieresis
 .It \e(ah    Ta \(ah        Ta caron
 .It \e(ao    Ta \(ao        Ta ring
-.It \e(a~    Ta \(a~        Ta tilde
+.It \e(a\(ti Ta \(a~        Ta tilde
 .It \e(ho    Ta \(ho        Ta ogonek
 .It \e(ha    Ta \(ha        Ta hat (text)
 .It \e(ti    Ta \(ti        Ta tilde (text)
@@ -475,32 +475,32 @@ Accents:
 Accented letters:
 .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description
-.It \e('A    Ta \('A        Ta acute A
-.It \e('E    Ta \('E        Ta acute E
-.It \e('I    Ta \('I        Ta acute I
-.It \e('O    Ta \('O        Ta acute O
-.It \e('U    Ta \('U        Ta acute U
-.It \e('a    Ta \('a        Ta acute a
-.It \e('e    Ta \('e        Ta acute e
-.It \e('i    Ta \('i        Ta acute i
-.It \e('o    Ta \('o        Ta acute o
-.It \e('u    Ta \('u        Ta acute u
-.It \e(`A    Ta \(`A        Ta grave A
-.It \e(`E    Ta \(`E        Ta grave E
-.It \e(`I    Ta \(`I        Ta grave I
-.It \e(`O    Ta \(`O        Ta grave O
-.It \e(`U    Ta \(`U        Ta grave U
-.It \e(`a    Ta \(`a        Ta grave a
-.It \e(`e    Ta \(`e        Ta grave e
-.It \e(`i    Ta \(`i        Ta grave i
-.It \e(`o    Ta \(`i        Ta grave o
-.It \e(`u    Ta \(`u        Ta grave u
-.It \e(~A    Ta \(~A        Ta tilde A
-.It \e(~N    Ta \(~N        Ta tilde N
-.It \e(~O    Ta \(~O        Ta tilde O
-.It \e(~a    Ta \(~a        Ta tilde a
-.It \e(~n    Ta \(~n        Ta tilde n
-.It \e(~o    Ta \(~o        Ta tilde o
+.It \e(\(aqA Ta \('A        Ta acute A
+.It \e(\(aqE Ta \('E        Ta acute E
+.It \e(\(aqI Ta \('I        Ta acute I
+.It \e(\(aqO Ta \('O        Ta acute O
+.It \e(\(aqU Ta \('U        Ta acute U
+.It \e(\(aqa Ta \('a        Ta acute a
+.It \e(\(aqe Ta \('e        Ta acute e
+.It \e(\(aqi Ta \('i        Ta acute i
+.It \e(\(aqo Ta \('o        Ta acute o
+.It \e(\(aqu Ta \('u        Ta acute u
+.It \e(\(gaA Ta \(`A        Ta grave A
+.It \e(\(gaE Ta \(`E        Ta grave E
+.It \e(\(gaI Ta \(`I        Ta grave I
+.It \e(\(gaO Ta \(`O        Ta grave O
+.It \e(\(gaU Ta \(`U        Ta grave U
+.It \e(\(gaa Ta \(`a        Ta grave a
+.It \e(\(gae Ta \(`e        Ta grave e
+.It \e(\(gai Ta \(`i        Ta grave i
+.It \e(\(gao Ta \(`i        Ta grave o
+.It \e(\(gau Ta \(`u        Ta grave u
+.It \e(\(tiA Ta \(~A        Ta tilde A
+.It \e(\(tiN Ta \(~N        Ta tilde N
+.It \e(\(tiO Ta \(~O        Ta tilde O
+.It \e(\(tia Ta \(~a        Ta tilde a
+.It \e(\(tin Ta \(~n        Ta tilde n
+.It \e(\(tio Ta \(~o        Ta tilde o
 .It \e(:A    Ta \(:A        Ta dieresis A
 .It \e(:E    Ta \(:E        Ta dieresis E
 .It \e(:I    Ta \(:I        Ta dieresis I
@@ -679,7 +679,7 @@ manual.
 .Sh UNICODE CHARACTERS
 The escape sequences
 .Pp
-.Dl \e[uXXXX] and \eC'uXXXX'
+.Dl \e[uXXXX] and \eC\(aquXXXX\(aq
 .Pp
 are interpreted as Unicode codepoints.
 The codepoint must be in the range above U+0080 and less than U+10FFFF.
@@ -691,10 +691,6 @@ must be given as uppercase characters,
 and points must be zero-padded to four characters; if
 greater than four characters, no zero padding is allowed.
 Unicode surrogates are not allowed.
-.\" .Pp
-.\" Unicode glyphs attenuate to the
-.\" .Sq \&?
-.\" character if invalid or not rendered by current output media.
 .Sh NUMBERED CHARACTERS
 For backward compatibility with existing manuals,
 .Xr mandoc 1
@@ -707,7 +703,7 @@ escape sequence, inserting the character
 from the current character set into the output.
 Of course, this is inherently non-portable and is already marked
 as deprecated in the Heirloom roff manual.
-For example, do not use \eN'34', use \e(dq, or even the plain
+For example, do not use \eN\(aq34\(aq, use \e(dq, or even the plain
 .Sq \(dq
 character where possible.
 .Sh COMPATIBILITY
@@ -731,7 +727,7 @@ In
 .Fl T Ns Cm html
 and
 .Fl T Ns Cm xhtml ,
-the \e(~=, \e(nb, and \e(nc special characters render differently
+the \e(\(ti=, \e(nb, and \e(nc special characters render differently
 between mandoc and groff.
 .It
 The
--
 To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2015-03-30 16:06 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-03-30 16:06 mdocml: Escape punctuation characters that have a different meaning in schwarze

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).