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

Diff for /mandoc/mandoc.3 between version 1.31 and 1.34

version 1.31, 2015/01/15 04:26:40 version 1.34, 2016/01/08 02:13:39
Line 37 
Line 37 
 .Nm mparse_result ,  .Nm mparse_result ,
 .Nm mparse_strerror ,  .Nm mparse_strerror ,
 .Nm mparse_strlevel  .Nm mparse_strlevel
 .Nm mparse_wait ,  
 .Nd mandoc macro compiler library  .Nd mandoc macro compiler library
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .In sys/types.h  .In sys/types.h
Line 51 
Line 50 
 .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 106 
Line 104 
 .Fo mparse_strlevel  .Fo mparse_strlevel
 .Fa "enum mandoclevel"  .Fa "enum mandoclevel"
 .Fc  .Fc
 .Ft "enum mandoclevel"  
 .Fo mparse_wait  
 .Fa "struct mparse *parse"  
 .Fc  
 .In sys/types.h  .In sys/types.h
 .In mandoc.h  .In mandoc.h
 .In mdoc.h  .In mdoc.h
Line 183  or
Line 177  or
 parse it with  parse it with
 .Fn mparse_readfd ;  .Fn mparse_readfd ;
 .It  .It
   close it with
   .Xr close 2 ;
   .It
 retrieve the syntax tree with  retrieve the syntax tree with
 .Fn mparse_result ;  .Fn mparse_result ;
 .It  .It
Line 215  An error or warning message during parsing.
Line 212  An error or warning message during parsing.
 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 345  A callback function to handle errors and warnings.
Line 336  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 392  Declared in
Line 380  Declared in
 implemented in  implemented in
 .Pa read.c .  .Pa read.c .
 .It Fn mparse_open  .It Fn mparse_open
 If the  Open the file for reading.
   If that fails and
 .Fa fname  .Fa fname
 ends in  does not already end in
 .Pa .gz ,  .Ql .gz ,
 open with  try again after appending
 .Xr gunzip 1 ;  .Ql .gz .
 otherwise, with  Save the information whether the file is zipped or not.
 .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.
Line 423  or
Line 405  or
 .Fn mparse_open .  .Fn mparse_open .
 Pass the associated filename in  Pass the associated filename in
 .Va fname .  .Va fname .
 Calls  
 .Fn mparse_wait  
 before returning.  
 This function may be called multiple times with different parameters; however,  This function may be called multiple times with different parameters; however,
   .Xr close 2
   and
 .Fn mparse_reset  .Fn mparse_reset
 should be invoked between parses.  should be invoked between parses.
 Declared in  Declared in
Line 456  implemented in
Line 437  implemented in
 .Pa read.c .  .Pa read.c .
 .It Fn mparse_strlevel  .It Fn mparse_strlevel
 Return a statically-allocated string representation of a level code.  Return a statically-allocated string representation of a level code.
 Declared in  
 .In mandoc.h ,  
 implemented in  
 .Pa read.c .  
 .It Fn mparse_wait  
 Bury a  
 .Xr gunzip 1  
 child process that was spawned with  
 .Fn mparse_open .  
 To be called after the parse sequence is complete.  
 Not needed after  
 .Fn mparse_readfd ,  
 but does no harm in that case, either.  
 Returns  
 .Dv MANDOCLEVEL_OK  
 on success and  
 .Dv MANDOCLEVEL_SYSERR  
 on failure, that is, when  
 .Xr wait 2  
 fails, or when  
 .Xr gunzip 1  
 died from a signal or exited with non-zero status.  
 Declared in  Declared in
 .In mandoc.h ,  .In mandoc.h ,
 implemented in  implemented in

Legend:
Removed from v.1.31  
changed lines
  Added in v.1.34

CVSweb