version 1.25, 2009/10/07 14:37:13 |
version 1.34, 2010/03/30 19:20:33 |
|
|
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
.\" |
.\" |
.Dd $Mdocdate$ |
.Dd $Mdocdate$ |
.Dt MANDOC_CHAR 7 |
.Dt MANDOC_CHAR 7 |
.Os |
.Os |
|
|
. |
. |
. |
. |
.Sh DESCRIPTION |
.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 |
.Xr mandoc 1 |
to format |
to format |
.Xr mdoc 7 |
.Xr mdoc 7 |
|
|
.Xr mdoc 7 |
.Xr mdoc 7 |
and |
and |
.Xr man 7 |
.Xr man 7 |
encode special characters with |
encode special characters with |
.Sq \eX |
.Sq \eX |
.Pq for a one-character escape , |
.Pq for a one-character escape , |
.Sq \e(XX |
.Sq \e(XX |
|
|
.Sq \eX |
.Sq \eX |
as |
as |
.Sq \e[X] . |
.Sq \e[X] . |
Predefined strings are functionally similar to special characters, using |
Predefined strings are functionally similar to special characters, using |
.Sq \e*X |
.Sq \e*X |
.Pq for a one-character escape , |
.Pq for a one-character escape , |
.Sq \e*(XX |
.Sq \e*(XX |
|
|
. |
. |
.Pp |
.Pp |
Note that each output mode will have a different rendering of the |
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. |
(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. |
These are the preferred input symbols for producing special characters. |
. |
. |
.Pp |
.Pp |
Spacing: |
Spacing: |
.Bl -compact -offset indent -column 10m 20m |
.Bl -column -compact -offset indent "Input" "Description" |
.It Em Input Ta Em Description |
.It Em Input Ta Em Description |
.It \e~ Ta non-breaking, non-collapsing space |
.It \e~ Ta non-breaking, non-collapsing space |
.It \e Ta breaking, non-collapsing n-width space |
.It \e Ta breaking, non-collapsing n-width space |
|
|
.It \e& Ta zero-width space |
.It \e& Ta zero-width space |
.It \e| Ta zero-width space |
.It \e| Ta zero-width space |
.It \e0 Ta breaking, non-collapsing digit-width space |
.It \e0 Ta breaking, non-collapsing digit-width space |
|
.It \ec Ta removes any trailing space (if applicable) |
.El |
.El |
. |
. |
.Pp |
.Pp |
Lines: |
Lines: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(ba Ta \(ba Ta bar |
.It \e(ba Ta \(ba Ta bar |
.It \e(br Ta \(br Ta box rule |
.It \e(br Ta \(br Ta box rule |
|
|
. |
. |
.Pp |
.Pp |
Text markers: |
Text markers: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(ci Ta \(ci Ta circle |
.It \e(ci Ta \(ci Ta circle |
.It \e(bu Ta \(bu Ta bullet |
.It \e(bu Ta \(bu Ta bullet |
|
|
. |
. |
.Pp |
.Pp |
Legal symbols: |
Legal symbols: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(co Ta \(co Ta copyright |
.It \e(co Ta \(co Ta copyright |
.It \e(rg Ta \(rg Ta registered |
.It \e(rg Ta \(rg Ta registered |
|
|
. |
. |
.Pp |
.Pp |
Punctuation: |
Punctuation: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(em Ta \(em Ta em-dash |
.It \e(em Ta \(em Ta em-dash |
.It \e(en Ta \(en Ta en-dash |
.It \e(en Ta \(en Ta en-dash |
.It \e(hy Ta \(hy Ta hyphen |
.It \e(hy Ta \(hy Ta hyphen |
.It \e\e Ta \\ Ta back-slash |
|
.It \ee Ta \e Ta back-slash |
.It \ee Ta \e Ta back-slash |
.It \e. Ta \. Ta period |
.It \e. Ta \. Ta period |
.It \e(r! Ta \(r! Ta upside-down exclamation |
.It \e(r! Ta \(r! Ta upside-down exclamation |
|
|
. |
. |
.Pp |
.Pp |
Quotes: |
Quotes: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em 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 double-quote |
.It \e(bq Ta \(bq Ta right low single-quote |
.It \e(bq Ta \(bq Ta right low single-quote |
|
|
. |
. |
.Pp |
.Pp |
Brackets: |
Brackets: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "x[bracketrightbp]" Rendered Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(lB Ta \(lB Ta left bracket |
.It \e(lB Ta \(lB Ta left bracket |
.It \e(rB Ta \(rB Ta right bracket |
.It \e(rB Ta \(rB Ta right bracket |
|
|
. |
. |
.Pp |
.Pp |
Arrows: |
Arrows: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(<- Ta \(<- Ta left arrow |
.It \e(<- Ta \(<- Ta left arrow |
.It \e(-> Ta \(-> Ta right arrow |
.It \e(-> Ta \(-> Ta right arrow |
|
|
. |
. |
.Pp |
.Pp |
Logical: |
Logical: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(AN Ta \(AN Ta logical and |
.It \e(AN Ta \(AN Ta logical and |
.It \e(OR Ta \(OR Ta logical or |
.It \e(OR Ta \(OR Ta logical or |
|
|
. |
. |
.Pp |
.Pp |
Mathematical: |
Mathematical: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(pl Ta \(pl Ta plus |
.It \e(pl Ta \(pl Ta plus |
.It \e(mi Ta \(mi Ta minus |
.It \e(mi Ta \(mi Ta minus |
|
|
. |
. |
.Pp |
.Pp |
Ligatures: |
Ligatures: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(ff Ta \(ff Ta ff ligature |
.It \e(ff Ta \(ff Ta ff ligature |
.It \e(fi Ta \(fi Ta fi ligature |
.It \e(fi Ta \(fi Ta fi ligature |
|
|
. |
. |
.Pp |
.Pp |
Accents: |
Accents: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(a" Ta \(a" Ta Hungarian umlaut |
.It \e(a" Ta \(a" Ta Hungarian umlaut |
.It \e(a- Ta \(a- Ta macron |
.It \e(a- Ta \(a- Ta macron |
|
|
. |
. |
.Pp |
.Pp |
Accented letters: |
Accented letters: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e('A Ta \('A Ta acute A |
.It \e('A Ta \('A Ta acute A |
.It \e('E Ta \('E Ta acute E |
.It \e('E Ta \('E Ta acute E |
Line 411 Accented letters: |
|
Line 412 Accented letters: |
|
. |
. |
.Pp |
.Pp |
Special letters: |
Special letters: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(-D Ta \(-D Ta Eth |
.It \e(-D Ta \(-D Ta Eth |
.It \e(Sd Ta \(Sd Ta eth |
.It \e(Sd Ta \(Sd Ta eth |
Line 423 Special letters: |
|
Line 424 Special letters: |
|
. |
. |
.Pp |
.Pp |
Currency: |
Currency: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(Do Ta \(Do Ta dollar |
.It \e(Do Ta \(Do Ta dollar |
.It \e(ct Ta \(ct Ta cent |
.It \e(ct Ta \(ct Ta cent |
|
|
. |
. |
.Pp |
.Pp |
Units: |
Units: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(de Ta \(de Ta degree |
.It \e(de Ta \(de Ta degree |
.It \e(%0 Ta \(%0 Ta per-thousand |
.It \e(%0 Ta \(%0 Ta per-thousand |
|
|
. |
. |
.Pp |
.Pp |
Greek letters: |
Greek letters: |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e(*A Ta \(*A Ta Alpha |
.It \e(*A Ta \(*A Ta Alpha |
.It \e(*B Ta \(*B Ta Beta |
.It \e(*B Ta \(*B Ta Beta |
Line 511 These are not recommended for use, as they differ acro |
|
Line 512 These are not recommended for use, as they differ acro |
|
implementations: |
implementations: |
. |
. |
.Pp |
.Pp |
.Bl -compact -offset indent -column 10m 10m 10m |
.Bl -column -compact -offset indent "Input" "Rendered" "Description" |
.It Em Input Ta Em Rendered Ta Em Description |
.It Em Input Ta Em Rendered Ta Em Description |
.It \e*(Ba Ta \*(Ba Ta vertical bar |
.It \e*(Ba Ta \*(Ba Ta vertical bar |
.It \e*(Ne Ta \*(Ne Ta not equal |
.It \e*(Ne Ta \*(Ne Ta not equal |
Line 580 having no known representation: |
|
Line 581 having no known representation: |
|
.Sh AUTHORS |
.Sh AUTHORS |
The |
The |
.Nm |
.Nm |
utility was written by |
manual page was written by |
.An Kristaps Dzonsons Aq kristaps@kth.se . |
.An Kristaps Dzonsons Aq kristaps@kth.se . |