version 1.14, 2017/06/24 14:38:32 |
version 1.35, 2022/04/14 16:43:44 |
|
|
.Dd December 1, 2014 |
.\" $Id$ |
|
.\" |
|
.\" Copyright (c) 2014-2022 Ingo Schwarze <schwarze@openbsd.org> |
|
.\" |
|
.\" Permission to use, copy, modify, and distribute this software for any |
|
.\" purpose with or without fee is hereby granted, provided that the above |
|
.\" copyright notice and this permission notice appear in all copies. |
|
.\" |
|
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
|
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
|
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
|
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
|
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
|
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
.\" |
|
.Dd $Mdocdate$ |
.Dt MANDOC_HEADERS 3 |
.Dt MANDOC_HEADERS 3 |
.Os |
.Os |
.Sh NAME |
.Sh NAME |
Line 9 To support a cleaner coding style, the mandoc header f |
|
Line 25 To support a cleaner coding style, the mandoc header f |
|
contain any include directives and do not guard against multiple |
contain any include directives and do not guard against multiple |
inclusion. |
inclusion. |
The application developer has to make sure that the headers are |
The application developer has to make sure that the headers are |
included in a proper order, and that no header is included more |
included in the order shown in this manual page, |
than once. |
and that no header is included more than once. |
.Pp |
.Pp |
The headers and functions form three major groups: |
The headers and functions form three major groups: |
.Sx Parser interface , |
.Sx Parser interface , |
Line 25 separate from each other: |
|
Line 41 separate from each other: |
|
.Pp |
.Pp |
.Bl -dash -offset indent -compact |
.Bl -dash -offset indent -compact |
.It |
.It |
|
.Xr roff 7 |
|
parser |
|
.It |
.Xr mdoc 7 |
.Xr mdoc 7 |
parser |
parser |
.It |
.It |
.Xr man 7 |
.Xr man 7 |
parser |
parser |
.It |
.It |
.Xr roff 7 |
|
parser |
|
.It |
|
.Xr tbl 7 |
.Xr tbl 7 |
parser |
parser |
.It |
.It |
Line 45 terminal formatters |
|
Line 61 terminal formatters |
|
HTML formatters |
HTML formatters |
.It |
.It |
search tools |
search tools |
|
.It |
|
main programs |
.El |
.El |
.Pp |
.Pp |
Note that mere usage of an opaque struct type does |
Note that mere usage of an opaque struct type does |
Line 56 any other mandoc header. |
|
Line 74 any other mandoc header. |
|
These headers should be included before any other mandoc headers. |
These headers should be included before any other mandoc headers. |
.Bl -tag -width Ds |
.Bl -tag -width Ds |
.It Qq Pa mandoc_aux.h |
.It Qq Pa mandoc_aux.h |
|
Memory allocation utility functions; can be used everywhere. |
|
.Pp |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t . |
.Vt size_t . |
.Pp |
.Pp |
Provides the utility functions documented in |
Provides the functions documented in |
.Xr mandoc_malloc 3 . |
.Xr mandoc_malloc 3 . |
|
.Pp |
|
When this header is included, the same file must not include |
|
.Qq Pa mandoc_dbg.h |
|
because |
|
.Qq Pa mandoc_aux.h |
|
automatically includes |
|
.Qq Pa mandoc_dbg.h |
|
if and only if the preprocessor symbol |
|
.Dv DEBUG_MEMORY |
|
is defined. |
|
.It Qq Pa mandoc_dbg.h |
|
Debugging utility functions and |
|
debugging wrappers around memory allocation functions. |
|
.Pp |
|
Requires |
|
.In sys/types.h |
|
for |
|
.Vt size_t . |
|
.Pp |
|
Provides the functions documented in |
|
.Xr mandoc_dbg_init 3 . |
|
.Pp |
|
This header must not be included unless the preprocessor symbol |
|
.Dv DEBUG_MEMORY |
|
is defined. |
|
When this header is included, the same file must not include |
|
.Qq Pa mandoc_aux.h . |
.It Qq Pa mandoc_ohash.h |
.It Qq Pa mandoc_ohash.h |
|
Hashing utility functions; can be used everywhere. |
|
.Pp |
Requires |
Requires |
.In stddef.h |
.In stddef.h |
for |
for |
|
|
and provides |
and provides |
.Fn mandoc_ohash_init . |
.Fn mandoc_ohash_init . |
.It Qq Pa mandoc.h |
.It Qq Pa mandoc.h |
|
Error handling, escape sequence, and character utilities; |
|
can be used everywhere. |
|
.Pp |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t . |
.Vt size_t |
|
and |
|
.In stdio.h |
|
for |
|
.Vt FILE . |
.Pp |
.Pp |
Provides |
Provides |
.Vt enum mandoc_esc , |
.Vt enum mandoc_esc , |
.Vt enum mandocerr , |
.Vt enum mandocerr , |
.Vt enum mandoclevel , |
.Vt enum mandoclevel , |
.Vt enum mandoc_os , |
|
.Vt enum tbl_cellt , |
|
.Vt enum tbl_datt , |
|
.Vt enum tbl_spant , |
|
.Vt enum eqn_boxt , |
|
.Vt enum eqn_fontt , |
|
.Vt enum eqn_pilet , |
|
.Vt enum eqn_post , |
|
.Vt struct tbl_opts , |
|
.Vt struct tbl_cell , |
|
.Vt struct tbl_row , |
|
.Vt struct tbl_dat , |
|
.Vt struct tbl_span , |
|
.Vt struct eqn_box , |
|
.Vt struct eqn , |
|
the function prototype typedef |
|
.Fn mandocmsg , |
|
the function |
the function |
.Xr mandoc_escape 3 , |
.Xr mandoc_escape 3 , |
the functions described in |
the functions described in |
.Xr mchars_alloc 3 , |
.Xr mchars_alloc 3 , |
and the functions |
and the |
.Fn mparse_* |
.Fn mandoc_msg* |
described in |
functions. |
.Xr mandoc 3 . |
|
.Pp |
|
Uses the opaque type |
|
.Vt struct mparse |
|
from |
|
.Pa read.c |
|
for function prototypes. |
|
Uses the type |
|
.Vt struct roff_man |
|
from |
|
.Pa roff.h |
|
as an opaque type for function prototypes. |
|
.It Qq Pa roff.h |
.It Qq Pa roff.h |
Requires |
Common data types for all syntax trees and related functions; |
.Qq Pa mandoc_ohash.h |
can be used everywhere. |
for |
|
.Vt struct ohash |
|
and |
|
.Qq Pa mandoc.h |
|
for |
|
.Vt enum mandoc_os . |
|
.Pp |
.Pp |
Provides |
Provides |
|
.Vt enum mandoc_os , |
.Vt enum mdoc_endbody , |
.Vt enum mdoc_endbody , |
.Vt enum roff_macroset , |
.Vt enum roff_macroset , |
.Vt enum roff_next , |
|
.Vt enum roff_sec , |
.Vt enum roff_sec , |
.Vt enum roff_tok , |
.Vt enum roff_tok , |
.Vt enum roff_type , |
.Vt enum roff_type , |
|
|
.Vt struct roff_node , |
.Vt struct roff_node , |
the constant array |
the constant array |
.Va roff_name |
.Va roff_name |
and the functions |
and the function |
.Fn deroff , |
.Fn deroff . |
.Fn roffhash_alloc , |
|
.Fn roffhash_find , |
|
.Fn roffhash_free , |
|
and |
|
.Fn roff_validate . |
|
.Pp |
.Pp |
Uses pointers to the types |
Uses pointers to the types |
|
.Vt struct ohash |
|
from |
|
.Qq Pa mandoc_ohash.h , |
.Vt struct mdoc_arg |
.Vt struct mdoc_arg |
and |
and |
.Vt union mdoc_data |
.Vt union mdoc_data |
from |
from |
.Pa mdoc.h |
.Qq Pa mdoc.h , |
|
.Vt struct tbl_span |
|
from |
|
.Qq Pa tbl.h , |
|
and |
|
.Vt struct eqn_box |
|
from |
|
.Qq Pa eqn.h |
as opaque struct members. |
as opaque struct members. |
|
.It Qq Pa tbl.h |
|
Data structures for the |
|
.Xr tbl 7 |
|
parse tree; can be used everywhere. |
|
.Pp |
|
Requires |
|
.In sys/types.h |
|
for |
|
.Vt size_t |
|
and |
|
.Qq Pa mandoc.h |
|
for |
|
.Vt enum mandoc_esc . |
|
.Pp |
|
Provides |
|
.Vt enum tbl_cellt , |
|
.Vt enum tbl_datt , |
|
.Vt enum tbl_spant , |
|
.Vt struct tbl_opts , |
|
.Vt struct tbl_cell , |
|
.Vt struct tbl_row , |
|
.Vt struct tbl_dat , |
|
and |
|
.Vt struct tbl_span . |
|
.It Qq Pa eqn.h |
|
Data structures for the |
|
.Xr eqn 7 |
|
parse tree; can be used everywhere. |
|
.Pp |
|
Requires |
|
.In sys/types.h |
|
for |
|
.Vt size_t . |
|
.Pp |
|
Provides |
|
.Vt enum eqn_boxt , |
|
.Vt enum eqn_fontt , |
|
.Vt enum eqn_post , |
|
and |
|
.Vt struct eqn_box . |
|
.It Qq Pa mandoc_parse.h |
|
Top level parser interface, for use in the main program |
|
and in the main parser, but not in formatters. |
|
.Pp |
|
Requires |
|
.Qq Pa mandoc.h |
|
for |
|
.Vt enum mandocerr |
|
and |
|
.Vt enum mandoclevel |
|
and |
|
.Qq Pa roff.h |
|
for |
|
.Vt enum mandoc_os . |
|
.Pp |
|
Uses the opaque type |
|
.Vt struct mparse |
|
from |
|
.Pa read.c |
|
for function prototypes. |
|
Uses |
|
.Vt struct roff_meta |
|
from |
|
.Qq Pa roff.h |
|
as an opaque type for function prototypes. |
|
.It Qq Pa mandoc_xr.h |
|
Cross reference validation; intended for use in the main program |
|
and in parsers, but not in formatters. |
|
.Pp |
|
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 tag.h |
|
Internal interfaces to tag syntax tree nodes, |
|
for use by validation modules only. |
|
.Pp |
|
Requires |
|
.In limits.h |
|
for |
|
.Dv INT_MAX . |
|
.Pp |
|
Provides the functions |
|
.Fn tag_alloc , |
|
.Fn tag_put , |
|
.Fn tag_check , |
|
and |
|
.Fn tag_free |
|
and some |
|
.Dv TAG_* |
|
constants. |
|
.Pp |
|
Uses the type |
|
.Vt struct roff_node |
|
from |
|
.Qq Pa roff.h |
|
as an opaque type for function prototypes. |
.El |
.El |
.Pp |
.Pp |
The following two require |
The following two require |
Line 192 and the functions |
|
Line 319 and the functions |
|
described in |
described in |
.Xr mandoc 3 . |
.Xr mandoc 3 . |
.Pp |
.Pp |
Uses the type |
Uses the types |
|
.Vt struct roff_node |
|
from |
|
.Qq Pa roff.h |
|
and |
.Vt struct roff_man |
.Vt struct roff_man |
from |
from |
.Pa roff.h |
.Qq Pa roff_int.h |
as an opaque type for function prototypes. |
as opaque types for function prototypes. |
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa libman.h |
internals of different parsers. |
or |
|
.Pa libroff.h . |
|
.It Qq Pa man.h |
.It Qq Pa man.h |
Provides the functions |
Provides the functions |
.Fn man_* |
.Fn man_* |
described in |
described in |
.Xr mandoc 3 . |
.Xr mandoc 3 . |
.Pp |
.Pp |
Uses the opaque type |
|
.Vt struct mparse |
|
from |
|
.Pa read.c |
|
for function prototypes. |
|
Uses the type |
Uses the type |
.Vt struct roff_man |
.Vt struct roff_man |
from |
from |
.Pa roff.h |
.Qq Pa roff.h |
as an opaque type for function prototypes. |
as an opaque type for function prototypes. |
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa libmdoc.h |
internals of different parsers. |
or |
|
.Pa libroff.h . |
|
.El |
.El |
.Ss Parser internals |
.Ss Parser internals |
The following headers require inclusion of a parser interface header |
Most of the following headers require inclusion of a parser interface header |
before they can be included. |
before they can be included. |
All parser interface headers should precede all parser internal headers. |
All parser interface headers should precede all parser internal headers. |
When any parser internal headers are included, the same file should |
When any parser internal headers are included, the same file should |
|
|
.Vt enum mandocerr . |
.Vt enum mandocerr . |
.Pp |
.Pp |
Provides |
Provides |
.Vt enum rofferr , |
|
.Vt struct buf , |
.Vt struct buf , |
utility functions needed by multiple parsers, |
utility functions needed by multiple parsers, |
and the top-level functions to call the parsers. |
and the top-level functions to call the parsers. |
.Pp |
.Pp |
Uses the opaque types |
Uses the opaque type |
.Vt struct mparse |
|
from |
|
.Pa read.c |
|
and |
|
.Vt struct roff |
.Vt struct roff |
from |
from |
.Pa roff.c |
.Pa roff.c |
for function prototypes. |
for function prototypes. |
Uses the types |
Uses the type |
.Vt struct tbl_span |
|
and |
|
.Vt struct eqn |
|
from |
|
.Pa mandoc.h |
|
and |
|
.Vt struct roff_man |
.Vt struct roff_man |
from |
from |
.Pa roff.h |
.Qq Pa roff.h |
as opaque types for function prototypes. |
as an opaque type for function prototypes. |
.It Qq Pa roff_int.h |
.It Qq Pa roff_int.h |
|
Parser internals shared by multiple parsers. |
|
Can be used in all parsers, but not in main programs or formatters. |
|
.Pp |
Requires |
Requires |
.Qq Pa roff.h |
.Qq Pa roff.h |
for |
for |
.Vt enum roff_type . |
.Vt enum roff_type |
|
and |
|
.Vt enum roff_tok . |
.Pp |
.Pp |
Provides functions named |
Provides |
|
.Vt enum roff_next , |
|
.Vt struct roff_man , |
|
functions named |
.Fn roff_* |
.Fn roff_* |
to handle roff nodes and the two special functions |
to handle roff nodes, |
|
.Fn roffhash_alloc , |
|
.Fn roffhash_find , |
|
.Fn roffhash_free , |
|
and |
|
.Fn roff_validate , |
|
and the two special functions |
.Fn man_breakscope |
.Fn man_breakscope |
and |
and |
.Fn mdoc_argv_free |
.Fn mdoc_argv_free |
because the latter two are needed by |
because the latter two are needed by |
.Qq Pa roff.c . |
.Pa roff.c . |
.Pp |
.Pp |
Uses the types |
Uses the types |
.Vt struct eqn |
.Vt struct ohash |
and |
|
.Vt struct tbl_span |
|
from |
from |
.Pa mandoc.h , |
.Qq Pa mandoc_ohash.h , |
.Vt struct roff_man |
|
and |
|
.Vt struct roff_node |
.Vt struct roff_node |
|
and |
|
.Vt struct roff_meta |
from |
from |
.Pa roff.h , |
.Qq Pa roff.h , |
|
.Vt struct roff |
|
from |
|
.Pa roff.c , |
and |
and |
.Vt struct mdoc_arg |
.Vt struct mdoc_arg |
from |
from |
.Pa mdoc.h |
.Qq Pa mdoc.h |
as opaque types for function prototypes. |
as opaque types for function prototypes. |
.It Qq Pa libmdoc.h |
.It Qq Pa libmdoc.h |
Requires |
Requires |
|
|
for |
for |
.Vt enum roff_tok |
.Vt enum roff_tok |
and |
and |
.Qq Pa mdoc.h |
.Vt enum roff_sec . |
for |
|
.Vt enum mdoc_* |
|
and |
|
.Vt struct mdoc_* . |
|
.Pp |
.Pp |
Provides |
Provides |
.Vt enum margserr , |
.Vt enum margserr , |
Line 318 and many functions internal to the |
|
Line 440 and many functions internal to the |
|
.Xr mdoc 7 |
.Xr mdoc 7 |
parser. |
parser. |
.Pp |
.Pp |
Uses the opaque type |
|
.Vt struct mparse |
|
from |
|
.Pa read.c . |
|
Uses the types |
Uses the types |
|
.Vt struct roff_node |
|
from |
|
.Qq Pa roff.h , |
.Vt struct roff_man |
.Vt struct roff_man |
|
from |
|
.Qq Pa roff_int.h , |
and |
and |
.Vt struct roff_node |
.Vt struct mdoc_arg |
from |
from |
.Pa roff.h |
.Qq Pa mdoc.h |
as opaque types for function prototypes. |
as opaque types for function prototypes. |
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa man.h , |
interfaces of different parsers. |
.Pa libman.h , |
|
or |
|
.Pa libroff.h . |
|
.It Qq Pa libman.h |
.It Qq Pa libman.h |
Requires |
Requires |
.Qq Pa roff.h |
.Qq Pa roff.h |
Line 348 and some functions internal to the |
|
Line 468 and some functions internal to the |
|
parser. |
parser. |
.Pp |
.Pp |
Uses the types |
Uses the types |
.Vt struct roff_man |
|
and |
|
.Vt struct roff_node |
.Vt struct roff_node |
from |
from |
.Pa roff.h |
.Qq Pa roff.h |
|
and |
|
.Vt struct roff_man |
|
from |
|
.Qq Pa roff_int.h |
as opaque types for function prototypes. |
as opaque types for function prototypes. |
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa mdoc.h , |
interfaces of different parsers. |
.Pa libmdoc.h , |
.It Qq Pa eqn_parse.h |
or |
External interface of the |
.Pa libroff.h . |
.Xr eqn 7 |
.It Qq Pa libroff.h |
parser, for use in the |
|
.Xr roff 7 |
|
and |
|
.Xr eqn 7 |
|
parsers only. |
|
.Pp |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t , |
.Vt size_t . |
|
.Pp |
|
Provides |
|
.Vt struct eqn_node |
|
and the functions |
|
.Fn eqn_alloc , |
|
.Fn eqn_box_new , |
|
.Fn eqn_box_free , |
|
.Fn eqn_free , |
|
.Fn eqn_parse , |
|
.Fn eqn_read , |
|
and |
|
.Fn eqn_reset . |
|
.Pp |
|
Uses the type |
|
.Vt struct eqn_box |
|
from |
.Qq Pa mandoc.h |
.Qq Pa mandoc.h |
for |
as an opaque type for function prototypes. |
.Vt struct tbl_* |
Uses the types |
|
.Vt struct roff_node |
|
from |
|
.Qq Pa roff.h |
and |
and |
.Vt struct eqn , |
.Vt struct eqn_def |
|
from |
|
.Pa eqn.c |
|
as opaque struct members. |
|
.Pp |
|
When this header is included, the same file should not include |
|
internals of different parsers. |
|
.It Qq Pa tbl_parse.h |
|
External interface of the |
|
.Xr tbl 7 |
|
parser, for use in the |
|
.Xr roff 7 |
and |
and |
.Qq Pa libmandoc.h |
.Xr tbl 7 |
|
parsers only. |
|
.Pp |
|
Provides the functions documented in |
|
.Xr tbl 3 . |
|
.Pp |
|
Uses the types |
|
.Vt struct tbl_span |
|
from |
|
.Qq Pa tbl.h |
|
and |
|
.Vt struct tbl_node |
|
from |
|
.Qq Pa tbl_int.h |
|
as opaque types for function prototypes. |
|
.Pp |
|
When this header is included, the same file should not include |
|
internals of different parsers. |
|
.It Qq Pa tbl_int.h |
|
Internal interfaces of the |
|
.Xr tbl 7 |
|
parser, for use inside the |
|
.Xr tbl 7 |
|
parser only. |
|
.Pp |
|
Requires |
|
.Qq Pa tbl.h |
for |
for |
.Vt enum rofferr . |
.Vt struct tbl_opts . |
.Pp |
.Pp |
Provides |
Provides |
.Vt enum tbl_part , |
.Vt enum tbl_part , |
.Vt struct tbl_node , |
.Vt struct tbl_node , |
.Vt struct eqn_def , |
and the functions |
.Vt struct eqn_node , |
.Fn tbl_option , |
and many functions internal to the |
.Fn tbl_layout , |
.Xr tbl 7 |
.Fn tbl_data , |
|
.Fn tbl_cdata , |
and |
and |
.Xr eqn 7 |
.Fn tbl_reset . |
parsers. |
|
.Pp |
.Pp |
Uses the opaque type |
|
.Vt struct mparse |
|
from |
|
.Pa read.c . |
|
.Pp |
|
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa man.h , |
interfaces of different parsers. |
.Pa mdoc.h , |
|
.Pa libman.h , |
|
or |
|
.Pa libmdoc.h . |
|
.El |
.El |
.Ss Formatter interface |
.Ss Formatter interface |
These headers should be included after any parser interface headers. |
These headers should be included after any parser interface headers. |
|
|
Uses |
Uses |
.Vt struct tbl_span |
.Vt struct tbl_span |
from |
from |
.Pa mandoc.h |
.Qq Pa mandoc.h |
as an opaque type for function prototypes. |
as an opaque type for function prototypes. |
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa mansearch.h . |
.Qq Pa mansearch.h . |
.It Qq Pa term.h |
.It Qq Pa term.h |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
|
|
Uses |
Uses |
.Vt struct tbl_span |
.Vt struct tbl_span |
and |
and |
.Vt struct eqn |
.Vt struct eqn_box |
from |
from |
.Pa mandoc.h |
.Qq Pa mandoc.h |
and |
and |
.Vt struct roff_meta |
.Vt struct roff_meta |
and |
and |
.Vt struct roff_node |
.Vt struct roff_node |
from |
from |
.Pa roff.h |
.Qq Pa roff.h |
as opaque types for function prototypes. |
as opaque types for function prototypes. |
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa html.h |
.Qq Pa html.h |
or |
or |
.Pa mansearch.h . |
.Qq Pa mansearch.h . |
.It Qq Pa html.h |
.It Qq Pa tag_term.h |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
for |
for |
.Vt size_t |
.Vt size_t |
and |
and |
|
.In stdio.h |
|
for |
|
.Vt FILE . |
|
.Pp |
|
Provides an interface to generate |
|
.Xr ctags 1 |
|
files for the |
|
.Ic :t |
|
functionality mentioned in |
|
.Xr man 1 . |
|
.Pp |
|
Uses the type |
|
.Vt struct roff_node |
|
from |
|
.Qq Pa roff.h |
|
as an opaque type for function prototypes. |
|
.Pp |
|
When this header is included, the same file should not include |
|
.Qq Pa html.h |
|
or |
|
.Qq Pa mansearch.h . |
|
.It Qq Pa html.h |
|
Requires |
|
.In sys/types.h |
|
for |
|
.Vt size_t , |
|
.Qq Pa mandoc.h |
|
for |
|
.Vt enum mandoc_esc , |
|
.Qq Pa roff.h |
|
for |
|
.Vt enum roff_tok , |
|
and |
.Qq Pa out.h |
.Qq Pa out.h |
for |
for |
.Vt struct roffsu |
.Vt struct roffsu |
Line 494 and many HTML formatting functions. |
|
Line 701 and many HTML formatting functions. |
|
Uses |
Uses |
.Vt struct tbl_span |
.Vt struct tbl_span |
and |
and |
.Vt struct eqn |
.Vt struct eqn_box |
from |
from |
.Pa mandoc.h |
.Qq Pa mandoc.h |
and |
and |
.Vt struct roff_node |
.Vt struct roff_node |
from |
from |
.Pa roff.h |
.Qq Pa roff.h |
as opaque types for function prototypes. |
as opaque types for function prototypes. |
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa term.h |
.Qq Pa term.h , |
|
.Qq Pa tab_term.h , |
or |
or |
.Pa mansearch.h . |
.Qq Pa mansearch.h . |
.It Qq Pa tag.h |
|
Requires |
|
.In sys/types.h |
|
for |
|
.Vt size_t . |
|
.Pp |
|
Provides an interface to generate |
|
.Xr ctags 1 |
|
files for the |
|
.Ic :t |
|
functionality mentioned in |
|
.Xr man 1 . |
|
.It Qq Pa main.h |
.It Qq Pa main.h |
Provides the top level steering functions for all formatters. |
Provides the top level steering functions for all formatters. |
.Pp |
.Pp |
Uses the type |
Uses the type |
.Vt struct roff_man |
.Vt struct roff_meta |
from |
from |
.Pa roff.h |
.Qq Pa roff.h |
as an opaque type for function prototypes. |
as an opaque type for function prototypes. |
.It Qq Pa manconf.h |
.It Qq Pa manconf.h |
Requires |
Requires |
|
|
and the functions |
and the functions |
.Fn manconf_parse , |
.Fn manconf_parse , |
.Fn manconf_output , |
.Fn manconf_output , |
|
.Fn manconf_free , |
and |
and |
.Fn manconf_free . |
.Fn manpath_base . |
.It Qq Pa mansearch.h |
.It Qq Pa mansearch.h |
Requires |
Requires |
.In sys/types.h |
.In sys/types.h |
|
|
Uses |
Uses |
.Vt struct manpaths |
.Vt struct manpaths |
from |
from |
.Pa manconf.h |
.Qq Pa manconf.h |
as an opaque type for function prototypes. |
as an opaque type for function prototypes. |
.Pp |
.Pp |
When this header is included, the same file should not include |
When this header is included, the same file should not include |
.Pa out.h , |
.Qq Pa out.h , |
.Pa term.h , |
.Qq Pa term.h , |
|
.Qq Pa tab_term.h , |
or |
or |
.Pa html.h . |
.Qq Pa html.h . |
.El |
.El |