[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.34

version 1.26, 2009/10/15 02:42:53 version 1.34, 2010/03/30 19:20:33
Line 13 
Line 13 
 .\" 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
Line 25 
Line 25 
 .  .
 .  .
 .Sh DESCRIPTION  .Sh DESCRIPTION
 This documents the special characters and predefined strings accepted by  This page documents the special characters and predefined strings accepted by
 .Xr mandoc 1  .Xr mandoc 1
 to format  to format
 .Xr mdoc 7  .Xr mdoc 7
Line 38  Both
Line 38  Both
 .Xr mdoc 7  .Xr mdoc 7
 and  and
 .Xr man 7  .Xr man 7
 encode special characters with  encode special characters with
 .Sq \eX  .Sq \eX
 .Pq for a one-character escape ,  .Pq for a one-character escape ,
 .Sq \e(XX  .Sq \e(XX
Line 54  and
Line 54  and
 .Sq \eX  .Sq \eX
 as  as
 .Sq \e[X] .  .Sq \e[X] .
 Predefined strings are functionally similar to special characters, using  Predefined strings are functionally similar to special characters, using
 .Sq \e*X  .Sq \e*X
 .Pq for a one-character escape ,  .Pq for a one-character escape ,
 .Sq \e*(XX  .Sq \e*(XX
Line 73  as
Line 73  as
 .  .
 .Pp  .Pp
 Note that each output mode will have a different rendering of the  Note that each output mode will have a different rendering of the
 characters.  It's guaranteed that each input symbol will correspond to a  characters.
   It's guaranteed that each input symbol will correspond to a
 (more or less) meaningful output rendering, regardless the mode.  (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 ℵ .  
 .  
 .  
 .Sh SPECIAL CHARACTERS  .Sh SPECIAL CHARACTERS
 These are the preferred input symbols for producing special characters.  These are the preferred input symbols for producing special characters.
 .  .
 .Pp  .Pp
 Spacing:  Spacing:
 .Bl -column -compact -offset indent 10m 20m  .Bl -column -compact -offset indent "Input" "Description"
 .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 92  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 -compact -offset indent "Input" "Rendered" "Description"
 .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 127  Lines:
Line 110  Lines:
 .  .
 .Pp  .Pp
 Text markers:  Text markers:
 .Bl -column -compact -offset indent 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 147  Text markers:
Line 130  Text markers:
 .  .
 .Pp  .Pp
 Legal symbols:  Legal symbols:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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
Line 156  Legal symbols:
Line 139  Legal symbols:
 .  .
 .Pp  .Pp
 Punctuation:  Punctuation:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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
Line 170  Punctuation:
Line 152  Punctuation:
 .  .
 .Pp  .Pp
 Quotes:  Quotes:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 188  Quotes:
Line 170  Quotes:
 .  .
 .Pp  .Pp
 Brackets:  Brackets:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "x[bracketrightbp]" Rendered Description
 .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 228  Brackets:
Line 210  Brackets:
 .  .
 .Pp  .Pp
 Arrows:  Arrows:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 246  Arrows:
Line 228  Arrows:
 .  .
 .Pp  .Pp
 Logical:  Logical:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 262  Logical:
Line 244  Logical:
 .  .
 .Pp  .Pp
 Mathematical:  Mathematical:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 328  Mathematical:
Line 310  Mathematical:
 .  .
 .Pp  .Pp
 Ligatures:  Ligatures:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 346  Ligatures:
Line 328  Ligatures:
 .  .
 .Pp  .Pp
 Accents:  Accents:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 369  Accents:
Line 351  Accents:
 .  .
 .Pp  .Pp
 Accented letters:  Accented letters:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 430  Accented letters:
Line 412  Accented letters:
 .  .
 .Pp  .Pp
 Special letters:  Special letters:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 442  Special letters:
Line 424  Special letters:
 .  .
 .Pp  .Pp
 Currency:  Currency:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 456  Currency:
Line 438  Currency:
 .  .
 .Pp  .Pp
 Units:  Units:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 467  Units:
Line 449  Units:
 .  .
 .Pp  .Pp
 Greek letters:  Greek letters:
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 530  These are not recommended for use, as they differ acro
Line 512  These are not recommended for use, as they differ acro
 implementations:  implementations:
 .  .
 .Pp  .Pp
 .Bl -compact -offset indent -column 10m 10m 10m  .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .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 596  having no known representation:
Line 578  having no known representation:
 .Xr mandoc 1  .Xr mandoc 1
 .  .
 .  .
 .Sh STANDARDS  
 .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 Aq kristaps@kth.se .
Legend:
Removed from v.1.26  
changed lines
  Added in v.1.34
CVSweb