[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.2 and 1.10

version 1.2, 2009/04/12 19:19:57 version 1.10, 2009/07/27 12:35:53
Line 1 
Line 1 
 .\" $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>  .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"  .\"
 .\" 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  .\" purpose with or without fee is hereby granted, provided that the above
 .\" above copyright notice and this permission notice appear in all  .\" copyright notice and this permission notice appear in all copies.
 .\" copies.  
 .\"  .\"
 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL  .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 .\" WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED  .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE  .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 .\" AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL  .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 .\" DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR  .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 .\" PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER  .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR  .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\" PERFORMANCE OF THIS SOFTWARE.  
 .\"  .\"
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt MANDOC_CHAR 7  .Dt MANDOC_CHAR 7
Line 25 
Line 23 
 .Nd mandoc special characters  .Nd mandoc special characters
 .\" SECTION  .\" SECTION
 .Sh DESCRIPTION  .Sh DESCRIPTION
 This documents the special characters accepted by  This 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 36  documents.  Specific output devices of
Line 34  documents.  Specific output devices of
 dictated by the  dictated by the
 .Fl T Ns Ar output  .Fl T Ns Ar output
 argument, will properly render these sequences.  argument, will properly render these sequences.
   .\" PARAGRAPH
 .Pp  .Pp
 Both  Both
 .Xr mdoc 7  .Xr mdoc 7
 and  and
 .Xr man 7  .Xr man 7
 encode special characters with slightly different semantics; consult the  encode special characters with
 respective manuals for these escapes.  .Sq \eX
   .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 \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] .
   .\" SECTION
   .Sh Special Characters
   These are the preferred input symbols for producing special characters.
   .\" PARAGRAPH
 .Pp  .Pp
   Typographic:
   .Bl -tag -width Ds -offset indent -compact
   .It \e~
   .Pq non-breaking space
   .It \e
   .Pq space
   .It \e^
   .Pq zero-width space
   .It \e%
   .Pq zero-width space
   .It \e&
   .Pq zero-width space
   .It \e|
   .Pq zero-width space
   .El
   .\" PARAGRAPH
   .Pp
 Grammatic:  Grammatic:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width Ds -offset indent -compact
 .It \e(em  .It \e(em
 .Pq em-dash  .Pq em-dash
 .It \e(en  .It \e(en
 .Pq en-dash  .Pq en-dash
 .It \e-  .It \e(hy
 .Pq hyphen  .Pq hyphen
 .It \e\e  .It \e\e
 .Pq back-slash  .Pq back-slash
Line 58  Grammatic:
Line 108  Grammatic:
 .Pq apostrophe  .Pq apostrophe
 .It \e`  .It \e`
 .Pq back-tick  .Pq back-tick
 .It \e  
 .Pq space  
 .It \e.  .It \e.
 .Pq period  .Pq period
 .It \e(r!  .It \e(r!
Line 70  Grammatic:
Line 118  Grammatic:
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Enclosures:  Enclosures:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width Ds -offset indent -compact
 .It \e(lh  .It \e(lh
 .Pq left hand  .Pq left hand
 .It \e(rh  .It \e(rh
Line 95  Enclosures:
Line 143  Enclosures:
 .Pq right bracket  .Pq right bracket
 .It \e(lB  .It \e(lB
 .Pq left bracket  .Pq left bracket
 .It \eq  
 .Pq double-quote  
 .It \e(lq  .It \e(lq
 .Pq left double-quote  .Pq left double-quote
 .It \e(Lq  
 .Pq left double-quote, deprecated  
 .It \e(rq  .It \e(rq
 .Pq right double-quote  .Pq right double-quote
 .It \e(Rq  
 .Pq right double-quote, deprecated  
 .It \e(oq  .It \e(oq
 .Pq left single-quote  .Pq left single-quote
 .It \e(aq  .It \e(aq
Line 117  Enclosures:
Line 159  Enclosures:
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Indicatives:  Indicatives:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width Ds -offset indent -compact
 .It \e(<-  .It \e(<-
 .Pq left arrow  .Pq left arrow
 .It \e(->  .It \e(->
Line 142  Indicatives:
Line 184  Indicatives:
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Mathematical:  Mathematical:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width Ds -offset indent -compact
 .It \e(es  .It \e(es
 .Pq empty set  .Pq empty set
 .It \e(ca  .It \e(ca
Line 167  Mathematical:
Line 209  Mathematical:
 .Pq multiplication  .Pq multiplication
 .It \e(pl  .It \e(pl
 .Pq addition  .Pq addition
   .It \e-
   .Pq subtraction
 .It \e(nm  .It \e(nm
 .Pq not element  .Pq not element
 .It \e(mo  .It \e(mo
Line 197  Mathematical:
Line 241  Mathematical:
 .Pq approximately equals  .Pq approximately equals
 .It \e(=~  .It \e(=~
 .Pq congruent  .Pq congruent
 .It \e(Gt  
 .Pq greater-than, deprecated  
 .It \e(Lt  
 .Pq less-than, deprecated  
 .It \e(<=  .It \e(<=
 .Pq less-than-equal  .Pq less-than-equal
 .It \e(Le  
 .Pq less-than-equal, deprecated  
 .It \e(>=  .It \e(>=
 .Pq greater-than-equal  .Pq greater-than-equal
 .It \e(Ge  
 .Pq greater-than-equal  
 .It \e(==  .It \e(==
 .Pq equal  .Pq equal
 .It \e(!=  .It \e(!=
 .Pq not equal  .Pq not equal
 .It \e(Ne  
 .Pq not equal, deprecated  
 .It \e(if  .It \e(if
 .Pq infinity  .Pq infinity
 .It \e(If  
 .Pq infinity, deprecated  
 .It \e(na  .It \e(na
 .Pq NaN , an extension  .Pq NaN, an extension
 .It \e(Na  
 .Pq NaN, deprecated  
 .It \e(+-  .It \e(+-
 .Pq plus-minus  .Pq plus-minus
 .It \e(Pm  
 .Pq plus-minus, deprecated  
 .It \e(**  .It \e(**
 .Pq asterisk  .Pq asterisk
 .El  .El
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Ligatures:  Ligatures:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width Ds -offset indent -compact
 .It \e(ss  .It \e(ss
 .Pq German eszett  .Pq German eszett
 .It \e(AE  .It \e(AE
Line 258  Ligatures:
Line 286  Ligatures:
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Diacritics and letters:  Diacritics and letters:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width Ds -offset indent -compact
 .It \e(ga  .It \e(ga
 .Pq grave accent  .Pq grave accent
 .It \e(aa  .It \e(aa
Line 407  Diacritics and letters:
Line 435  Diacritics and letters:
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Monetary:  Monetary:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width Ds -offset indent -compact
 .It \e(Cs  .It \e(Cs
 .Pq Scandinavian  .Pq Scandinavian
 .It \e(Do  .It \e(Do
Line 424  Monetary:
Line 452  Monetary:
 .\" PARAGRAPH  .\" PARAGRAPH
 .Pp  .Pp
 Special symbols:  Special symbols:
 .Bl -tag -width 12n -offset "XXXX" -compact  .Bl -tag -width Ds -offset indent -compact
 .It \e0  .It \e0
 .Pq white-space  .Pq white-space
 .It \e(de  .It \e(de
Line 443  Special symbols:
Line 471  Special symbols:
 .Pq bar  .Pq bar
 .It \e(bb  .It \e(bb
 .Pq broken bar  .Pq broken bar
 .It \e(Ba  
 .Pq bar, deprecated  
 .It \e(co  .It \e(co
 .Pq copyright  .Pq copyright
 .It \e(rg  .It \e(rg
 .Pq registered  .Pq registered
 .It \e(tm  .It \e(tm
 .Pq trademarked  .Pq trademarked
 .It \e&  
 .Pq non-breaking space  
 .It \ee  .It \ee
 .Pq escape  .Pq escape
 .It \e(Am  
 .Pq ampersand, deprecated  
 .El  .El
 .\" SECTION  .\" SECTION
   .Sh PREDEFINED STRINGS
   These are not recommended for use, as they differ across
   implementations:
   .Pp
   Mathematical:
   .Bl -tag -width Ds -offset indent -compact
   .It \e*(Ne
   .Pq not equal
   .It \e*(Ge
   .Pq greater-than-equal
   .It \e*(Le
   .Pq less-than-equal
   .It \e*(Gt
   .Pq greater-than
   .It \e*(Lt
   .Pq greater-than
   .It \e*(Pm
   .Pq plus-minus
   .It \e*(If
   .Pq infinity
   .It \e*(Pi
   .Pq pi
   .It \e*(Na
   .Pq NaN
   .El
   .\" PARAGRAPH
   .Pp
   Special symbols:
   .Bl -tag -width Ds -offset indent -compact
   .It \e*(Ba
   .Pq vertical bar
   .It \e*(Am
   .Pq ampersand
   .El
   .\" PARAGRAPH
   .Pp
   Enclosures:
   .Bl -tag -width Ds -offset indent -compact
   .It \e*q
   .Pq double-quote
   .It \e*(Rq
   .Pq right-double-quote
   .It \e*(Lq
   .Pq left-double-quote
   .It \e*(lp
   .Pq right-parenthesis
   .It \e*(rp
   .Pq left-parenthesis
   .El
   .\" SECTION
   .Sh COMPATIBILITY
   This section documents compatibility of
   .Nm
   with older or existing versions of
   .Xr groff 1 :
   .Pp
   .Bl -tag -width Ds -offset indent -compact
   .It \e(ss
   Renders differently in
   .Fl T Ns Ar ascii
   mode.
   .El
   .\" SECTION
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1  .Xr mandoc 1
 .\" SECTION  .\" SECTION
Line 466  Special symbols:
Line 551  Special symbols:
 The  The
 .Nm  .Nm
 utility was written by  utility was written by
 .An Kristaps Dzonsons Aq kristaps@openbsd.org .  .An Kristaps Dzonsons Aq kristaps@kth.se .
Legend:
Removed from v.1.2  
changed lines
  Added in v.1.10
CVSweb