-.Dd December 1, 2014
+.Dd $Mdocdate: July 8 2017 $
.Dt MANDOC_HEADERS 3
.Os
.Sh NAME
.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
.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 ,
.Vt struct tbl_dat ,
.Vt struct tbl_span ,
.Vt struct eqn_box ,
-.Vt struct eqn ,
the function prototype typedef
.Fn mandocmsg ,
the function
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 ,
.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
from
.Pa roff.c
for function prototypes.
-Uses the types
-.Vt struct tbl_span
-and
-.Vt struct eqn
-from
-.Pa mandoc.h
-and
+Uses the type
.Vt struct roff_man
from
.Pa roff.h
-as opaque types for function prototypes.
+as an opaque type for function prototypes.
.It Qq Pa roff_int.h
Requires
.Qq Pa roff.h
.Qq Pa roff.c .
.Pp
Uses the types
-.Vt struct eqn
-and
-.Vt struct tbl_span
-from
-.Pa mandoc.h ,
.Vt struct roff_man
and
.Vt struct roff_node
from
-.Pa roff.h ,
+.Pa roff.h
and
.Vt struct mdoc_arg
from
.Qq Pa roff.h
for
.Vt enum roff_tok .
+.Pp
Provides
.Vt struct man_macro
and some functions internal to the
Requires
.In sys/types.h
for
-.Vt size_t ,
+.Vt size_t
+and
.Qq Pa mandoc.h
for
.Vt struct tbl_*
and
-.Vt struct eqn ,
-and
-.Qq Pa libmandoc.h
-for
-.Vt enum rofferr .
+.Vt struct eqn_box .
.Pp
Provides
.Vt enum tbl_part ,
.Vt enum termtype ,
.Vt struct termp_tbl ,
.Vt struct termp ,
+.Fn roff_term_pre ,
and many terminal formatting functions.
.Pp
Uses the opaque type
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.
Requires
.In sys/types.h
for
-.Vt size_t ,
-.In stdio.h
-for
-.Dv BUFSIZ ,
+.Vt size_t
and
.Qq Pa out.h
for
.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
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
git.ckatri.com / mandoc.git / blobdiff