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

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

version 1.42, 2018/08/23 19:33:27 version 1.43, 2018/12/14 01:18:25
Line 21 
Line 21 
 .Sh NAME  .Sh NAME
 .Nm mandoc ,  .Nm mandoc ,
 .Nm deroff ,  .Nm deroff ,
 .Nm mandocmsg ,  
 .Nm man_validate ,  .Nm man_validate ,
 .Nm mdoc_validate ,  .Nm mdoc_validate ,
 .Nm mparse_alloc ,  .Nm mparse_alloc ,
Line 30 
Line 29 
 .Nm mparse_open ,  .Nm mparse_open ,
 .Nm mparse_readfd ,  .Nm mparse_readfd ,
 .Nm mparse_reset ,  .Nm mparse_reset ,
 .Nm mparse_result ,  .Nm mparse_result
 .Nm mparse_strerror ,  
 .Nm mparse_strlevel ,  
 .Nm mparse_updaterc  
 .Nd mandoc macro compiler library  .Nd mandoc macro compiler library
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .In sys/types.h  .In sys/types.h
   .In stdio.h
 .In mandoc.h  .In mandoc.h
 .Pp  .Pp
 .Fd "#define ASCII_NBRSP"  .Fd "#define ASCII_NBRSP"
Line 45 
Line 42 
 .Ft struct mparse *  .Ft struct mparse *
 .Fo mparse_alloc  .Fo mparse_alloc
 .Fa "int options"  .Fa "int options"
 .Fa "enum mandocerr mmin"  
 .Fa "mandocmsg mmsg"  
 .Fa "enum mandoc_os oe_e"  .Fa "enum mandoc_os oe_e"
 .Fa "char *os_s"  .Fa "char *os_s"
 .Fc  .Fc
 .Ft void  .Ft void
 .Fo (*mandocmsg)  
 .Fa "enum mandocerr errtype"  
 .Fa "enum mandoclevel level"  
 .Fa "const char *file"  
 .Fa "int line"  
 .Fa "int col"  
 .Fa "const char *msg"  
 .Fc  
 .Ft void  
 .Fo mparse_free  .Fo mparse_free
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fc  .Fc
Line 72 
Line 58 
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fa "const char *fname"  .Fa "const char *fname"
 .Fc  .Fc
 .Ft "enum mandoclevel"  .Ft void
 .Fo mparse_readfd  .Fo mparse_readfd
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fa "int fd"  .Fa "int fd"
Line 88 
Line 74 
 .Fa "struct roff_man **man"  .Fa "struct roff_man **man"
 .Fa "char **sodest"  .Fa "char **sodest"
 .Fc  .Fc
 .Ft "const char *"  
 .Fo mparse_strerror  
 .Fa "enum mandocerr"  
 .Fc  
 .Ft "const char *"  
 .Fo mparse_strlevel  
 .Fa "enum mandoclevel"  
 .Fc  
 .Ft void  
 .Fo mparse_updaterc  
 .Fa "struct mparse *parse"  
 .Fa "enum mandoclevel *rc"  
 .Fc  
 .In roff.h  .In roff.h
 .Ft void  .Ft void
 .Fo deroff  .Fo deroff
Line 222  and freed with
Line 195  and freed with
 This may be used across parsed input if  This may be used across parsed input if
 .Fn mparse_reset  .Fn mparse_reset
 is called between parses.  is called between parses.
 .It Vt "mandocmsg"  
 A prototype for a function to handle error and warning  
 messages emitted by the parser.  
 .El  .El
 .Ss Functions  .Ss Functions
 .Bl -ohang  .Bl -ohang
Line 289  This is for example useful in
Line 259  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.
 .It Ar mmin  
 Can be set to  
 .Dv MANDOCERR_BASE ,  
 .Dv MANDOCERR_STYLE ,  
 .Dv MANDOCERR_WARNING ,  
 .Dv MANDOCERR_ERROR ,  
 .Dv MANDOCERR_UNSUPP ,  
 or  
 .Dv MANDOCERR_MAX .  
 Messages below the selected level will be suppressed.  
 .It Ar mmsg  
 A callback function to handle errors and warnings.  
 See  
 .Pa main.c  
 for an example.  
 If printing of error messages is not desired,  
 .Dv NULL  
 may be passed.  
 .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 396  implemented in
Line 348  implemented in
 .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.  One of the two pointers will be filled in.
 Declared in  
 .In mandoc.h ,  
 implemented in  
 .Pa read.c .  
 .It Fn mparse_strerror  
 Return a statically-allocated string representation of an error code.  
 Declared in  
 .In mandoc.h ,  
 implemented in  
 .Pa read.c .  
 .It Fn mparse_strlevel  
 Return a statically-allocated string representation of a level code.  
 Declared in  
 .In mandoc.h ,  
 implemented in  
 .Pa read.c .  
 .It Fn mparse_updaterc  
 If the highest warning or error level that occurred during the current  
 .Fa parse  
 is higher than  
 .Pf * Fa rc ,  
 update  
 .Pf * Fa rc  
 accordingly.  
 This is useful after calling  
 .Fn mdoc_validate  
 or  
 .Fn man_validate .  
 Declared in  Declared in
 .In mandoc.h ,  .In mandoc.h ,
 implemented in  implemented in

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

CVSweb