summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-10-15 02:42:53 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-10-15 02:42:53 +0000
commit220b0aefa44e51fdbb7057b36adc3210b096e100 (patch)
treef59944ce28f3abe996d9dceb36aaa121d2ec9770
parent76a194cc65e1b59ce8ec8b2e23f8412ce9b83fbf (diff)
downloadmandoc-220b0aefa44e51fdbb7057b36adc3210b096e100.tar.gz
Fix in mandoc.1 and mandoc_char.7 syntax (submitted Joerg Sonnenberger).
Added note on character format per output type.
-rw-r--r--mandoc.14
-rw-r--r--mandoc_char.742
2 files changed, 39 insertions, 7 deletions
diff --git a/mandoc.1 b/mandoc.1
index ddee1ac1..e3791e37 100644
--- a/mandoc.1
+++ b/mandoc.1
@@ -268,7 +268,7 @@ for example,
is used as a template for linked header files (usually via the
.Sq \&In
macro). Instances of
-.Sq %I
+.Sq \&%I
are replaced with the include filename. The default is not to present a
hyperlink.
.It Fl o Ns Ar man=fmt
@@ -279,7 +279,7 @@ for example,
is used as a template for linked manuals (usually via the
.Sq \&Xr
macro). Instances of
-.Sq %N
+.Sq \&%N
and
.Sq %S
are replaced with the linked manual's name and section, respectively.
diff --git a/mandoc_char.7 b/mandoc_char.7
index 95410f21..fbcb9ee5 100644
--- a/mandoc_char.7
+++ b/mandoc_char.7
@@ -76,13 +76,32 @@ 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
+.Ss ASCII output
+Formatting documents with ASCII output results in a 7-bit ASCII
+approximation of zero or more characters, for example, the
+.Dq aleph
+character
+.Sq \e(Ah
+will render as
+.Sq N .
+Approximations are a best-effort, and naturally some clarity will be lost.
+.
+.Ss HTML output
+The HTML output mode uses decimal-encoded UTF-8 for sequences, for
+example, the
+.Dq aleph
+character
+.Sq \e(Ah
+will render as
+.Sq &#8501; .
+.
+.
+.Sh SPECIAL CHARACTERS
These are the preferred input symbols for producing special characters.
.
.Pp
Spacing:
-.Bl -compact -offset indent -column 10m 20m
+.Bl -column -compact -offset indent 10m 20m
.It Em Input Ta Em Description
.It \e~ Ta non-breaking, non-collapsing space
.It \e Ta breaking, non-collapsing n-width space
@@ -95,7 +114,7 @@ Spacing:
.
.Pp
Lines:
-.Bl -compact -offset indent -column 10m 10m 10m
+.Bl -column -compact -offset indent 10m 10m 10m
.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 +127,7 @@ Lines:
.
.Pp
Text markers:
-.Bl -compact -offset indent -column 10m 10m 10m
+.Bl -column -compact -offset indent 10m 10m 10m
.It Em Input Ta Em Rendered Ta Em Description
.It \e(ci Ta \(ci Ta circle
.It \e(bu Ta \(bu Ta bullet
@@ -577,6 +596,19 @@ having no known representation:
.Xr mandoc 1
.
.
+.Sh STANDARDS
+.Rs
+.%A The Unicode Consortium
+.%T The Unicode Standard: Worldwide Character Encoding, Version 5.2
+.%D 1991
+.Re
+.Rs
+.%A W3C
+.%T HTML 4.01 Specification
+.%D December, 1999
+.Re
+.
+.
.Sh AUTHORS
The
.Nm