=================================================================== RCS file: /cvs/mandoc/mandoc_headers.3,v retrieving revision 1.10 retrieving revision 1.17 diff -u -p -r1.10 -r1.17 --- mandoc/mandoc_headers.3 2017/04/24 23:06:18 1.10 +++ mandoc/mandoc_headers.3 2017/07/08 14:51:04 1.17 @@ -1,4 +1,4 @@ -.Dd December 1, 2014 +.Dd $Mdocdate: July 8 2017 $ .Dt MANDOC_HEADERS 3 .Os .Sh NAME @@ -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 @@ -77,6 +87,7 @@ Provides .Vt enum mandoc_esc , .Vt enum mandocerr , .Vt enum mandoclevel , +.Vt enum mandoc_os , .Vt enum tbl_cellt , .Vt enum tbl_datt , .Vt enum tbl_spant , @@ -90,7 +101,6 @@ Provides .Vt struct tbl_dat , .Vt struct tbl_span , .Vt struct eqn_box , -.Vt struct eqn , the function prototype typedef .Fn mandocmsg , the function @@ -112,7 +122,25 @@ Uses the type from .Pa roff.h as an opaque type for function prototypes. +.It Qq Pa mandoc_xr.h +Provides +.Vt struct mandoc_xr +and the functions +.Fn mandoc_xr_reset , +.Fn mandoc_xr_add , +.Fn mandoc_xr_get , +and +.Fn mandoc_xr_free . .It Qq Pa roff.h +Requires +.Qq Pa mandoc_ohash.h +for +.Vt struct ohash +and +.Qq Pa mandoc.h +for +.Vt enum mandoc_os . +.Pp Provides .Vt enum mdoc_endbody , .Vt enum roff_macroset , @@ -125,8 +153,13 @@ Provides .Vt struct roff_node , the constant array .Va roff_name -and the function -.Fn deroff . +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 @@ -233,8 +266,6 @@ from for function prototypes. Uses the types .Vt struct tbl_span -and -.Vt struct eqn from .Pa mandoc.h and @@ -258,8 +289,6 @@ because the latter two are needed by .Qq Pa roff.c . .Pp Uses the types -.Vt struct eqn -and .Vt struct tbl_span from .Pa mandoc.h , @@ -315,6 +344,7 @@ Requires .Qq Pa roff.h for .Vt enum roff_tok . +.Pp Provides .Vt struct man_macro and some functions internal to the @@ -343,7 +373,7 @@ for for .Vt struct tbl_* and -.Vt struct eqn , +.Vt struct eqn_box , and .Qq Pa libmandoc.h for @@ -417,6 +447,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 @@ -426,11 +457,13 @@ from Uses .Vt struct tbl_span and -.Vt struct eqn +.Vt struct eqn_box from .Pa mandoc.h and .Vt struct roff_meta +and +.Vt struct roff_node from .Pa roff.h as opaque types for function prototypes. @@ -443,10 +476,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 @@ -462,8 +492,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_box +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 @@ -501,8 +544,9 @@ Provides and the functions .Fn manconf_parse , .Fn manconf_output , +.Fn manconf_free , and -.Fn manconf_free . +.Fn manpath_base . .It Qq Pa mansearch.h Requires .In sys/types.h