[BACK]Return to mandoc_headers.3 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc_headers.3 between version 1.1 and 1.7

version 1.1, 2014/12/01 08:09:26 version 1.7, 2015/10/13 22:59:54
Line 47  HTML formatters
Line 47  HTML formatters
 search tools  search tools
 .El  .El
 .Pp  .Pp
 Note that mere usage of an opaque type does  Note that mere usage of an opaque struct type does
 .Em not  .Em not
 require inclusion of the header where that type is defined.  require inclusion of the header where that type is defined.
 .Ss Parser interface  .Ss Parser interface
 Each of the following headers can be included without including  Each of the following headers can be included without including
 any other mandoc header.  any other mandoc header.
 These headers should be included before any other mandoc headers.  These headers should be included before any other mandoc headers.
 Afterwards, any other mandoc headers can be included as needed.  
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Qq Pa mandoc_aux.h  .It Qq Pa mandoc_aux.h
 Requires  Requires
Line 99  and the functions
Line 98  and the functions
 described in  described in
 .Xr mandoc 3 .  .Xr mandoc 3 .
 .Pp  .Pp
 Uses the opaque types  Uses the opaque type
 .Vt struct mparse  .Vt struct mparse
 from  from
 .Pa read.c  .Pa read.c
 and  
 .Vt struct mchars  
 from  
 .Pa chars.c  
 for function prototypes.  for function prototypes.
 Uses the types  Uses the types
 .Vt struct mdoc  .Vt struct mdoc
Line 117  and
Line 112  and
 from  from
 .Pa libman.h  .Pa libman.h
 as opaque types for function prototypes.  as opaque types for function prototypes.
   .It Qq Pa roff.h
   Provides
   .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
   .Qq Pa roff.h
   but no other mandoc headers.
   Afterwards, any other mandoc headers can be included as needed.
   .Bl -tag -width Ds
 .It Qq Pa mdoc.h  .It Qq Pa mdoc.h
 Requires  Requires
 .In sys/types.h  .In sys/types.h
 for  for
 .Vt size_t .  .Vt size_t
   and
   .Qq Pa roff.h
   for
   .Vt enum roff_type .
 .Pp  .Pp
 Provides  Provides
 .Vt enum mdoct ,  
 .Vt enum mdocargt ,  .Vt enum mdocargt ,
 .Vt enum mdoc_type ,  
 .Vt enum mdoc_sec ,  
 .Vt enum mdoc_endbody ,  
 .Vt enum mdoc_disp ,  .Vt enum mdoc_disp ,
 .Vt enum mdoc_list ,  .Vt enum mdoc_list ,
 .Vt enum mdoc_auth ,  .Vt enum mdoc_auth ,
 .Vt enum mdoc_font ,  .Vt enum mdoc_font ,
 .Vt struct mdoc_meta ,  
 .Vt struct mdoc_argv ,  .Vt struct mdoc_argv ,
 .Vt struct mdoc_arg ,  .Vt struct mdoc_arg ,
 .Vt struct mdoc_bd ,  .Vt struct mdoc_bd ,
Line 141  Provides
Line 158  Provides
 .Vt struct mdoc_an ,  .Vt struct mdoc_an ,
 .Vt struct mdoc_bf ,  .Vt struct mdoc_bf ,
 .Vt struct mdoc_rs ,  .Vt struct mdoc_rs ,
 .Vt struct mdoc_node ,  
 and the functions  and the functions
 .Fn mdoc_*  .Fn mdoc_*
 described in  described in
Line 163  When this header is included, the same file should not
Line 179  When this header is included, the same file should not
 or  or
 .Pa libroff.h .  .Pa libroff.h .
 .It Qq Pa man.h  .It Qq Pa man.h
 Provides  Requires
 .Vt enum mant ,  .Qq Pa roff.h
 .Vt enum man_type ,  for
 .Vt struct man_meta ,  .Vt enum roff_type .
 .Vt struct man_node ,  .Pp
 and the functions  Provides the functions
 .Fn man_*  .Fn man_*
 described in  described in
 .Xr mandoc 3 .  .Xr mandoc 3 .
