=================================================================== RCS file: /cvs/mandoc/mandoc_char.7,v retrieving revision 1.24 retrieving revision 1.33 diff -u -p -r1.24 -r1.33 --- mandoc/mandoc_char.7 2009/09/24 09:20:02 1.24 +++ mandoc/mandoc_char.7 2010/03/23 13:25:01 1.33 @@ -1,4 +1,4 @@ -.\" $Id: mandoc_char.7,v 1.24 2009/09/24 09:20:02 kristaps Exp $ +.\" $Id: mandoc_char.7,v 1.33 2010/03/23 13:25:01 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons .\" @@ -13,8 +13,8 @@ .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -.\" -.Dd $Mdocdate: September 24 2009 $ +.\" +.Dd $Mdocdate: March 23 2010 $ .Dt MANDOC_CHAR 7 .Os . @@ -25,7 +25,7 @@ . . .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 to format .Xr mdoc 7 @@ -38,7 +38,7 @@ Both .Xr mdoc 7 and .Xr man 7 -encode special characters with +encode special characters with .Sq \eX .Pq for a one-character escape , .Sq \e(XX @@ -54,7 +54,7 @@ and .Sq \eX as .Sq \e[X] . -Predefined strings are functionally similar to special characters, using +Predefined strings are functionally similar to special characters, using .Sq \e*X .Pq for a one-character escape , .Sq \e*(XX @@ -73,16 +73,17 @@ as . .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 +characters. +It's guaranteed that each input symbol will correspond to a (more or less) meaningful output rendering, regardless the mode. . . -.Sh Special Characters +.Sh SPECIAL CHARACTERS These are the preferred input symbols for producing special characters. . .Pp Spacing: -.Bl -compact -offset indent -column 10n 20n +.Bl -column -compact -offset indent "Input" "Description" .It Em Input Ta Em Description .It \e~ Ta non-breaking, non-collapsing space .It \e Ta breaking, non-collapsing n-width space @@ -91,11 +92,12 @@ Spacing: .It \e& Ta zero-width space .It \e| Ta zero-width space .It \e0 Ta breaking, non-collapsing digit-width space +.It \ec Ta removes any trailing space (if applicable) .El . .Pp Lines: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(ba Ta \(ba Ta bar .It \e(br Ta \(br Ta box rule @@ -108,7 +110,7 @@ Lines: . .Pp Text markers: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(ci Ta \(ci Ta circle .It \e(bu Ta \(bu Ta bullet @@ -128,7 +130,7 @@ Text markers: . .Pp Legal symbols: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(co Ta \(co Ta copyright .It \e(rg Ta \(rg Ta registered @@ -137,12 +139,11 @@ Legal symbols: . .Pp Punctuation: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(em Ta \(em Ta em-dash .It \e(en Ta \(en Ta en-dash .It \e(hy Ta \(hy Ta hyphen -.It \e\e Ta \\ Ta back-slash .It \ee Ta \e Ta back-slash .It \e. Ta \. Ta period .It \e(r! Ta \(r! Ta upside-down exclamation @@ -151,7 +152,7 @@ Punctuation: . .Pp Quotes: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "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 single-quote @@ -169,7 +170,7 @@ Quotes: . .Pp Brackets: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "x[bracketrightbp]" Rendered Description .It Em Input Ta Em Rendered Ta Em Description .It \e(lB Ta \(lB Ta left bracket .It \e(rB Ta \(rB Ta right bracket @@ -209,7 +210,7 @@ Brackets: . .Pp Arrows: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(<- Ta \(<- Ta left arrow .It \e(-> Ta \(-> Ta right arrow @@ -227,7 +228,7 @@ Arrows: . .Pp Logical: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(AN Ta \(AN Ta logical and .It \e(OR Ta \(OR Ta logical or @@ -243,7 +244,7 @@ Logical: . .Pp Mathematical: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(pl Ta \(pl Ta plus .It \e(mi Ta \(mi Ta minus @@ -309,7 +310,7 @@ Mathematical: . .Pp Ligatures: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(ff Ta \(ff Ta ff ligature .It \e(fi Ta \(fi Ta fi ligature @@ -327,7 +328,7 @@ Ligatures: . .Pp Accents: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(a" Ta \(a" Ta Hungarian umlaut .It \e(a- Ta \(a- Ta macron @@ -350,7 +351,7 @@ Accents: . .Pp Accented letters: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e('A Ta \('A Ta acute A .It \e('E Ta \('E Ta acute E @@ -411,7 +412,7 @@ Accented letters: . .Pp Special letters: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(-D Ta \(-D Ta Eth .It \e(Sd Ta \(Sd Ta eth @@ -423,7 +424,7 @@ Special letters: . .Pp Currency: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(Do Ta \(Do Ta dollar .It \e(ct Ta \(ct Ta cent @@ -437,7 +438,7 @@ Currency: . .Pp Units: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(de Ta \(de Ta degree .It \e(%0 Ta \(%0 Ta per-thousand @@ -448,7 +449,7 @@ Units: . .Pp Greek letters: -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e(*A Ta \(*A Ta Alpha .It \e(*B Ta \(*B Ta Beta @@ -511,7 +512,7 @@ These are not recommended for use, as they differ acro implementations: . .Pp -.Bl -compact -offset indent -column 10n 10n 10n +.Bl -column -compact -offset indent "Input" "Rendered" "Description" .It Em Input Ta Em Rendered Ta Em Description .It \e*(Ba Ta \*(Ba Ta vertical bar .It \e*(Ne Ta \*(Ne Ta not equal @@ -539,6 +540,25 @@ implementations: .It \e*(>= Ta \*(>= Ta greater-than-equal .It \e*(aa Ta \*(aa Ta acute .It \e*(ga Ta \*(ga Ta grave +.It \e*(-- Ta \*(-- Ta dash +.It \e*(PI Ta \*(PI Ta pi +.It \e*(L" Ta \*(L" Ta left double-quote +.It \e*(R" Ta \*(R" Ta right double-quote +.It \e*(C+ Ta \*(C+ Ta C++ +.It \e*(C` Ta \*(C` Ta left single-quote +.It \e*(C' Ta \*(C' Ta right single-quote +.It \e*(Aq Ta \*(Aq Ta apostrophe quote +.It \e*^ Ta \*^ Ta up-arrow +.It \e*, Ta \*, Ta comma +.It \e*~ Ta \*~ Ta tilde +.It \e*/ Ta \*/ Ta forward slash +.It \e*: Ta \*: Ta umlaut +.It \e*8 Ta \*8 Ta beta +.It \e*o Ta \*o Ta degree symbol +.It \e*(D- Ta \*(D- Ta Eth +.It \e*(d- Ta \*(d- Ta eth +.It \e*(TH Ta \*(TH Ta Thorn +.It \e*(th Ta \*(th Ta thorn .El . . @@ -580,5 +600,5 @@ having no known representation: .Sh AUTHORS The .Nm -utility was written by +manual page was written by .An Kristaps Dzonsons Aq kristaps@kth.se .