=================================================================== RCS file: /cvs/mandoc/mandoc_char.7,v retrieving revision 1.9 retrieving revision 1.14 diff -u -p -r1.9 -r1.14 --- mandoc/mandoc_char.7 2009/07/27 12:02:49 1.9 +++ mandoc/mandoc_char.7 2009/09/22 10:07:01 1.14 @@ -1,4 +1,4 @@ -.\" $Id: mandoc_char.7,v 1.9 2009/07/27 12:02:49 kristaps Exp $ +.\" $Id: mandoc_char.7,v 1.14 2009/09/22 10:07: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: July 27 2009 $ +.Dd $Mdocdate: September 22 2009 $ .Dt MANDOC_CHAR 7 .Os .\" SECTION @@ -23,7 +23,7 @@ .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 @@ -34,12 +34,13 @@ 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 these special characters with +encode special characters with .Sq \eX .Pq for a one-character escape , .Sq \e(XX @@ -50,7 +51,30 @@ and One may generalise .Sq \e(XX as -.Sq \e[XX] . +.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 Typographic: @@ -80,6 +104,8 @@ Grammatic: .Pq hyphen .It \e\e .Pq back-slash +.It \\e +.Pq back-slash .It \e' .Pq apostrophe .It \e` @@ -119,8 +145,6 @@ Enclosures: .Pq right bracket .It \e(lB .Pq left bracket -.It \eq -.Pq double-quote .It \e(lq .Pq left double-quote .It \e(rq @@ -175,9 +199,9 @@ Mathematical: .Pq partial differential .It \e(ap .Pq similarity -.It \e(=) +.It \e(sp .Pq proper superset -.It \e((= +.It \e(sb .Pq proper subset .It \e(eq .Pq equals @@ -230,7 +254,7 @@ Mathematical: .It \e(if .Pq infinity .It \e(na -.Pq NaN , an extension +.Pq NaN, an extension .It \e(+- .Pq plus-minus .It \e(** @@ -243,13 +267,13 @@ Ligatures: .It \e(ss .Pq German eszett .It \e(AE -.Pq upper-case AE +.Pq AE .It \e(ae -.Pq lower-case AE +.Pq ae .It \e(OE -.Pq upper-case OE +.Pq OE .It \e(oe -.Pq lower-case OE +.Pq oe .It \e(ff .Pq ff ligature .It \e(fi @@ -263,7 +287,7 @@ Ligatures: .El .\" PARAGRAPH .Pp -Diacritics and letters: +Diacritics and accented letters: .Bl -tag -width Ds -offset indent -compact .It \e(ga .Pq grave accent @@ -292,123 +316,123 @@ Diacritics and letters: .It \e(a- .Pq macron accent .It \e(-D -.Pq upper-case eth +.Pq Eth .It \e(Sd -.Pq lower-case eth +.Pq eth .It \e(TP -.Pq upper-case thorn +.Pq Thorn .It \e(Tp -.Pq lower-case thorn +.Pq thorn .It \e('A -.Pq upper-case acute A +.Pq acute A .It \e('E -.Pq upper-case acute E +.Pq acute E .It \e('I -.Pq upper-case acute I +.Pq acute I .It \e('O -.Pq upper-case acute O +.Pq acute O .It \e('U -.Pq upper-case acute U +.Pq acute U .It \e('a -.Pq lower-case acute a +.Pq acute a .It \e('e -.Pq lower-case acute e +.Pq acute e .It \e('i -.Pq lower-case acute i +.Pq acute i .It \e('o -.Pq lower-case acute o +.Pq acute o .It \e('u -.Pq lower-case acute u +.Pq acute u .It \e(`A -.Pq upper-case grave A +.Pq grave A .It \e(`E -.Pq upper-case grave E +.Pq grave E .It \e(`I -.Pq upper-case grave I +.Pq grave I .It \e(`O -.Pq upper-case grave O +.Pq grave O .It \e(`U -.Pq upper-case grave U +.Pq grave U .It \e(`a -.Pq lower-case grave a +.Pq grave a .It \e(`e -.Pq lower-case grave e +.Pq grave e .It \e(`i -.Pq lower-case grave i +.Pq grave i .It \e(`o -.Pq lower-case grave o +.Pq grave o .It \e(`u -.Pq lower-case grave u +.Pq grave u .It \e(~A -.Pq upper-case tilde A +.Pq tilde A .It \e(~N -.Pq upper-case tilde N +.Pq tilde N .It \e(~O -.Pq upper-case tilde O +.Pq tilde O .It \e(~a -.Pq lower-case tilde a +.Pq tilde a .It \e(~n -.Pq lower-case tilde n +.Pq tilde n .It \e(~o -.Pq lower-case tilde o +.Pq tilde o .It \e(:A -.Pq upper-case dieresis A +.Pq dieresis A .It \e(:E -.Pq upper-case dieresis E +.Pq dieresis E .It \e(:I -.Pq upper-case dieresis I +.Pq dieresis I .It \e(:O -.Pq upper-case dieresis O +.Pq dieresis O .It \e(:U -.Pq upper-case dieresis U +.Pq dieresis U .It \e(:a -.Pq lower-case dieresis a +.Pq dieresis a .It \e(:e -.Pq lower-case dieresis e +.Pq dieresis e .It \e(:i -.Pq lower-case dieresis i +.Pq dieresis i .It \e(:o -.Pq lower-case dieresis o +.Pq dieresis o .It \e(:u -.Pq lower-case dieresis u +.Pq dieresis u .It \e(:y -.Pq lower-case dieresis y +.Pq dieresis y .It \e(^A -.Pq upper-case circumflex A +.Pq circumflex A .It \e(^E -.Pq upper-case circumflex E +.Pq circumflex E .It \e(^I -.Pq upper-case circumflex I +.Pq circumflex I .It \e(^O -.Pq upper-case circumflex O +.Pq circumflex O .It \e(^U -.Pq upper-case circumflex U +.Pq circumflex U .It \e(^a -.Pq lower-case circumflex a +.Pq circumflex a .It \e(^e -.Pq lower-case circumflex e +.Pq circumflex e .It \e(^i -.Pq lower-case circumflex i +.Pq circumflex i .It \e(^o -.Pq lower-case circumflex o +.Pq circumflex o .It \e(^u -.Pq lower-case circumflex u +.Pq circumflex u .It \e(,C -.Pq upper-case cedilla C +.Pq cedilla C .It \e(,c -.Pq lower-case cedilla c +.Pq cedilla c .It \e(/L -.Pq upper-case stroke L +.Pq stroke L .It \e(/l -.Pq lower-case stroke l +.Pq stroke l .It \e(/O -.Pq upper-case stroke O +.Pq stroke O .It \e(/o -.Pq lower-case stroke o +.Pq stroke o .It \e(oA -.Pq upper-case ring A +.Pq ring A .It \e(oa -.Pq lower-case ring a +.Pq ring a .El .\" PARAGRAPH .Pp @@ -426,9 +450,122 @@ Monetary: .Pq florin .It \e(ct .Pq cent +.It \e(Eu +.Pq Euro character glyph +.It \e(eu +.Pq Euro symbol .El .\" PARAGRAPH .Pp +Greek letters: +.Bl -tag -width Ds -offset indent -compact +.It \e(*A +.Pq Alpha +.It \e(*B +.Pq Beta +.It \e(*C +.Pq Xi +.It \e(*D +.Pq Delta +.It \e(*E +.Pq Epsilon +.It \e(*F +.Pq Phi +.It \e(*G +.Pq Gamma +.It \e(*H +.Pq Theta +.It \e(*I +.Pq Iota +.It \e(*K +.Pq Kappa +.It \e(*L +.Pq Lambda +.It \e(*M +.Pq Mu +.It \e(*N +.Pq Nu +.It \e(*O +.Pq Omicron +.It \e(*P +.Pq Pi +.It \e(*Q +.Pq Psi +.It \e(*R +.Pq Rho +.It \e(*S +.Pq Sigma +.It \e(*T +.Pq Tau +.It \e(*U +.Pq Upsilon +.It \e(*W +.Pq Omega +.It \e(*X +.Pq Chi +.It \e(*Y +.Pq Eta +.It \e(*Z +.Pq Zeta +.It \e(*a +.Pq alpha +.It \e(*b +.Pq beta +.It \e(*c +.Pq xi +.It \e(*d +.Pq delta +.It \e(*e +.Pq epsilon +.It \e(*f +.Pq phi +.It \e(+f +.Pq phi variant +.It \e(*g +.Pq gamma +.It \e(*h +.Pq theta +.It \e(+h +.Pq theta variant +.It \e(*i +.Pq iota +.It \e(*k +.Pq kappa +.It \e(*l +.Pq lambda +.It \e(*m +.Pq mu +.It \e(*n +.Pq nu +.It \e(*o +.Pq omicron +.It \e(*p +.Pq pi +.It \e(+p +.Pq pi variant +.It \e(*q +.Pq psi +.It \e(*r +.Pq rho +.It \e(*s +.Pq sigma +.It \e(*t +.Pq tau +.It \e(*u +.Pq upsilon +.It \e(*w +.Pq omega +.It \e(*x +.Pq chi +.It \e(*y +.Pq eta +.It \e(*z +.Pq zeta +.It \e(ts +.Pq sigma terminal +.El +.\" PARAGRAPH +.Pp Special symbols: .Bl -tag -width Ds -offset indent -compact .It \e0 @@ -458,6 +595,60 @@ Special symbols: .It \ee .Pq escape .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 +.It \e*R +.Pq restricted mark +.It \e*(Tm +.Pq trade mark +.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