Add back in a check that the leading `-' exists for arguments. This

[mandoc.git] / mandoc_char.7

diff --git a/mandoc_char.7 b/mandoc_char.7
index 497cad355b38473981a0decc2758e7339da32100..d0c5dd7f801fd864bbb120580c6f8672b90bf87a 100644 (file)
--- a/mandoc_char.7
+++ b/mandoc_char.7
@@ -1,6 +1,6 @@
-.\"    $Id: mandoc_char.7,v 1.32 2010/03/22 21:05:36 kristaps Exp $
+.\"    $Id: mandoc_char.7,v 1.45 2011/05/15 15:30:33 kristaps Exp $

 .\"
 .\"

-.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
+.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv>

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above


@@ -14,16 +14,12 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: March 22 2010 $
+.Dd $Mdocdate: May 15 2011 $

 .Dt MANDOC_CHAR 7
 .Os
 .Dt MANDOC_CHAR 7
 .Os

-.
-.

 .Sh NAME
 .Nm mandoc_char
 .Nd mandoc special characters
 .Sh NAME
 .Nm mandoc_char
 .Nd mandoc special characters

-.
-.

 .Sh DESCRIPTION
 This page documents the special characters and predefined strings accepted by
 .Xr mandoc 1
 .Sh DESCRIPTION
 This page documents the special characters and predefined strings accepted by
 .Xr mandoc 1


@@ -32,7 +28,6 @@ to format
 and
 .Xr man 7
 documents.
 and
 .Xr man 7
 documents.

-.

 .Pp
 Both
 .Xr mdoc 7
 .Pp
 Both
 .Xr mdoc 7


@@ -70,17 +65,13 @@ and
 .Sq \e*X
 as
 .Sq \e*[X] .
 .Sq \e*X
 as
 .Sq \e*[X] .

-.

 .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
 (more or less) meaningful output rendering, regardless the mode.
 .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
 (more or less) meaningful output rendering, regardless the mode.

-.
-.

 .Sh SPECIAL CHARACTERS
 These are the preferred input symbols for producing special characters.
 .Sh SPECIAL CHARACTERS
 These are the preferred input symbols for producing special characters.

-.

 .Pp
 Spacing:
 .Bl -column -compact -offset indent "Input" "Description"
 .Pp
 Spacing:
 .Bl -column -compact -offset indent "Input" "Description"


@@ -94,7 +85,6 @@ Spacing:
 .It \e0      Ta breaking, non-collapsing digit-width space
 .It \ec      Ta removes any trailing space (if applicable)
 .El
 .It \e0      Ta breaking, non-collapsing digit-width space
 .It \ec      Ta removes any trailing space (if applicable)
 .El

-.

 .Pp
 Lines:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Lines:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -107,7 +97,6 @@ Lines:
 .It \e(sl    Ta \(sl        Ta forward slash
 .It \e(rs    Ta \(rs        Ta backward slash
 .El
 .It \e(sl    Ta \(sl        Ta forward slash
 .It \e(rs    Ta \(rs        Ta backward slash
 .El

-.

 .Pp
 Text markers:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Text markers:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -127,7 +116,6 @@ Text markers:
 .It \e(CR    Ta \(CR        Ta carriage return
 .It \e(OK    Ta \(OK        Ta check mark
 .El
 .It \e(CR    Ta \(CR        Ta carriage return
 .It \e(OK    Ta \(OK        Ta check mark
 .El

-.

 .Pp
 Legal symbols:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Legal symbols:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -136,7 +124,6 @@ Legal symbols:
 .It \e(rg    Ta \(rg        Ta registered
 .It \e(tm    Ta \(tm        Ta trademarked
 .El
 .It \e(rg    Ta \(rg        Ta registered
 .It \e(tm    Ta \(tm        Ta trademarked
 .El

-.

 .Pp
 Punctuation:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Punctuation:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -149,7 +136,6 @@ Punctuation:
 .It \e(r!    Ta \(r!        Ta upside-down exclamation
 .It \e(r?    Ta \(r?        Ta upside-down question
 .El
 .It \e(r!    Ta \(r!        Ta upside-down exclamation
 .It \e(r?    Ta \(r?        Ta upside-down question
 .El

-.

 .Pp
 Quotes:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Quotes:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -167,10 +153,9 @@ Quotes:
 .It \e(fo    Ta \(fo        Ta left single guillemet
 .It \e(fc    Ta \(fc        Ta right single guillemet
 .El
 .It \e(fo    Ta \(fo        Ta left single guillemet
 .It \e(fc    Ta \(fc        Ta right single guillemet
 .El

-.

 .Pp
 Brackets:
 .Pp
 Brackets:

-.Bl -column -compact -offset indent "x[bracketrightbp]" Rendered Description
+.Bl -column -compact -offset indent "xxbracketrightbpx" 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
 .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


@@ -207,7 +192,6 @@ Brackets:
 .It \e[parenrightbp] Ta \[parenrightbp] Ta bottom-right hooked parenthesis
 .It \e[parenrightex] Ta \[parenrightex] Ta right hooked parenthesis extension
 .El
 .It \e[parenrightbp] Ta \[parenrightbp] Ta bottom-right hooked parenthesis
 .It \e[parenrightex] Ta \[parenrightex] Ta right hooked parenthesis extension
 .El

-.

 .Pp
 Arrows:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Arrows:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -225,7 +209,6 @@ Arrows:
 .It \e(dA    Ta \(dA        Ta down double-arrow
 .It \e(vA    Ta \(vA        Ta up-down double-arrow
 .El
 .It \e(dA    Ta \(dA        Ta down double-arrow
 .It \e(vA    Ta \(vA        Ta up-down double-arrow
 .El

-.

 .Pp
 Logical:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Logical:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -241,10 +224,9 @@ Logical:
 .It \e(3d    Ta \(3d        Ta therefore
 .It \e(or    Ta \(or        Ta bitwise or
 .El
 .It \e(3d    Ta \(3d        Ta therefore
 .It \e(or    Ta \(or        Ta bitwise or
 .El

-.

 .Pp
 Mathematical:
 .Pp
 Mathematical:

-.Bl -column -compact -offset indent "Input" "Rendered" "Description"
+.Bl -column -compact -offset indent "xxcoproductxx" "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
 .It Em Input Ta Em Rendered Ta Em Description
 .It \e(pl    Ta \(pl        Ta plus
 .It \e(mi    Ta \(mi        Ta minus


@@ -307,7 +289,6 @@ Mathematical:
 .It \e(pd    Ta \(pd        Ta partial differential
 .It \e(-h    Ta \(-h        Ta Planck constant over 2\(*p
 .El
 .It \e(pd    Ta \(pd        Ta partial differential
 .It \e(-h    Ta \(-h        Ta Planck constant over 2\(*p
 .El

-.

 .Pp
 Ligatures:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Ligatures:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -325,7 +306,6 @@ Ligatures:
 .It \e(IJ    Ta \(IJ        Ta IJ ligature
 .It \e(ij    Ta \(ij        Ta ij ligature
 .El
 .It \e(IJ    Ta \(IJ        Ta IJ ligature
 .It \e(ij    Ta \(ij        Ta ij ligature
 .El

-.

 .Pp
 Accents:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Accents:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -348,7 +328,6 @@ Accents:
 .It \e(ha    Ta \(ha        Ta hat (text)
 .It \e(ti    Ta \(ti        Ta tilde (text)
 .El
 .It \e(ha    Ta \(ha        Ta hat (text)
 .It \e(ti    Ta \(ti        Ta tilde (text)
 .El

-.

 .Pp
 Accented letters:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Accented letters:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -409,7 +388,6 @@ Accented letters:
 .It \e(oA    Ta \(oA        Ta ring A
 .It \e(oa    Ta \(oa        Ta ring a
 .El
 .It \e(oA    Ta \(oA        Ta ring A
 .It \e(oa    Ta \(oa        Ta ring a
 .El

-.

 .Pp
 Special letters:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Special letters:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -421,7 +399,6 @@ Special letters:
 .It \e(.i    Ta \(.i        Ta dotless i
 .It \e(.j    Ta \(.j        Ta dotless j
 .El
 .It \e(.i    Ta \(.i        Ta dotless i
 .It \e(.j    Ta \(.j        Ta dotless j
 .El

-.

 .Pp
 Currency:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Currency:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -435,7 +412,6 @@ Currency:
 .It \e(Cs    Ta \(Cs        Ta Scandinavian
 .It \e(Fn    Ta \(Fn        Ta florin
 .El
 .It \e(Cs    Ta \(Cs        Ta Scandinavian
 .It \e(Fn    Ta \(Fn        Ta florin
 .El

-.

 .Pp
 Units:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Units:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -446,7 +422,6 @@ Units:
 .It \e(sd    Ta \(sd        Ta second
 .It \e(mc    Ta \(mc        Ta micro
 .El
 .It \e(sd    Ta \(sd        Ta second
 .It \e(mc    Ta \(mc        Ta micro
 .El

-.

 .Pp
 Greek letters:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .Pp
 Greek letters:
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"


@@ -505,12 +480,14 @@ Greek letters:
 .It \e(+e    Ta \(+e        Ta epsilon variant
 .It \e(ts    Ta \(ts        Ta sigma terminal
 .El
 .It \e(+e    Ta \(+e        Ta epsilon variant
 .It \e(ts    Ta \(ts        Ta sigma terminal
 .El

-.
-.

 .Sh PREDEFINED STRINGS
 .Sh PREDEFINED STRINGS

-These are not recommended for use, as they differ across
-implementations:
-.
+Predefined strings are inherited from the macro packages of historical
+troff implementations.
+They are
+.Em not recommended
+for use, as they differ across implementations.
+Manuals using these predefined strings are almost certainly not
+portable.

 .Pp
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .It Em Input Ta Em Rendered Ta Em Description
 .Pp
 .Bl -column -compact -offset indent "Input" "Rendered" "Description"
 .It Em Input Ta Em Rendered Ta Em Description


@@ -540,46 +517,89 @@ 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 greater-than-equal
 .It \e*(aa   Ta \*(aa       Ta acute
 .It \e*(ga   Ta \*(ga       Ta grave

+.It \e*(Px   Ta \*(Px       Ta POSIX standard name
+.It \e*(Ai   Ta \*(Ai       Ta ANSI standard name

 .El
 .El

-.
-.
-.Sh COMPATIBILITY
-This section documents compatibility of
-.Nm
-with older or existing versions of
-.Xr groff 1 .
-.
+.Sh UNICODE CHARACTERS
+The escape sequence

 .Pp
 .Pp

-The following render differently in
-.Fl T Ns Ar ascii
-output mode:
-.Bd -ragged -offset indent
-\e(ss, \e(nm, \e(nb, \e(nc, \e(ib, \e(ip, \e(pp, \e[sum], \e[product],
-\e[coproduct], \e(gr, \e(-h, \e(a.
-.Ed
-.
+.Dl \e[uXXXX]
+.Pp
+is interpreted as a Unicode codepoint.
+The codepoint must be in the range above U+0080 and less than U+10FFFF.
+For compatibility, points must be zero-padded to four characters; if
+greater than four characters, no zero padding is allowed.
+Unicode surrogates are not allowed.
+.\" .Pp
+.\" Unicode glyphs attenuate to the
+.\" .Sq \&?
+.\" character if invalid or not rendered by current output media.
+.Sh NUMBERED CHARACTERS
+For backward compatibility with existing manuals,
+.Xr mandoc 1
+also supports the
+.Pp
+.Dl \eN\(aq Ns Ar number Ns \(aq

 .Pp
 .Pp

-The following render differently in
-.Fl T Ns Ar html
-output mode:
-.Bd -ragged -offset indent
-\e(~=, \e(nb, \e(nc
-.Ed
-.
+escape sequence, inserting the character
+.Ar number
+from the current character set into the output.
+Of course, this is inherently non-portable and is already marked
+as deprecated in the Heirloom roff manual.
+For example, do not use \eN'34', use \e(dq, or even the plain
+.Sq \(dq
+character where possible.
+.Sh COMPATIBILITY
+This section documents compatibility between mandoc and other other
+troff implementations, at this time limited to GNU troff
+.Pq Qq groff .

 .Pp
 .Pp

-Finally, the following have been omitted by being poorly documented or
-having no known representation:
-.Bd -ragged -offset indent
-\e[radicalex], \e[sqrtex], \e(ru
-.Ed
-.
-.
+.Bl -dash -compact
+.It
+The \eN\(aq\(aq escape sequence is limited to printable characters; in
+groff, it accepts arbitrary character numbers.
+.It
+In
+.Fl T Ns Cm ascii ,
+the
+\e(ss, \e(nm, \e(nb, \e(nc, \e(ib, \e(ip, \e(pp, \e[sum], \e[product],
+\e[coproduct], \e(gr, \e(\-h, and \e(a. special characters render
+differently between mandoc and groff.
+.It
+In
+.Fl T Ns Cm html
+and
+.Fl T Ns Cm xhtml ,
+the \e(~=, \e(nb, and \e(nc special characters render differently
+between mandoc and groff.
+.It
+The
+.Fl T Ns Cm ps
+and
+.Fl T Ns Cm pdf
+modes format like
+.Fl T Ns Cm ascii
+instead of rendering glyphs as in groff.
+.It
+The \e[radicalex], \e[sqrtex], and \e(ru special characters have been omitted
+from mandoc either because they are poorly documented or they have no
+known representation.
+.El

 .Sh SEE ALSO
 .Xr mandoc 1
 .Sh SEE ALSO
 .Xr mandoc 1

-.
-.

 .Sh AUTHORS
 The
 .Nm
 manual page was written by
 .Sh AUTHORS
 The
 .Nm
 manual page was written by

-.An Kristaps Dzonsons Aq kristaps@kth.se .
+.An Kristaps Dzonsons Aq kristaps@bsd.lv .
+.Sh CAVEATS
+The
+.Sq \e*(Ba
+escape mimics the behaviour of the
+.Sq \&|
+character in
+.Xr mdoc 7 ;
+thus, if you wish to render a vertical bar with no side effects, use
+the
+.Sq \e(ba
+escape.