=================================================================== RCS file: /cvs/mandoc/mandoc_char.7,v retrieving revision 1.38 retrieving revision 1.49 diff -u -p -r1.38 -r1.49 --- mandoc/mandoc_char.7 2010/05/09 21:11:22 1.38 +++ mandoc/mandoc_char.7 2011/08/30 13:14:01 1.49 @@ -1,4 +1,4 @@ -.\" $Id: mandoc_char.7,v 1.38 2010/05/09 21:11:22 kristaps Exp $ +.\" $Id: mandoc_char.7,v 1.49 2011/08/30 13:14:01 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -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: May 9 2010 $ +.Dd $Mdocdate: August 30 2011 $ .Dt MANDOC_CHAR 7 .Os .Sh NAME @@ -74,7 +74,7 @@ It's guaranteed that each input symbol will correspond These are the preferred input symbols for producing special characters. .Pp Spacing: -.Bl -column -compact -offset indent "Input" "Description" +.Bl -column "Input" "Description" -offset indent -compact .It Em Input Ta Em Description .It \e~ Ta non-breaking, non-collapsing space .It \e Ta breaking, non-collapsing n-width space @@ -87,7 +87,7 @@ Spacing: .El .Pp Lines: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(ba Ta \(ba Ta bar .It \e(br Ta \(br Ta box rule @@ -99,7 +99,7 @@ Lines: .El .Pp Text markers: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(ci Ta \(ci Ta circle .It \e(bu Ta \(bu Ta bullet @@ -118,7 +118,7 @@ Text markers: .El .Pp Legal symbols: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(co Ta \(co Ta copyright .It \e(rg Ta \(rg Ta registered @@ -126,7 +126,7 @@ Legal symbols: .El .Pp Punctuation: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(em Ta \(em Ta em-dash .It \e(en Ta \(en Ta en-dash @@ -138,7 +138,7 @@ Punctuation: .El .Pp Quotes: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(Bq Ta \(Bq Ta right low double-quote .It \e(bq Ta \(bq Ta right low single-quote @@ -155,7 +155,7 @@ Quotes: .El .Pp Brackets: -.Bl -column -compact -offset indent "xxbracketrightbpx" Rendered Description +.Bl -column "xxbracketrightbpx" Rendered Description -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(lB Ta \(lB Ta left bracket .It \e(rB Ta \(rB Ta right bracket @@ -194,7 +194,7 @@ Brackets: .El .Pp Arrows: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(<- Ta \(<- Ta left arrow .It \e(-> Ta \(-> Ta right arrow @@ -211,7 +211,7 @@ Arrows: .El .Pp Logical: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(AN Ta \(AN Ta logical and .It \e(OR Ta \(OR Ta logical or @@ -226,7 +226,7 @@ Logical: .El .Pp Mathematical: -.Bl -column -compact -offset indent "xxcoproductxx" "Rendered" "Description" +.Bl -column "xxcoproductxx" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(pl Ta \(pl Ta plus .It \e(mi Ta \(mi Ta minus @@ -288,10 +288,13 @@ Mathematical: .It \e(Re Ta \(Re Ta real .It \e(pd Ta \(pd Ta partial differential .It \e(-h Ta \(-h Ta Planck constant over 2\(*p +.It \e[12] Ta \[12] Ta one-half +.It \e[14] Ta \[14] Ta one-fourth +.It \e[34] Ta \[34] Ta three-fourths .El .Pp Ligatures: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(ff Ta \(ff Ta ff ligature .It \e(fi Ta \(fi Ta fi ligature @@ -308,7 +311,7 @@ Ligatures: .El .Pp Accents: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(a" Ta \(a" Ta Hungarian umlaut .It \e(a- Ta \(a- Ta macron @@ -330,7 +333,7 @@ Accents: .El .Pp Accented letters: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.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 @@ -390,7 +393,7 @@ Accented letters: .El .Pp Special letters: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(-D Ta \(-D Ta Eth .It \e(Sd Ta \(Sd Ta eth @@ -401,7 +404,7 @@ Special letters: .El .Pp Currency: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(Do Ta \(Do Ta dollar .It \e(ct Ta \(ct Ta cent @@ -414,7 +417,7 @@ Currency: .El .Pp Units: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(de Ta \(de Ta degree .It \e(%0 Ta \(%0 Ta per-thousand @@ -424,7 +427,7 @@ Units: .El .Pp Greek letters: -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +.Bl -column "Input" "Rendered" "Description" -offset indent -compact .It Em Input Ta Em Rendered Ta Em Description .It \e(*A Ta \(*A Ta Alpha .It \e(*B Ta \(*B Ta Beta @@ -481,10 +484,14 @@ Greek letters: .It \e(ts Ta \(ts Ta sigma terminal .El .Sh PREDEFINED STRINGS -These are not recommended for use, as they differ across -implementations: -.Pp -.Bl -column -compact -offset indent "Input" "Rendered" "Description" +Predefined strings are inherited from the macro packages of historical +troff implementations. +They are +.Em not recommended +for use, as they differ across implementations. +Manuals using these predefined strings are almost certainly not +portable. +.Bl -column "Input" "Rendered" "Description" -offset indent .It Em Input Ta Em Rendered Ta Em Description .It \e*(Ba Ta \*(Ba Ta vertical bar .It \e*(Ne Ta \*(Ne Ta not equal @@ -512,45 +519,87 @@ implementations: .It \e*(>= Ta \*(>= Ta greater-than-equal .It \e*(aa Ta \*(aa Ta acute .It \e*(ga Ta \*(ga Ta grave +.It \e*(Px Ta \*(Px Ta POSIX standard name +.It \e*(Ai Ta \*(Ai Ta ANSI standard name .El -.Sh COMPATIBILITY -This section documents compatibility of -.Nm -with older or existing versions of -.Xr groff 1 . +.Sh UNICODE CHARACTERS +The escape sequence .Pp -The following render differently in -.Fl T Ns Ar ascii -output mode: -.Bd -ragged -offset indent -\e(ss, \e(nm, \e(nb, \e(nc, \e(ib, \e(ip, \e(pp, \e[sum], \e[product], -\e[coproduct], \e(gr, \e(-h, \e(a. -.Ed +.Dl \e[uXXXX] .Pp -The following render differently in -.Fl T Ns Ar html -output mode: -.Bd -ragged -offset indent -\e(~=, \e(nb, \e(nc -.Ed +is interpreted as a Unicode codepoint. +The codepoint must be in the range above U+0080 and less than U+10FFFF. +For compatibility, 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 +also supports the .Pp -Finally, the following have been omitted by being poorly documented or -having no known representation: -.Bd -ragged -offset indent -\e[radicalex], \e[sqrtex], \e(ru -.Ed +.Dl \eN\(aq Ns Ar number Ns \(aq +.Pp +escape sequence, inserting the character +.Ar number +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 +.Sq \(dq +character where possible. +.Sh COMPATIBILITY +This section documents compatibility between mandoc and other other +troff implementations, at this time limited to GNU troff +.Pq Qq groff . +.Pp +.Bl -dash -compact +.It +The \eN\(aq\(aq escape sequence is limited to printable characters; in +groff, it accepts arbitrary character numbers. +.It +In +.Fl T Ns Cm ascii , +the +\e(ss, \e(nm, \e(nb, \e(nc, \e(ib, \e(ip, \e(pp, \e[sum], \e[product], +\e[coproduct], \e(gr, \e(\-h, and \e(a. special characters render +differently between mandoc and groff. +.It +In +.Fl T Ns Cm html +and +.Fl T Ns Cm xhtml , +the \e(~=, \e(nb, and \e(nc special characters render differently +between mandoc and groff. +.It +The +.Fl T Ns Cm ps +and +.Fl T Ns Cm pdf +modes format like +.Fl T Ns Cm ascii +instead of rendering glyphs as in groff. +.It +The \e[radicalex], \e[sqrtex], and \e(ru special characters have been omitted +from mandoc either because they are poorly documented or they have no +known representation. +.El .Sh SEE ALSO .Xr mandoc 1 .Sh AUTHORS The .Nm manual page was written by -.An Kristaps Dzonsons Aq kristaps@bsd.lv . +.An Kristaps Dzonsons , +.Mt kristaps@bsd.lv . .Sh CAVEATS The .Sq \e*(Ba escape mimics the behaviour of the -.Sq \*(Ba +.Sq \&| character in .Xr mdoc 7 ; thus, if you wish to render a vertical bar with no side effects, use