diff options
author | Baptiste Daroussin <bapt@FreeBSD.org> | 2017-06-08 19:29:07 +0000 |
---|---|---|
committer | Baptiste Daroussin <bapt@FreeBSD.org> | 2017-06-08 19:29:07 +0000 |
commit | 7ad21139cd51f34b1749abea843f7f513b4a6410 (patch) | |
tree | 75256d41669ecdcdfe88b3f6d39c3b1691451b8f /mandoc_headers.3 | |
parent | 6cae2c9f93ec8d6e7a8bce06b82bed67f2d6450b (diff) | |
download | src-7ad21139cd51f34b1749abea843f7f513b4a6410.tar.gz src-7ad21139cd51f34b1749abea843f7f513b4a6410.zip |
Import mandoc 2017-06-08vendor/mandoc/20170608
Notes
Notes:
svn path=/vendor/mdocml/dist/; revision=319715
svn path=/vendor/mdocml/20170608/; revision=319716; tag=vendor/mandoc/20170608
Diffstat (limited to 'mandoc_headers.3')
-rw-r--r-- | mandoc_headers.3 | 67 |
1 files changed, 56 insertions, 11 deletions
diff --git a/mandoc_headers.3 b/mandoc_headers.3 index b8c204bb5bcf..f061332c83da 100644 --- a/mandoc_headers.3 +++ b/mandoc_headers.3 @@ -60,9 +60,19 @@ Requires .In sys/types.h for .Vt size_t . +.Pp Provides the utility functions documented in .Xr mandoc_malloc 3 . .It Qq Pa mandoc_ohash.h +Requires +.In stddef.h +for +.Vt ptrdiff_t +and +.In stdint.h +for +.Vt uint32_t . +.Pp Includes .In ohash.h and provides @@ -113,17 +123,30 @@ from .Pa roff.h as an opaque type for function prototypes. .It Qq Pa roff.h +Requires +.Qq Pa mandoc_ohash.h +for +.Vt struct ohash . +.Pp Provides .Vt enum mdoc_endbody , .Vt enum roff_macroset , .Vt enum roff_next , .Vt enum roff_sec , +.Vt enum roff_tok , .Vt enum roff_type , .Vt struct roff_man , .Vt struct roff_meta , .Vt struct roff_node , -and the function -.Fn deroff . +the constant array +.Va roff_name +and the functions +.Fn deroff , +.Fn roffhash_alloc , +.Fn roffhash_find , +.Fn roffhash_free , +and +.Fn roff_validate . .Pp Uses pointers to the types .Vt struct mdoc_arg @@ -198,9 +221,10 @@ or .El .Ss Parser internals The following headers require inclusion of a parser interface header -before they can be included. All parser interface headers should -precede all parser internal headers. When any parser internal headers -are included, the same file should not include any formatter headers. +before they can be included. +All parser interface headers should precede all parser internal headers. +When any parser internal headers are included, the same file should +not include any formatter headers. .Bl -tag -width Ds .It Qq Pa libmandoc.h Requires @@ -271,6 +295,10 @@ from as opaque types for function prototypes. .It Qq Pa libmdoc.h Requires +.Qq Pa roff.h +for +.Vt enum roff_tok +and .Qq Pa mdoc.h for .Vt enum mdoc_* @@ -303,6 +331,11 @@ When this header is included, the same file should not include or .Pa libroff.h . .It Qq Pa libman.h +Requires +.Qq Pa roff.h +for +.Vt enum roff_tok . +.Pp Provides .Vt struct man_macro and some functions internal to the @@ -405,6 +438,7 @@ Provides .Vt enum termtype , .Vt struct termp_tbl , .Vt struct termp , +.Fn roff_term_pre , and many terminal formatting functions. .Pp Uses the opaque type @@ -419,6 +453,8 @@ from .Pa mandoc.h and .Vt struct roff_meta +and +.Vt struct roff_node from .Pa roff.h as opaque types for function prototypes. @@ -431,10 +467,7 @@ or Requires .In sys/types.h for -.Vt size_t , -.In stdio.h -for -.Dv BUFSIZ , +.Vt size_t and .Qq Pa out.h for @@ -450,8 +483,21 @@ Provides .Vt struct tagq , .Vt struct htmlpair , .Vt struct html , +.Fn roff_html_pre , and many HTML formatting functions. .Pp +Uses +.Vt struct tbl_span +and +.Vt struct eqn +from +.Pa mandoc.h +and +.Vt struct roff_node +from +.Pa roff.h +as opaque types for function prototypes. +.Pp When this header is included, the same file should not include .Pa term.h or @@ -506,8 +552,7 @@ Provides .Vt struct manpage , .Vt struct mansearch , and the functions -.Fn mansearch_setup , -.Fn mansearch , +.Fn mansearch and .Fn mansearch_free . .Pp |