If PATH_INFO contains a complete and correct path to a manual page

[mandoc.git] / mandoc_headers.3

diff --git a/mandoc_headers.3 b/mandoc_headers.3
index 52ac2890094abc1a24ede999c42240baf1fb1fd9..6c30e16491eb85aaa9810a6be346b3b84abcedad 100644 (file)
--- a/mandoc_headers.3
+++ b/mandoc_headers.3
@@ -98,14 +98,10 @@ and the functions
 described in
 .Xr mandoc 3 .
 .Pp
 described in
 .Xr mandoc 3 .
 .Pp

-Uses the opaque types
+Uses the opaque type

 .Vt struct mparse
 from
 .Pa read.c
 .Vt struct mparse
 from
 .Pa read.c

-and
-.Vt struct mchars
-from
-.Pa chars.c

 for function prototypes.
 Uses the types
 .Vt struct mdoc
 for function prototypes.
 Uses the types
 .Vt struct mdoc


@@ -118,7 +114,20 @@ from
 as opaque types for function prototypes.
 .It Qq Pa roff.h
 Provides
 as opaque types for function prototypes.
 .It Qq Pa roff.h
 Provides

-.Vt enum roff_type .
+.Vt enum mdoc_endbody ,
+.Vt enum roff_sec ,
+.Vt enum roff_type ,
+.Vt struct roff_meta ,
+and
+.Vt struct roff_node .
+.Pp
+Uses pointers to the types
+.Vt struct mdoc_arg
+and
+.Vt union mdoc_data
+from
+.Qq Pa mdoc.h
+as opaque struct members.

 .El
 .Pp
 The following two require
 .El
 .Pp
 The following two require


@@ -137,15 +146,11 @@ for
 .Vt enum roff_type .
 .Pp
 Provides
 .Vt enum roff_type .
 .Pp
 Provides

-.Vt enum mdoct ,

 .Vt enum mdocargt ,
 .Vt enum mdocargt ,

-.Vt enum mdoc_sec ,
-.Vt enum mdoc_endbody ,

 .Vt enum mdoc_disp ,
 .Vt enum mdoc_list ,
 .Vt enum mdoc_auth ,
 .Vt enum mdoc_font ,
 .Vt enum mdoc_disp ,
 .Vt enum mdoc_list ,
 .Vt enum mdoc_auth ,
 .Vt enum mdoc_font ,

-.Vt struct mdoc_meta ,

 .Vt struct mdoc_argv ,
 .Vt struct mdoc_arg ,
 .Vt struct mdoc_bd ,
 .Vt struct mdoc_argv ,
 .Vt struct mdoc_arg ,
 .Vt struct mdoc_bd ,


@@ -153,7 +158,6 @@ Provides
 .Vt struct mdoc_an ,
 .Vt struct mdoc_bf ,
 .Vt struct mdoc_rs ,
 .Vt struct mdoc_an ,
 .Vt struct mdoc_bf ,
 .Vt struct mdoc_rs ,

-.Vt struct mdoc_node ,

 and the functions
 .Fn mdoc_*
 described in
 and the functions
 .Fn mdoc_*
 described in


@@ -180,11 +184,7 @@ Requires
 for
 .Vt enum roff_type .
 .Pp
 for
 .Vt enum roff_type .
 .Pp

-Provides
-.Vt enum mant ,
-.Vt struct man_meta ,
-.Vt struct man_node ,
-and the functions
+Provides the functions

 .Fn man_*
 described in
 .Xr mandoc 3 .
 .Fn man_*
 described in
 .Xr mandoc 3 .


@@ -220,11 +220,16 @@ are included, the same file should not include any formatter headers.
 Requires
 .In sys/types.h
 for
 Requires
 .In sys/types.h
 for

-.Vt size_t
-and
+.Vt size_t ,

 .Qq Pa mandoc.h
 for
 .Qq Pa mandoc.h
 for

-.Vt enum mandocerr .
+.Vt enum mandocerr ,
+and
+.Qq Pa roff.h
+for
+.Vt struct roff_meta
+and
+.Vt struct roff_node .

 .Pp
 Provides
 .Vt enum rofferr ,
 .Pp
 Provides
 .Vt enum rofferr ,


@@ -259,8 +264,7 @@ as opaque types for function prototypes.
 Requires
 .Qq Pa mdoc.h
 for
 Requires
 .Qq Pa mdoc.h
 for

-.Vt enum mdoct ,
-.Vt enum mdoc_* ,
+.Vt enum mdoc_*

 and
 .Vt struct mdoc_* .
 .Pp
 and
 .Vt struct mdoc_* .
 .Pp


@@ -290,11 +294,11 @@ or
 .Pa libroff.h .
 .It Qq Pa libman.h
 Requires
 .Pa libroff.h .
 .It Qq Pa libman.h
 Requires

-.Qq Pa man.h
+.Qq Pa roff.h

 for
 for

-.Vt enum mant
+.Vt struct roff_meta

 and
 and

-.Vt struct man_node.
+.Vt struct roff_node .

 .Pp
 Provides
 .Vt enum man_next ,
 .Pp
 Provides
 .Vt enum man_next ,


@@ -403,11 +407,7 @@ Provides
 .Vt struct termp ,
 and many terminal formatting functions.
 .Pp
 .Vt struct termp ,
 and many terminal formatting functions.
 .Pp

-Uses the opaque types
-.Vt struct mchars
-from
-.Pa chars.c
-and
+Uses the opaque type

 .Vt struct termp_ps
 from
 .Pa term_ps.c .
 .Vt struct termp_ps
 from
 .Pa term_ps.c .


@@ -417,6 +417,10 @@ and
 .Vt struct eqn
 from
 .Pa mandoc.h
 .Vt struct eqn
 from
 .Pa mandoc.h

+and
+.Vt struct roff_meta
+from
+.Qq Pa roff.h

 as opaque types for function prototypes.
 .Pp
 When this header is included, the same file should not include
 as opaque types for function prototypes.
 .Pp
 When this header is included, the same file should not include


@@ -448,11 +452,6 @@ Provides
 .Vt struct html ,
 and many HTML formatting functions.
 .Pp
 .Vt struct html ,
 and many HTML formatting functions.
 .Pp

-Uses the opaque type
-.Vt struct mchars
-from
-.Pa chars.c .
-.Pp

 When this header is included, the same file should not include
 .Pa term.h
 or
 When this header is included, the same file should not include
 .Pa term.h
 or


@@ -460,10 +459,6 @@ or
 .It Qq Pa main.h
 Provides the top level steering functions for all formatters.
 .Pp
 .It Qq Pa main.h
 Provides the top level steering functions for all formatters.
 .Pp

-Uses the opaque type
-.Vt struct mchars
-from
-.Pa chars.c .

 Uses the types
 .Vt struct mdoc
 from
 Uses the types
 .Vt struct mdoc
 from