summaryrefslogtreecommitdiffstatshomepage
path: root/mdoc.3
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-02-24 13:46:54 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-02-24 13:46:54 +0000
commit89fbd7032339cc31f5c189d02050375f532bf281 (patch)
treea35fe7a2a24198f6d55f9f47e12c34ca3b5f2761 /mdoc.3
parentccc5179dd8a95f3867173f5e2265d6153b9d2635 (diff)
downloadmandoc-89fbd7032339cc31f5c189d02050375f532bf281.tar.gz
mandoc-89fbd7032339cc31f5c189d02050375f532bf281.tar.zst
mandoc-89fbd7032339cc31f5c189d02050375f532bf281.zip
Character-encoding checked for all text (arguments/values).
Diffstat (limited to 'mdoc.3')
-rw-r--r--mdoc.323
1 files changed, 20 insertions, 3 deletions
diff --git a/mdoc.3 b/mdoc.3
index 059d8cf5..0adf9302 100644
--- a/mdoc.3
+++ b/mdoc.3
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.3,v 1.9 2009/02/23 15:19:47 kristaps Exp $
+.\" $Id: mdoc.3,v 1.10 2009/02/24 13:46:54 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
@@ -16,7 +16,7 @@
.\" TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: February 23 2009 $
+.Dd $Mdocdate: February 24 2009 $
.Dt mdoc 3
.Os
.\" SECTION
@@ -89,7 +89,9 @@ This section further defines the
.Sx Functions
and
.Sx Variables
-available to programmers. The last sub-section,
+available to programmers. Following that,
+.Sx Character Encoding
+describes input format. Lastly,
.Sx Abstract Syntax Tree ,
documents the output tree.
.\" SUBSECTION
@@ -174,6 +176,21 @@ An array of string-ified token names.
An array of string-ified token argument names.
.El
.\" SUBSECTION
+.Ss Character Encoding
+The
+.Xr mdoc 3
+library accepts only printable ASCII characters as defined by
+.Xr isprint 3 .
+Non-ASCII character sequences are escaped with an escape character
+.Sq \\
+and followed by either an open-parenthesis
+.Sq \&(
+for two-character sequences; an open-bracket
+.Sq \&[
+for n-character sequences (terminated at a close-bracket
+.Sq \&] ) ;
+or one of a small set of single characters for other escapes.
+.\" SUBSECTION
.Ss Abstract Syntax Tree
The
.Nm