diff options
author | Kristaps Dzonsons <kristaps@bsd.lv> | 2010-10-10 09:47:05 +0000 |
---|---|---|
committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2010-10-10 09:47:05 +0000 |
commit | 7c883a6afda56f0ec3e7463a1c7ef6c39f7207ee (patch) | |
tree | cf69da750411f1831e7508d35520a98ac24d7e21 /mdoc.3 | |
parent | 6a17bcf5ed0e454052dceadd76bb46d8e703c2f8 (diff) | |
download | mandoc-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.3 | 36 |
1 files changed, 7 insertions, 29 deletions
@@ -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 |