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

Diff for /mandoc/mandoc.3 between version 1.26 and 1.29

version 1.26, 2014/09/03 23:21:47 version 1.29, 2014/11/26 23:42:14
Line 52 
Line 52 
 .Fa "int options"  .Fa "int options"
 .Fa "enum mandoclevel wlevel"  .Fa "enum mandoclevel wlevel"
 .Fa "mandocmsg mmsg"  .Fa "mandocmsg mmsg"
   .Fa "const struct mchars *mchars"
 .Fa "char *defos"  .Fa "char *defos"
 .Fc  .Fc
 .Ft void  .Ft void
Line 80 
Line 81 
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fa "int *fd"  .Fa "int *fd"
 .Fa "const char *fname"  .Fa "const char *fname"
 .Fa "pid_t *child_pid"  
 .Fc  .Fc
 .Ft "enum mandoclevel"  .Ft "enum mandoclevel"
 .Fo mparse_readfd  .Fo mparse_readfd
Line 110 
Line 110 
 .Ft "enum mandoclevel"  .Ft "enum mandoclevel"
 .Fo mparse_wait  .Fo mparse_wait
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fa "pid_t child_pid"  
 .Fc  .Fc
 .In sys/types.h  .In sys/types.h
 .In mandoc.h  .In mandoc.h
Line 173  The following describes a general parse sequence:
Line 172  The following describes a general parse sequence:
 .Bl -enum  .Bl -enum
 .It  .It
 initiate a parsing sequence with  initiate a parsing sequence with
   .Xr mchars_alloc 3
   and
 .Fn mparse_alloc ;  .Fn mparse_alloc ;
 .It  .It
 parse files or file descriptors with  parse files or file descriptors with
Line 187  or
Line 188  or
 .Fn man_node ;  .Fn man_node ;
 .It  .It
 free all allocated memory with  free all allocated memory with
 .Fn mparse_free ,  .Fn mparse_free
   and
   .Xr mchars_free 3 ,
 or invoke  or invoke
 .Fn mparse_reset  .Fn mparse_reset
 and parse new files.  and parse new files.
Line 208  A fatal error, error, or warning message during parsin
Line 211  A fatal error, error, or warning message during parsin
 A classification of an  A classification of an
 .Vt "enum mandocerr"  .Vt "enum mandocerr"
 as regards system operation.  as regards system operation.
   .It Vt "struct mchars"
   An opaque pointer to a a character table.
   Created with
   .Xr mchars_alloc 3
   and freed with
   .Xr mchars_free 3 .
 .It Vt "struct mparse"  .It Vt "struct mparse"
 An opaque pointer to a running parse sequence.  An opaque pointer to a running parse sequence.
 Created with  Created with
Line 332  A callback function to handle errors and warnings.
Line 341  A callback function to handle errors and warnings.
 See  See
 .Pa main.c  .Pa main.c
 for an example.  for an example.
   .It Ar mchars
   An opaque pointer to a a character table obtained from
   .Xr mchars_alloc 3 .
 .It Ar defos  .It Ar defos
 A default string for the  A default string for the
 .Xr mdoc 7  .Xr mdoc 7
Line 384  open with
Line 396  open with
 .Xr gunzip 1 ;  .Xr gunzip 1 ;
 otherwise, with  otherwise, with
 .Xr open 2 .  .Xr open 2 .
   If
   .Xr open 2
   fails, append
   .Pa .gz
   and try with
   .Xr gunzip 1 .
 Return a file descriptor open for reading in  Return a file descriptor open for reading in
 .Fa fd ,  .Fa fd ,
 or -1 on failure.  or -1 on failure.
 It can be passed to  It can be passed to
 .Fn mparse_readfd  .Fn mparse_readfd
 or used directly.  or used directly.
 If applicable, return the  
 .Xr gunzip 1  
 child process ID in  
 .Fa child_pid ,  
 or otherwise 0.  
 If non-zero, it should be passed to  
 .Fn mparse_wait  
 after completing the parse sequence.  
 Declared in  Declared in
 .In mandoc.h ,  .In mandoc.h ,
 implemented in  implemented in
Line 406  implemented in
Line 416  implemented in
 Parse a file or file descriptor.  Parse a file or file descriptor.
 If  If
 .Va fd  .Va fd
 is -1,  is -1, open
 .Va fname  .Va fname
 is opened for reading.  with
   .Fn mparse_open .
 Otherwise,  Otherwise,
 .Va fname  .Va fname
 is assumed to be the name associated with  is assumed to be the name associated with
 .Va fd .  .Va fd .
 This may be called multiple times with different parameters; however,  Calls
   .Fn mparse_wait
   before returning.
   This function may be called multiple times with different parameters; however,
 .Fn mparse_reset  .Fn mparse_reset
 should be invoked between parses.  should be invoked between parses.
 Declared in  Declared in
Line 457  implemented in
Line 471  implemented in
 .It Fn mparse_wait  .It Fn mparse_wait
 Bury a  Bury a
 .Xr gunzip 1  .Xr gunzip 1
 child process  child process that was spawned with
 .Fa child_pid  
 that was spawned with  
 .Fn mparse_open .  .Fn mparse_open .
 To be called after the parse sequence is complete.  To be called after the parse sequence is complete.
   Not needed after
   .Fn mparse_readfd ,
   but does no harm in that case, either.
 Returns  Returns
 .Dv MANDOCLEVEL_OK  .Dv MANDOCLEVEL_OK
 on success and  on success and

Legend:
Removed from v.1.26  
changed lines
  Added in v.1.29

CVSweb