summaryrefslogtreecommitdiffstats
path: root/mdoc.3
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2010-10-10 09:47:05 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2010-10-10 09:47:05 +0000
commit7c883a6afda56f0ec3e7463a1c7ef6c39f7207ee (patch)
treecf69da750411f1831e7508d35520a98ac24d7e21 /mdoc.3
parent6a17bcf5ed0e454052dceadd76bb46d8e703c2f8 (diff)
downloadmandoc-7c883a6afda56f0ec3e7463a1c7ef6c39f7207ee.tar.gz
Cleaned up library manuals: removed old escapes, added EXAMPLES, stripped
out some superfluous stuff.
Diffstat (limited to 'mdoc.3')
-rw-r--r--mdoc.336
1 files changed, 7 insertions, 29 deletions
diff --git a/mdoc.3 b/mdoc.3
index c5998d34..f73b8e70 100644
--- a/mdoc.3
+++ b/mdoc.3
@@ -79,43 +79,18 @@ The
.Fn mdoc_reset
function may be used in order to reset the parser for another input
sequence.
-See the
-.Sx EXAMPLES
-section for a simple example.
-.Pp
-This section further defines the
-.Sx Types ,
-.Sx Functions
-and
-.Sx Variables
-available to programmers.
-Following that, the
-.Sx Abstract Syntax Tree
-section documents the output tree.
.Ss Types
-Both functions (see
-.Sx Functions )
-and variables (see
-.Sx Variables )
-may use the following types:
.Bl -ohang
.It Vt struct mdoc
-An opaque type defined in
-.Pa mdoc.c .
+An opaque type.
Its values are only used privately within the library.
.It Vt struct mdoc_node
A parsed node.
-Defined in
-.Pa mdoc.h .
See
.Sx Abstract Syntax Tree
for details.
-.It Vt mandocmsg
-A function callback type defined in
-.Pa mandoc.h .
.El
.Ss Functions
-Function descriptions follow:
.Bl -ohang
.It Fn mdoc_alloc
Allocates a parsing structure.
@@ -166,7 +141,6 @@ or
return 0, the data will be incomplete.
.El
.Ss Variables
-The following variables are also defined:
.Bl -ohang
.It Va mdoc_macronames
An array of string-ified token names.
@@ -354,9 +328,13 @@ parsed(mdoc, node);
mdoc_free(mdoc);
.Ed
.Pp
-Please see
+To compile this, execute
+.Pp
+.D1 % cc main.c libmdoc.a libmandoc.a
+.Pp
+where
.Pa main.c
-in the source archive for a rigorous reference.
+is the example file.
.Sh SEE ALSO
.Xr mandoc 1 ,
.Xr mdoc 7