mandoc/mandoc_char.7 - diff

Return to mandoc_char.7 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc_char.7 between version 1.5 and 1.10

version 1.5, 2009/06/10 20:18:43

version 1.10, 2009/07/27 12:35:53

Line 23

.Nd mandoc special characters

.\" SECTION

.Sh DESCRIPTION

This documents the special characters accepted by

This documents the special characters and predefined strings accepted by

.Xr mandoc 1

to format

.Xr mdoc 7

Line 34 documents. Specific output devices of

dictated by the

.Fl T Ns Ar output

argument, will properly render these sequences.

.\" PARAGRAPH

.Pp

Both

.Xr mdoc 7

and

.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

.Sq \e[XX]

and

.Sq \eX

.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

.Sq \e*[XX]

and

.Sq \e*X

.Sq \e*[X] .

.\" SECTION

.Sh Special Characters

These are the preferred input symbols for producing special characters.

.\" PARAGRAPH

.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:

.Bl -tag -width 12n -offset "XXXX" -compact

.Bl -tag -width Ds -offset indent -compact

.It \e(em

.Pq em-dash

.It \e(en

.Pq en-dash

.It \e-

.It \e(hy

.Pq hyphen

.It \e\e

.Pq back-slash

Line 56 Grammatic:

Line 108 Grammatic:

.Pq apostrophe

.It \e`

.Pq back-tick

.It \e

.Pq space

.It \e.

.Pq period

.It \e(r!

Line 68 Grammatic:

Line 118 Grammatic:

.\" PARAGRAPH

.Pp

Enclosures:

.Bl -tag -width 12n -offset "XXXX" -compact

.Bl -tag -width Ds -offset indent -compact

.It \e(lh

.Pq left hand

.It \e(rh

Line 93 Enclosures:

Line 143 Enclosures:

.Pq right bracket

.It \e(lB

.Pq left bracket

.It \eq

.Pq double-quote

.It \e(lq

.Pq left double-quote

.It \e(Lq

.Pq left double-quote, deprecated

.It \e(rq

.Pq right double-quote

.It \e(Rq

.Pq right double-quote, deprecated

.It \e(oq

.Pq left single-quote

.It \e(aq

Line 115 Enclosures:

Line 159 Enclosures:

.\" PARAGRAPH

.Pp

Indicatives:

.Bl -tag -width 12n -offset "XXXX" -compact

.Bl -tag -width Ds -offset indent -compact

.It \e(<-

.Pq left arrow

.It \e(->

Line 140 Indicatives:

Line 184 Indicatives:

.\" PARAGRAPH

.Pp

Mathematical:

.Bl -tag -width 12n -offset "XXXX" -compact

.Bl -tag -width Ds -offset indent -compact

.It \e(es

.Pq empty set

.It \e(ca

Line 165 Mathematical:

Line 209 Mathematical:

.Pq multiplication

.It \e(pl

.Pq addition

.It \e-

.Pq subtraction

.It \e(nm

.Pq not element

.It \e(mo

Line 195 Mathematical:

Line 241 Mathematical:

.Pq approximately equals

.It \e(=~

.Pq congruent

.It \e(Gt

.Pq greater-than, deprecated

.It \e(Lt

.Pq less-than, deprecated

.It \e(<=

.Pq less-than-equal

.It \e(Le

.Pq less-than-equal, deprecated

.It \e(>=

.Pq greater-than-equal

.It \e(Ge

.Pq greater-than-equal

.It \e(==

.Pq equal

.It \e(!=

.Pq not equal

.It \e(Ne

.Pq not equal, deprecated

.It \e(if

.Pq infinity

.It \e(If

.Pq infinity, deprecated

.It \e(na

.Pq NaN , an extension

.Pq NaN, an extension

.It \e(Na

.Pq NaN, deprecated

.It \e(+-

.Pq plus-minus

.It \e(Pm

.Pq plus-minus, deprecated

.It \e(**

.Pq asterisk

.El

.\" PARAGRAPH

.Pp

Ligatures:

.Bl -tag -width 12n -offset "XXXX" -compact

.Bl -tag -width Ds -offset indent -compact

.It \e(ss

.Pq German eszett

.It \e(AE

Line 256 Ligatures:

Line 286 Ligatures:

.\" PARAGRAPH

.Pp

Diacritics and letters:

.Bl -tag -width 12n -offset "XXXX" -compact

.Bl -tag -width Ds -offset indent -compact

.It \e(ga

.Pq grave accent

.It \e(aa

Line 405 Diacritics and letters:

Line 435 Diacritics and letters:

.\" PARAGRAPH

.Pp

Monetary:

.Bl -tag -width 12n -offset "XXXX" -compact

.Bl -tag -width Ds -offset indent -compact

.It \e(Cs

.Pq Scandinavian

.It \e(Do

Line 422 Monetary:

Line 452 Monetary:

.\" PARAGRAPH

.Pp

Special symbols:

.Bl -tag -width 12n -offset "XXXX" -compact

.Bl -tag -width Ds -offset indent -compact

.It \e0

.Pq white-space

.It \e(de

Line 441 Special symbols:

Line 471 Special symbols:

.Pq bar

.It \e(bb

.Pq broken bar

.It \e(Ba

.Pq bar, deprecated

.It \e(co

.Pq copyright

.It \e(rg

.Pq registered

.It \e(tm

.Pq trademarked

.It \e&

.Pq non-breaking space

.It \ee

.Pq escape

.It \e(Am

.Pq ampersand, deprecated

.El

.\" 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 12n -offset "XXXX" -compact

.Bl -tag -width Ds -offset indent -compact

.It \e(ss

Renders differently in

.Fl T Ns Ar ascii

Line 477 mode.

Line 551 mode.

The

.Nm

utility was written by

.An Kristaps Dzonsons Aq kristaps@openbsd.org .

.An Kristaps Dzonsons Aq kristaps@kth.se .

CVSweb