[BACK]Return to mandoc_char.7 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc_char.7 between version 1.26 and 1.51

version 1.26, 2009/10/15 02:42:53 version 1.51, 2011/11/23 10:09:30
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>  .\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org>
   .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
   .\" Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above  .\" purpose with or without fee is hereby granted, provided that the above
Line 13 
Line 15 
 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN  .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF  .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.  .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"  .\"
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt MANDOC_CHAR 7  .Dt MANDOC_CHAR 7
 .Os  .Os
 .  
 .  
 .Sh NAME  .Sh NAME
 .Nm mandoc_char  .Nm mandoc_char
 .Nd mandoc special characters  .Nd mandoc special characters
 .  
 .  
 .Sh DESCRIPTION  .Sh DESCRIPTION
 This documents the special characters and predefined strings accepted by  This page documents the
   .Xr roff 7
   escape sequences accepted by
 .Xr mandoc 1  .Xr mandoc 1
 to format  to represent special characters in
 .Xr mdoc 7  .Xr mdoc 7
 and  and
 .Xr man 7  .Xr man 7
 documents.  documents.
 .  
 .Pp  .Pp
 Both  The rendering depends on the
 .Xr mdoc 7  .Xr mandoc 1
 and  output mode; in ASCII output, most characters are completely
 .Xr man 7  unintelligible.
 encode special characters with  For that reason, using any of the special characters documented here,
   except those discussed in the
   .Sx DESCRIPTION ,
   is strongly discouraged; they are supported merely for backwards
   compatibility with existing documents.
   .Pp
   In particular, in English manual pages, do not use special-character
   escape sequences to represent national language characters in author
   names; instead, provide ASCII transcriptions of the names.
   .Ss Dashes and Hyphens
   In typography there are different types of dashes of various width:
   the hyphen (-),
   the minus sign (\-),
   the en-dash (\(en),
   and the em-dash (\(em).
   .Pp
   Hyphens are used for adjectives;
   to separate the two parts of a compound word;
   or to separate a word across two successive lines of text.
   The hyphen does not need to be escaped:
   .Bd -unfilled -offset indent
   blue-eyed
   lorry-driver
   .Ed
   .Pp
   The mathematical minus sign is used for negative numbers or subtraction.
   It should be written as
   .Sq \e- :
   .Bd -unfilled -offset indent
   a = 3 \e- 1;
   b = \e-2;
   .Ed
   .Pp
   The en-dash is used to separate the two elements of a range,
   or can be used the same way as an em-dash.
   It should be written as
   .Sq \e(en :
   .Bd -unfilled -offset indent
   pp. 95\e(en97.
   Go away \e(en or else!
   .Ed
   .Pp
   The em-dash can be used to show an interruption
   or can be used the same way as colons, semi-colons, or parentheses.
   It should be written as
   .Sq \e(em :
   .Bd -unfilled -offset indent
   Three things \e(em apples, oranges, and bananas.
   This is not that \e(em rather, this is that.
   .Ed
   .Pp
   Note:
   hyphens, minus signs, and en-dashes look identical under normal ASCII output.
   Other formats, such as PostScript, render them correctly,
   with differing widths.
   .Ss Spaces
   To separate words in normal text, for indenting and alignment
   in literal context, and when none of the following special cases apply,
   just use the normal space character
   .Pq Sq \  .
   .Pp
   When filling text, lines may be broken between words, i.e. at space
   characters.
   To prevent a line break between two particular words,
   use the non-breaking space escape sequence
   .Pq Sq \e~
   instead of the normal space character.
   For example, the input string
   .Dq number\e~1
   will be kept together as
   .Dq number\~1
   on the same output line.
   .Pp
   On request and macro lines, the normal space character serves as an
   argument delimiter.
   To include whitespace into arguments, quoting is usually the best choice.
   In some cases, using either the non-breaking
   .Pq Sq \e~
   or the breaking
   .Pq Sq \e\ \&
   space escape sequence may be preferable.
   To escape macro names and to protect whitespace at the end
   of input lines, the zero-width space
   .Pq Sq \e&
   is often useful.
   For example, in
   .Xr mdoc 7 ,
   a normal space character can be displayed in single quotes in either
   of the following ways:
   .Pp
   .Dl .Sq \(dq \(dq
   .Dl .Sq \e \e&
   .Ss Quotes
   On request and macro lines, the double-quote character
   .Pq Sq \(dq
   is handled specially to allow quoting.
   One way to prevent this special handling is by using the
   .Sq \e(dq
   escape sequence.
   .Pp
   Note that on text lines, literal double-quote characters can be used
   verbatim.
   All other quote-like characters can be used verbatim as well,
   even on request and macro lines.
   .Ss Periods
   The period
   .Pq Sq \&.
   is handled specially at the beginning of an input line,
   where it introduces a
   .Xr roff 7
   request or a macro, and when appearing alone as a macro argument in
   .Xr mdoc 7 .
   In such situations, prepend a zero-width space
   .Pq Sq \e&.
   to make it behave like normal text.
   .Pp
   Do not use the
   .Sq \e.
   escape sequence.
   It does not prevent special handling of the period.
   .Ss Backslashes
   To include a literal backslash
   .Pq Sq \e
   into the output, use the
   .Pq Sq \ee
   escape sequence.
   .Pp
   Note that doubling it
   .Pq Sq \e\e
   is not the right way to output a backslash.
   Because
   .Xr mandoc 1
   does not implement full
   .Xr roff 7
   functionality, it may work with
   .Xr mandoc 1 ,
   but it may have weird effects on complete
   .Xr roff 7
   implementations.
   .Sh SPECIAL CHARACTERS
   Special characters are encoded as
 .Sq \eX  .Sq \eX
 .Pq for a one-character escape ,  .Pq for a one-character escape ,
 .Sq \e(XX  .Sq \e(XX
Line 46  encode special characters with 
Line 185  encode special characters with 
 and  and
 .Sq \e[N]  .Sq \e[N]
 .Pq N-character .  .Pq N-character .
 One may generalise  For details, see the
 .Sq \e(XX  .Em Special Characters
 as  subsection of the
 .Sq \e[XX]  .Xr roff 7
 and  manual.
 .Sq \eX  
 as  
 .Sq \e[X] .  
 Predefined strings are functionally similar to special characters, using  
 .Sq \e*X  
 .Pq for a one-character escape ,  
 .Sq \e*(XX  
 .Pq two-character ,  
 and  
 .Sq \e*[N]  
 .Pq N-character .  
 One may generalise  
 .Sq \e*(XX  
 as  
 .Sq \e*[XX]  
 and  
 .Sq \e*X  
 as  
 .Sq \e*[X] .  
 .  
 .Pp  .Pp
 Note that each output mode will have a different rendering of the  
 characters.  It's guaranteed that each input symbol will correspond to a  
 (more or less) meaningful output rendering, regardless the mode.  
 .  
 .Ss ASCII output  
 Formatting documents with ASCII output results in a 7-bit ASCII  
 approximation of zero or more characters, for example, the  
 .Dq aleph  
 character  
 .Sq \e(Ah  
 will render as  
 .Sq N .  
 Approximations are a best-effort, and naturally some clarity will be lost.  
 .  
 .Ss HTML output  
 The HTML output mode uses decimal-encoded UTF-8 for sequences, for  
 example, the  
 .Dq aleph  
 character  
 .Sq \e(Ah  
 will render as  
 .Sq &#8501; .  
 .  
 .  
 .Sh SPECIAL CHARACTERS  
 These are the preferred input symbols for producing special characters.  
 .  
 .Pp  
 Spacing:  Spacing:
 .Bl -column -compact -offset indent 10m 20m  .Bl -column "Input" "Description" -offset indent -compact
 .It Em Input Ta Em Description  .It Em Input Ta Em Description
 .It \e~      Ta non-breaking, non-collapsing space  .It \e~      Ta non-breaking, non-collapsing space
 .It \e       Ta breaking, non-collapsing n-width space  .It \e       Ta breaking, non-collapsing n-width space
Line 110  Spacing:
Line 201  Spacing:
 .It \e&      Ta zero-width space  .It \e&      Ta zero-width space
 .It \e|      Ta zero-width space  .It \e|      Ta zero-width space
 .It \e0      Ta breaking, non-collapsing digit-width space  .It \e0      Ta breaking, non-collapsing digit-width space
   .It \ec      Ta removes any trailing space (if applicable)
 .El  .El
 .  
 .Pp  .Pp
 Lines:  Lines:
 .Bl -column -compact -offset indent 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(ba    Ta \(ba        Ta bar  .It \e(ba    Ta \(ba        Ta bar
 .It \e(br    Ta \(br        Ta box rule  .It \e(br    Ta \(br        Ta box rule
Line 124  Lines:
Line 215  Lines:
 .It \e(sl    Ta \(sl        Ta forward slash  .It \e(sl    Ta \(sl        Ta forward slash
 .It \e(rs    Ta \(rs        Ta backward slash  .It \e(rs    Ta \(rs        Ta backward slash
 .El  .El
 .  
 .Pp  .Pp
 Text markers:  Text markers:
 .Bl -column -compact -offset indent 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(ci    Ta \(ci        Ta circle  .It \e(ci    Ta \(ci        Ta circle
 .It \e(bu    Ta \(bu        Ta bullet  .It \e(bu    Ta \(bu        Ta bullet
Line 144  Text markers:
Line 234  Text markers:
 .It \e(CR    Ta \(CR        Ta carriage return  .It \e(CR    Ta \(CR        Ta carriage return
 .It \e(OK    Ta \(OK        Ta check mark  .It \e(OK    Ta \(OK        Ta check mark
 .El  .El
 .  
 .Pp  .Pp
 Legal symbols:  Legal symbols:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(co    Ta \(co        Ta copyright  .It \e(co    Ta \(co        Ta copyright
 .It \e(rg    Ta \(rg        Ta registered  .It \e(rg    Ta \(rg        Ta registered
 .It \e(tm    Ta \(tm        Ta trademarked  .It \e(tm    Ta \(tm        Ta trademarked
 .El  .El
 .  
 .Pp  .Pp
 Punctuation:  Punctuation:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(em    Ta \(em        Ta em-dash  .It \e(em    Ta \(em        Ta em-dash
 .It \e(en    Ta \(en        Ta en-dash  .It \e(en    Ta \(en        Ta en-dash
 .It \e(hy    Ta \(hy        Ta hyphen  .It \e(hy    Ta \(hy        Ta hyphen
 .It \e\e     Ta \\          Ta back-slash  
 .It \ee      Ta \e          Ta back-slash  .It \ee      Ta \e          Ta back-slash
 .It \e.      Ta \.          Ta period  .It \e.      Ta \.          Ta period
 .It \e(r!    Ta \(r!        Ta upside-down exclamation  .It \e(r!    Ta \(r!        Ta upside-down exclamation
 .It \e(r?    Ta \(r?        Ta upside-down question  .It \e(r?    Ta \(r?        Ta upside-down question
 .El  .El
 .  
 .Pp  .Pp
 Quotes:  Quotes:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .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 double-quote
 .It \e(bq    Ta \(bq        Ta right low single-quote  .It \e(bq    Ta \(bq        Ta right low single-quote
Line 185  Quotes:
Line 271  Quotes:
 .It \e(fo    Ta \(fo        Ta left single guillemet  .It \e(fo    Ta \(fo        Ta left single guillemet
 .It \e(fc    Ta \(fc        Ta right single guillemet  .It \e(fc    Ta \(fc        Ta right single guillemet
 .El  .El
 .  
 .Pp  .Pp
 Brackets:  Brackets:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "xxbracketrightbpx" Rendered Description -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(lB    Ta \(lB        Ta left bracket  .It \e(lB    Ta \(lB        Ta left bracket
 .It \e(rB    Ta \(rB        Ta right bracket  .It \e(rB    Ta \(rB        Ta right bracket
Line 225  Brackets:
Line 310  Brackets:
 .It \e[parenrightbp] Ta \[parenrightbp] Ta bottom-right hooked parenthesis  .It \e[parenrightbp] Ta \[parenrightbp] Ta bottom-right hooked parenthesis
 .It \e[parenrightex] Ta \[parenrightex] Ta right hooked parenthesis extension  .It \e[parenrightex] Ta \[parenrightex] Ta right hooked parenthesis extension
 .El  .El
 .  
 .Pp  .Pp
 Arrows:  Arrows:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(<-    Ta \(<-        Ta left arrow  .It \e(<-    Ta \(<-        Ta left arrow
 .It \e(->    Ta \(->        Ta right arrow  .It \e(->    Ta \(->        Ta right arrow
Line 243  Arrows:
Line 327  Arrows:
 .It \e(dA    Ta \(dA        Ta down double-arrow  .It \e(dA    Ta \(dA        Ta down double-arrow
 .It \e(vA    Ta \(vA        Ta up-down double-arrow  .It \e(vA    Ta \(vA        Ta up-down double-arrow
 .El  .El
 .  
 .Pp  .Pp
 Logical:  Logical:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(AN    Ta \(AN        Ta logical and  .It \e(AN    Ta \(AN        Ta logical and
 .It \e(OR    Ta \(OR        Ta logical or  .It \e(OR    Ta \(OR        Ta logical or
Line 259  Logical:
Line 342  Logical:
 .It \e(3d    Ta \(3d        Ta therefore  .It \e(3d    Ta \(3d        Ta therefore
 .It \e(or    Ta \(or        Ta bitwise or  .It \e(or    Ta \(or        Ta bitwise or
 .El  .El
 .  
 .Pp  .Pp
 Mathematical:  Mathematical:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "xxcoproductxx" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(pl    Ta \(pl        Ta plus  .It \e(pl    Ta \(pl        Ta plus
 .It \e(mi    Ta \(mi        Ta minus  .It \e(mi    Ta \(mi        Ta minus
Line 324  Mathematical:
Line 406  Mathematical:
 .It \e(Re    Ta \(Re        Ta real  .It \e(Re    Ta \(Re        Ta real
 .It \e(pd    Ta \(pd        Ta partial differential  .It \e(pd    Ta \(pd        Ta partial differential
 .It \e(-h    Ta \(-h        Ta Planck constant over 2\(*p  .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  .El
 .  
 .Pp  .Pp
 Ligatures:  Ligatures:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(ff    Ta \(ff        Ta ff ligature  .It \e(ff    Ta \(ff        Ta ff ligature
 .It \e(fi    Ta \(fi        Ta fi ligature  .It \e(fi    Ta \(fi        Ta fi ligature
Line 343  Ligatures:
Line 427  Ligatures:
 .It \e(IJ    Ta \(IJ        Ta IJ ligature  .It \e(IJ    Ta \(IJ        Ta IJ ligature
 .It \e(ij    Ta \(ij        Ta ij ligature  .It \e(ij    Ta \(ij        Ta ij ligature
 .El  .El
 .  
 .Pp  .Pp
 Accents:  Accents:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(a"    Ta \(a"        Ta Hungarian umlaut  .It \e(a"    Ta \(a"        Ta Hungarian umlaut
 .It \e(a-    Ta \(a-        Ta macron  .It \e(a-    Ta \(a-        Ta macron
Line 366  Accents:
Line 449  Accents:
 .It \e(ha    Ta \(ha        Ta hat (text)  .It \e(ha    Ta \(ha        Ta hat (text)
 .It \e(ti    Ta \(ti        Ta tilde (text)  .It \e(ti    Ta \(ti        Ta tilde (text)
 .El  .El
 .  
 .Pp  .Pp
 Accented letters:  Accented letters:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e('A    Ta \('A        Ta acute A  .It \e('A    Ta \('A        Ta acute A
 .It \e('E    Ta \('E        Ta acute E  .It \e('E    Ta \('E        Ta acute E
Line 427  Accented letters:
Line 509  Accented letters:
 .It \e(oA    Ta \(oA        Ta ring A  .It \e(oA    Ta \(oA        Ta ring A
 .It \e(oa    Ta \(oa        Ta ring a  .It \e(oa    Ta \(oa        Ta ring a
 .El  .El
 .  
 .Pp  .Pp
 Special letters:  Special letters:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(-D    Ta \(-D        Ta Eth  .It \e(-D    Ta \(-D        Ta Eth
 .It \e(Sd    Ta \(Sd        Ta eth  .It \e(Sd    Ta \(Sd        Ta eth
Line 439  Special letters:
Line 520  Special letters:
 .It \e(.i    Ta \(.i        Ta dotless i  .It \e(.i    Ta \(.i        Ta dotless i
 .It \e(.j    Ta \(.j        Ta dotless j  .It \e(.j    Ta \(.j        Ta dotless j
 .El  .El
 .  
 .Pp  .Pp
 Currency:  Currency:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(Do    Ta \(Do        Ta dollar  .It \e(Do    Ta \(Do        Ta dollar
 .It \e(ct    Ta \(ct        Ta cent  .It \e(ct    Ta \(ct        Ta cent
Line 453  Currency:
Line 533  Currency:
 .It \e(Cs    Ta \(Cs        Ta Scandinavian  .It \e(Cs    Ta \(Cs        Ta Scandinavian
 .It \e(Fn    Ta \(Fn        Ta florin  .It \e(Fn    Ta \(Fn        Ta florin
 .El  .El
 .  
 .Pp  .Pp
 Units:  Units:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(de    Ta \(de        Ta degree  .It \e(de    Ta \(de        Ta degree
 .It \e(%0    Ta \(%0        Ta per-thousand  .It \e(%0    Ta \(%0        Ta per-thousand
Line 464  Units:
Line 543  Units:
 .It \e(sd    Ta \(sd        Ta second  .It \e(sd    Ta \(sd        Ta second
 .It \e(mc    Ta \(mc        Ta micro  .It \e(mc    Ta \(mc        Ta micro
 .El  .El
 .  
 .Pp  .Pp
 Greek letters:  Greek letters:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column "Input" "Rendered" "Description" -offset indent -compact
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e(*A    Ta \(*A        Ta Alpha  .It \e(*A    Ta \(*A        Ta Alpha
 .It \e(*B    Ta \(*B        Ta Beta  .It \e(*B    Ta \(*B        Ta Beta
Line 523  Greek letters:
Line 601  Greek letters:
 .It \e(+e    Ta \(+e        Ta epsilon variant  .It \e(+e    Ta \(+e        Ta epsilon variant
 .It \e(ts    Ta \(ts        Ta sigma terminal  .It \e(ts    Ta \(ts        Ta sigma terminal
 .El  .El
 .  
 .  
 .Sh PREDEFINED STRINGS  .Sh PREDEFINED STRINGS
 These are not recommended for use, as they differ across  Predefined strings are inherited from the macro packages of historical
 implementations:  troff implementations.
 .  They are
   .Em not recommended
   for use, as they differ across implementations.
   Manuals using these predefined strings are almost certainly not
   portable.
 .Pp  .Pp
 .Bl -compact -offset indent -column 10m 10m 10m  Their syntax is similar to special characters, using
   .Sq \e*X
   .Pq for a one-character escape ,
   .Sq \e*(XX
   .Pq two-character ,
   and
   .Sq \e*[N]
   .Pq N-character .
   For details, see the
   .Em Predefined Strings
   subsection of the
   .Xr roff 7
   manual.
   .Bl -column "Input" "Rendered" "Description" -offset indent
 .It Em Input Ta Em Rendered Ta Em Description  .It Em Input Ta Em Rendered Ta Em Description
 .It \e*(Ba   Ta \*(Ba       Ta vertical bar  .It \e*(Ba   Ta \*(Ba       Ta vertical bar
 .It \e*(Ne   Ta \*(Ne       Ta not equal  .It \e*(Ne   Ta \*(Ne       Ta not equal
Line 558  implementations:
Line 651  implementations:
 .It \e*(>=   Ta \*(>=       Ta greater-than-equal  .It \e*(>=   Ta \*(>=       Ta greater-than-equal
 .It \e*(aa   Ta \*(aa       Ta acute  .It \e*(aa   Ta \*(aa       Ta acute
 .It \e*(ga   Ta \*(ga       Ta grave  .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  .El
 .  .Sh UNICODE CHARACTERS
 .  The escape sequence
 .Sh COMPATIBILITY  
 This section documents compatibility of  
 .Nm  
 with older or existing versions of  
 .Xr groff 1 .  
 .  
 .Pp  .Pp
 The following render differently in  .Dl \e[uXXXX]
 .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  
 .  
 .Pp  .Pp
 The following render differently in  is interpreted as a Unicode codepoint.
 .Fl T Ns Ar html  The codepoint must be in the range above U+0080 and less than U+10FFFF.
 output mode:  For compatibility, points must be zero-padded to four characters; if
 .Bd -ragged -offset indent  greater than four characters, no zero padding is allowed.
 \e(~=, \e(nb, \e(nc  Unicode surrogates are not allowed.
 .Ed  .\" .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  .Pp
 Finally, the following have been omitted by being poorly documented or  .Dl \eN\(aq Ns Ar number Ns \(aq
 having no known representation:  .Pp
 .Bd -ragged -offset indent  escape sequence, inserting the character
 \e[radicalex], \e[sqrtex], \e(ru  .Ar number
 .Ed  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  .Sh SEE ALSO
 .Xr mandoc 1  .Xr mandoc 1 ,
 .  .Xr man 7 ,
 .  .Xr mdoc 7 ,
 .Sh STANDARDS  .Xr roff 7
 .Rs  
 .%A The Unicode Consortium  
 .%T The Unicode Standard: Worldwide Character Encoding, Version 5.2  
 .%D 1991  
 .Re  
 .Rs  
 .%A W3C  
 .%T HTML 4.01 Specification  
 .%D December, 1999  
 .Re  
 .  
 .  
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  manual page was written by
 .An Kristaps Dzonsons Aq kristaps@kth.se .  .An Kristaps Dzonsons ,
   .Mt kristaps@bsd.lv .
   .Sh CAVEATS
   The
   .Sq \e*(Ba
   escape mimics the behaviour of the
   .Sq \&|
   character in
   .Xr mdoc 7 ;
   thus, if you wish to render a vertical bar with no side effects, use
   the
   .Sq \e(ba
   escape.
Legend:
Removed from v.1.26  
changed lines
  Added in v.1.51
CVSweb