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

Diff for /mandoc/mandoc.3 between version 1.43 and 1.44

version 1.43, 2018/12/14 01:18:25 version 1.44, 2018/12/30 00:49:55
Line 21 
Line 21 
 .Sh NAME  .Sh NAME
 .Nm mandoc ,  .Nm mandoc ,
 .Nm deroff ,  .Nm deroff ,
 .Nm man_validate ,  
 .Nm mdoc_validate ,  
 .Nm mparse_alloc ,  .Nm mparse_alloc ,
 .Nm mparse_copy ,  .Nm mparse_copy ,
 .Nm mparse_free ,  .Nm mparse_free ,
Line 68 
Line 66 
 .Fo mparse_reset  .Fo mparse_reset
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fc  .Fc
 .Ft void  .Ft struct roff_meta *
 .Fo mparse_result  .Fo mparse_result
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fa "struct roff_man **man"  
 .Fa "char **sodest"  
 .Fc  .Fc
 .In roff.h  .In roff.h
 .Ft void  .Ft void
Line 85 
Line 81 
 .In mdoc.h  .In mdoc.h
 .Vt extern const char * const * mdoc_argnames;  .Vt extern const char * const * mdoc_argnames;
 .Vt extern const char * const * mdoc_macronames;  .Vt extern const char * const * mdoc_macronames;
 .Ft void  
 .Fo mdoc_validate  
 .Fa "struct roff_man *mdoc"  
 .Fc  
 .In sys/types.h  .In sys/types.h
 .In mandoc.h  .In mandoc.h
 .In man.h  .In man.h
 .Vt extern const char * const * man_macronames;  .Vt extern const char * const * man_macronames;
 .Ft void  
 .Fo man_validate  
 .Fa "struct roff_man *man"  
 .Fc  
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm mandoc  .Nm mandoc
Line 137  close it with
Line 125  close it with
 retrieve the syntax tree with  retrieve the syntax tree with
 .Fn mparse_result ;  .Fn mparse_result ;
 .It  .It
 depending on whether the  
 .Fa macroset  
 member of the returned  
 .Vt struct roff_man  
 is  
 .Dv MACROSET_MDOC  
 or  
 .Dv MACROSET_MAN ,  
 validate it with  
 .Fn mdoc_validate  
 or  
 .Fn man_validate ,  
 respectively;  
 .It  
 if information about the validity of the input is needed, fetch it with  if information about the validity of the input is needed, fetch it with
 .Fn mparse_updaterc ;  .Fn mparse_updaterc ;
 .It  .It
 iterate over parse nodes with starting from the  iterate over parse nodes with starting from the
 .Fa first  .Fa first
 member of the returned  member of the returned
 .Vt struct roff_man ;  .Vt struct roff_meta ;
 .It  .It
 free all allocated memory with  free all allocated memory with
 .Fn mparse_free  .Fn mparse_free
Line 205  including text contained in its child nodes.
Line 179  including text contained in its child nodes.
 To be used on children of the  To be used on children of the
 .Fa first  .Fa first
 member of  member of
 .Vt struct roff_man .  .Vt struct roff_meta .
 When it is no longer needed, the pointer returned from  When it is no longer needed, the pointer returned from
 .Fn deroff  .Fn deroff
 can be passed to  can be passed to
 .Xr free 3 .  .Xr free 3 .
 .It Fn man_validate  
 Validate the  
 .Dv MACROSET_MAN  
 parse tree obtained with  
 .Fn mparse_result .  
 Declared in  
 .In man.h ,  
 implemented in  
 .Pa man.c .  
 .It Fn mdoc_validate  
 Validate the  
 .Dv MACROSET_MDOC  
 parse tree obtained with  
 .Fn mparse_result .  
 Declared in  
 .In mdoc.h ,  
 implemented in  
 .Pa mdoc.c .  
 .It Fn mparse_alloc  .It Fn mparse_alloc
 Allocate a parser.  Allocate a parser.
 The arguments have the following effect:  The arguments have the following effect:
Line 249  file inclusion requests are always honoured.
Line 205  file inclusion requests are always honoured.
 Otherwise, if the request is the only content in an input file,  Otherwise, if the request is the only content in an input file,
 only the file name is remembered, to be returned in the  only the file name is remembered, to be returned in the
 .Fa sodest  .Fa sodest
 argument of  field of
 .Fn mparse_result .  .Vt struct roff_meta .
 .Pp  .Pp
 When the  When the
 .Dv MPARSE_QUICK  .Dv MPARSE_QUICK
Line 259  This is for example useful in
Line 215  This is for example useful in
 .Xr makewhatis 8  .Xr makewhatis 8
 .Fl Q  .Fl Q
 to quickly build minimal databases.  to quickly build minimal databases.
   .Pp
   When the
   .Dv MARSE_VALIDATE
   bit is set,
   .Fn mparse_result
   runs the validation functions before returning the syntax tree.
   This is almost always required, except in certain debugging scenarios,
   for example to dump unvalidated syntax trees.
 .It Ar os_e  .It Ar os_e
 Operating system to check base system conventions for.  Operating system to check base system conventions for.
 If  If
Line 347  implemented in
Line 311  implemented in
 .Pa read.c .  .Pa read.c .
 .It Fn mparse_result  .It Fn mparse_result
 Obtain the result of a parse.  Obtain the result of a parse.
 One of the two pointers will be filled in.  
 Declared in  Declared in
 .In mandoc.h ,  .In mandoc.h ,
 implemented in  implemented in

Legend:
Removed from v.1.43  
changed lines
  Added in v.1.44

CVSweb