[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.2 and 1.5

version 1.2, 2014/12/21 14:14:35 version 1.5, 2015/04/02 22:48:17
Line 54  require inclusion of the header where that type is def
Line 54  require inclusion of the header where that type is def
 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 117  and
Line 116  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 ,
   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 ,
Line 141  Provides
Line 162  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 183  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
   Requires
   .Qq Pa roff.h
   for
   .Vt enum roff_type .
   .Pp
 Provides  Provides
 .Vt enum mant ,  .Vt struct man_meta
 .Vt enum man_type ,  
 .Vt struct man_meta ,  
 .Vt struct man_node ,  
 and the functions  and the functions
 .Fn man_*  .Fn man_*
 described in  described in
Line 243  as opaque types for function prototypes.
Line 265  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 274  or
Line 295  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_node.
 and  
 .Vt struct man_node.  
 .Pp  .Pp
 Provides  Provides
 .Vt enum man_next ,  .Vt enum man_next ,
Line 366  from
Line 385  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 406  from
Line 423  from
 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 441  from
Line 457  from
 .Pa chars.c .  .Pa chars.c .
 .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 ,  .Pa term.h
 .Pa manpath.h  
 or  or
 .Pa mansearch.h .  .Pa mansearch.h .
 .It Qq Pa main.h  .It Qq Pa main.h
Line 461  and
Line 476  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 503  and
Line 514  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.2  
changed lines
  Added in v.1.5
CVSweb