summaryrefslogtreecommitdiffstatshomepage
path: root/mdoc.3
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2009-02-23 12:45:19 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2009-02-23 12:45:19 +0000
commit87afbc0e736c0c51230aed2a74f1f10684872d7e (patch)
tree6a17424d1de64387a59166cd7ba593b96bb279b0 /mdoc.3
parent7f0efa8fae853b8421869bf16da3d57b9b4d0da0 (diff)
downloadmandoc-87afbc0e736c0c51230aed2a74f1f10684872d7e.tar.gz
mandoc-87afbc0e736c0c51230aed2a74f1f10684872d7e.tar.zst
mandoc-87afbc0e736c0c51230aed2a74f1f10684872d7e.zip
More in-file documentation and Linux-isation.
Moved mdoc_macros table definition into macro.c, where it belongs.
Diffstat (limited to 'mdoc.3')
-rw-r--r--mdoc.328
1 files changed, 14 insertions, 14 deletions
diff --git a/mdoc.3 b/mdoc.3
index fbab1706..ae2e12c3 100644
--- a/mdoc.3
+++ b/mdoc.3
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.3,v 1.7 2009/02/23 09:46:59 kristaps Exp $
+.\" $Id: mdoc.3,v 1.8 2009/02/23 12:45:19 kristaps Exp $
.\"
.\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
.\"
@@ -238,31 +238,31 @@ where capitalised non-terminals represent nodes.
.Pp
Of note are the TEXT nodes following the HEAD, BODY and TAIL nodes of
the BLOCK production. These refer to punctuation marks. Furthermore,
-although a TEXT node will generally have a non-zero-length string, it
-certain cases, such as
-.Dq \&.Bd \-literal ,
+although a TEXT node will generally have a non-zero-length string, in
+the specific case of
+.Sq \&.Bd \-literal ,
an empty line will produce a zero-length string.
.\" PARAGRAPH
.Pp
-The rule-of-thumb for mapping node types to macros follows: in-line
+The rule-of-thumb for mapping node types to macros follows. In-line
elements, such as
-.Dq \&.Em foo ,
+.Sq \&.Em foo ,
are classified as ELEMENT nodes, which can only contain text.
-Multi-line elements such as
-.Dq \&.Sh
+Multi-line elements, such as
+.Sq \&.Sh ,
are BLOCK elements, where the HEAD constitutes line contents and the
BODY constitutes subsequent lines. In-line elements with matching
pairs, such as
-.Dq \&.So
+.Sq \&.So
and
-.Dq \&.Sc ,
+.Sq \&.Sc ,
are BLOCK elements with no HEAD tag. The only exception to this is
-.Dq \&.Eo
+.Sq \&.Eo
and
-.Dq \&.Ec ,
+.Sq \&.Ec ,
which has a HEAD and TAIL node corresponding to the enclosure string.
-TEXT nodes, obviously, constitute text; the ROOT node is the document's
-root.
+TEXT nodes, obviously, constitute text, and the ROOT node is the
+document's root.
.\" SECTION
.Sh EXAMPLES
The following example reads lines from stdin and parses them, operating