diff options
| -rw-r--r-- | Makefile | 19 | ||||
| -rw-r--r-- | man.3 | 58 | ||||
| -rw-r--r-- | mdoc.3 | 36 |
3 files changed, 26 insertions, 87 deletions
@@ -1,4 +1,9 @@ -.SUFFIXES: .html .xml .sgml .1 .3 .7 .md5 .tar.gz .1.txt .3.txt .7.txt .1.sgml .3.sgml .7.sgml .h .h.html .1.ps .3.ps .7.ps .1.pdf .3.pdf .7.pdf +.SUFFIXES: .html .xml .sgml .1 .3 .7 .md5 .tar.gz +.SUFFIXES: .1.txt .3.txt .7.txt +.SUFFIXES: .1.sgml .3.sgml .7.sgml +.SUFFIXES: .h .h.html +.SUFFIXES: .1.ps .3.ps .7.ps +.SUFFIXES: .1.pdf .3.pdf .7.pdf PREFIX = /usr/local BINDIR = $(PREFIX)/bin @@ -92,26 +97,26 @@ HEADS = mdoc.h libmdoc.h man.h libman.h term.h \ GSGMLS = mandoc.1.sgml mdoc.3.sgml mdoc.7.sgml \ mandoc_char.7.sgml man.7.sgml man.3.sgml roff.7.sgml \ - roff.3.sgml + roff.3.sgml SGMLS = index.sgml HTMLS = ChangeLog.html index.html man.h.html mdoc.h.html \ mandoc.h.html roff.h.html mandoc.1.html mdoc.3.html \ man.3.html mdoc.7.html man.7.html mandoc_char.7.html \ - roff.7.html roff.3.html + roff.7.html roff.3.html PSS = mandoc.1.ps mdoc.3.ps man.3.ps mdoc.7.ps man.7.ps \ - mandoc_char.7.ps roff.7.ps roff.3.ps + mandoc_char.7.ps roff.7.ps roff.3.ps PDFS = mandoc.1.pdf mdoc.3.pdf man.3.pdf mdoc.7.pdf man.7.pdf \ - mandoc_char.7.pdf roff.7.pdf roff.3.pdf + mandoc_char.7.pdf roff.7.pdf roff.3.pdf XSLS = ChangeLog.xsl TEXTS = mandoc.1.txt mdoc.3.txt man.3.txt mdoc.7.txt man.7.txt \ mandoc_char.7.txt ChangeLog.txt \ - roff.7.txt roff.3.txt + roff.7.txt roff.3.txt EXAMPLES = example.style.css @@ -124,7 +129,7 @@ MD5S = mdocml-$(VERSION).md5 TARGZS = mdocml-$(VERSION).tar.gz MANS = mandoc.1 mdoc.3 mdoc.7 mandoc_char.7 man.7 \ - man.3 roff.7 roff.3 + man.3 roff.7 roff.3 BINS = mandoc @@ -76,9 +76,6 @@ The .Fn man_reset function may be used in order to reset the parser for another input sequence. -See the -.Sx EXAMPLES -section for a full example. .Pp Beyond the full set of macros defined in .Xr man 7 , @@ -107,63 +104,18 @@ closing .Pq part of the standard preamble for Perl documentation . Handled as a current-scope line macro. .El -.Pp -Furthermore, the following escapes are accepted to allow -.Xr pod2man 1 -documents to be correctly formatted: -\e*(-- (dash), -\e*(PI (pi), -\e*(L" (left double-quote), -\e*(R" (right double-quote), -\e*(C` (left single-quote), -\e*(C' (right single-quote), -\e*(Aq (apostrophe), -\e*^ (hat), -\e*, (comma), -\e*~ (tilde), -\e*/ (forward slash), -\e*: (umlaut), -\e*8 (beta), -\e*o (degree), -\e*(D- (Eth), -\e*(d- (eth), -\e*(Th (Thorn), -and -\e*(th (thorn). -.Sh REFERENCE -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 man -An opaque type defined in -.Pa man.c . +An opaque type. Its values are only used privately within the library. -.It Vt mandocmsg -A function callback type defined in -.Pa mandoc.h . .It Vt struct man_node A parsed node. -Defined in -.Pa man.h . See .Sx Abstract Syntax Tree for details. .El .Ss Functions -Function descriptions follow: .Bl -ohang .It Fn man_alloc Allocates a parsing structure. @@ -316,9 +268,13 @@ parsed(man, node); man_free(man); .Ed .Pp -Please see +To compile this, execute +.Pp +.D1 % cc main.c libman.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 man 7 @@ -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 |