Line 204  are included, the same file should not include any for
Line 220  are included, the same file should not include any for
 Requires  Requires
 .In sys/types.h  .In sys/types.h
 for  for
 .Vt size_t .  .Vt size_t ,
   .Qq Pa mandoc.h
   for
   .Vt enum mandocerr ,
   and
   .Qq Pa roff.h
   for
   .Vt struct roff_meta
   and
   .Vt struct roff_node .
 .Pp  .Pp
 Provides  Provides
 .Vt enum rofferr ,  .Vt enum rofferr ,
Line 222  from
Line 247  from
 .Pa roff.c  .Pa roff.c
 for function prototypes.  for function prototypes.
 Uses the types  Uses the types
 .Vt enum mandocerr ,  .Vt struct tbl_span
 .Vt struct tbl_span ,  
 and  and
 .Vt struct eqn  .Vt struct eqn
 from  from
Line 240  as opaque types for function prototypes.
Line 264  as opaque types for function prototypes.
 Requires  Requires
 .Qq Pa mdoc.h  .Qq Pa mdoc.h
 for  for
 .Vt enum mdoct ,  .Vt enum mdoc_*
 .Vt enum mdoc_* ,  
 and  and
 .Vt struct mdoc_* .  .Vt struct mdoc_* .
 .Pp  .Pp
Line 271  or
Line 294  or
 .Pa libroff.h .  .Pa libroff.h .
 .It Qq Pa libman.h  .It Qq Pa libman.h
 Requires  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  .Pp
 Provides  Provides
 .Vt enum man_next ,  .Vt enum man_next ,
Line 363  from
Line 386  from
 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 manpath.h  
 or  
 .Pa mansearch.h .  .Pa mansearch.h .
 .It Qq Pa term.h  .It Qq Pa term.h
 Requires  Requires
Line 386  Provides
Line 407  Provides
 .Vt struct termp ,  .Vt struct termp ,
 and many terminal formatting functions.  and many terminal formatting functions.
 .Pp  .Pp
 Uses the opaque types  Uses the opaque type
 .Vt struct mchars  
 from  
 .Pa chars.c  
 and  
 .Vt struct termp_ps  .Vt struct termp_ps
 from  from
 .Pa term_ps.c .  .Pa term_ps.c .
Line 400  and
Line 417  and
 .Vt struct eqn  .Vt struct eqn
 from  from
 .Pa mandoc.h  .Pa mandoc.h
   and
   .Vt struct roff_meta
   from
   .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 ,  .Pa html.h
 .Pa manpath.h  
 or  or
 .Pa mansearch.h .  .Pa mansearch.h .
 .It Qq Pa html.h  .It Qq Pa html.h
Line 432  Provides
Line 452  Provides
 .Vt struct html ,  .Vt struct html ,
 and many HTML formatting functions.  and many HTML formatting functions.
 .Pp  .Pp
 Uses the opaque type  
 .Vt struct mchars  
 from  
 .Pa chars.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 term.h ,  .Pa term.h
 .Pa manpath.h  
 or  or
 .Pa mansearch.h .  .Pa mansearch.h .
 .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 opaque type  
 .Vt struct mchars  
 from  
 .Pa chars.c .  
 Uses the types  Uses the types
 .Vt struct mdoc  .Vt struct mdoc
 from  from
Line 458  and
Line 468  and
 from  from
 .Pa libman.h  .Pa libman.h
 as opaque types for function prototypes.  as opaque types for function prototypes.
 .It Qq Pa manpath.h  .It Qq Pa manconf.h
 Requires  Requires
 .In sys/types.h  .In sys/types.h
 for  for
 .Vt size_t .  .Vt size_t .
 .Pp  .Pp
 Provides  Provides
 .Vt struct manpaths  .Vt struct manconf ,
   .Vt struct manpaths ,
   .Vt struct manoutput ,
 and the functions  and the functions
 .Fn manpath_manconf ,  .Fn manconf_parse ,
 .Fn manpath_parse ,  .Fn manconf_output ,
 and  and
 .Fn manpath_free .  .Fn manconf_free .
 .Pp  
 When this header is included, the same file should not include  
 .Pa out.h ,  
 .Pa term.h ,  
 or  
 .Pa html.h .  
 .It Qq Pa mansearch.h  .It Qq Pa mansearch.h
 Requires  Requires
 .In sys/types.h  .In sys/types.h
Line 500  and
Line 506  and
 Uses  Uses
 .Vt struct manpaths  .Vt struct manpaths
 from  from
 .Pa manpath.h  .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
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.7
CVSweb