Adding mdoclint.1 manual.

[mandoc.git] / mdoc.3

diff --git a/mdoc.3 b/mdoc.3
index 76f33555ddd2b9fd6d6b07f0c230c31ecef50ac3..ae2e12c38382384f1854256373f56717b0fb0214 100644 (file)
--- a/mdoc.3
+++ b/mdoc.3
@@ -1,4 +1,4 @@
-.\" $Id: mdoc.3,v 1.6 2009/02/23 09:33:34 kristaps Exp $
+.\" $Id: mdoc.3,v 1.8 2009/02/23 12:45:19 kristaps Exp $
 .\"
 .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
 .\"
@@ -50,10 +50,10 @@
 The
 .Nm mdoc
 library parses lines of mdoc input into an abstract syntax tree.  
-.Dq mdoc
-is a macro package of the
+.Dq mdoc ,
+which is used to format BSD manual pages, is a macro package of the
 .Dq roff
-language, which is used to format BSD manual pages.  The 
+language.  The
 .Nm
 library implements only those macros documented in the
 .Xr mdoc 7
@@ -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