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 | 385a2d9a12f28a334c3d74170511b5200d6166f7 (patch) | |
| tree | cab648e0a31cc530cee2450b910e587f2a890149 /mdoc.3 | |
| parent | 36f3b252438a51f80a6bbeebdb13fb0b11dc7213 (diff) | |
| download | mandoc-385a2d9a12f28a334c3d74170511b5200d6166f7.tar.gz mandoc-385a2d9a12f28a334c3d74170511b5200d6166f7.tar.zst mandoc-385a2d9a12f28a334c3d74170511b5200d6166f7.zip | |
Cleaned up library manuals: removed old escapes, added EXAMPLES, stripped
out some superfluous stuff.
Diffstat (limited to 'mdoc.3')
| -rw-r--r-- | mdoc.3 | 40 |
1 files changed, 9 insertions, 31 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mdoc.3,v 1.49 2010/08/20 01:02:07 schwarze Exp $ +.\" $Id: mdoc.3,v 1.50 2010/10/10 09:47:05 kristaps Exp $ .\" .\" Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org> @@ -15,7 +15,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: August 20 2010 $ +.Dd $Mdocdate: October 10 2010 $ .Dt MDOC 3 .Os .Sh NAME @@ -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 |