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

Diff for /mandoc/mandoc.3 between version 1.19 and 1.24

version 1.19, 2013/07/13 19:41:16 version 1.24, 2014/03/23 11:25:26
Line 20 
Line 20 
 .Os  .Os
 .Sh NAME  .Sh NAME
 .Nm mandoc ,  .Nm mandoc ,
   .Nm mandoc_calloc ,
 .Nm mandoc_escape ,  .Nm mandoc_escape ,
   .Nm mandoc_malloc ,
   .Nm mandoc_realloc ,
   .Nm mandoc_strdup ,
   .Nm mandoc_strndup ,
 .Nm man_meta ,  .Nm man_meta ,
 .Nm man_mparse ,  .Nm man_mparse ,
 .Nm man_node ,  .Nm man_node ,
Line 43 
Line 48 
 .Nm mparse_strlevel  .Nm mparse_strlevel
 .Nd mandoc macro compiler library  .Nd mandoc macro compiler library
 .Sh LIBRARY  .Sh LIBRARY
 .Lb mandoc  .Lb libmandoc
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .In man.h  
 .In mdoc.h  
 .In mandoc.h  .In mandoc.h
   .Fd "#define ASCII_NBRSP"
   .Fd "#define ASCII_HYPH"
   .Fd "#define ASCII_BREAK"
   .Ft "void *"
   .Fo mandoc_calloc
   .Fa "size_t nmemb"
   .Fa "size_t size"
   .Fc
 .Ft "enum mandoc_esc"  .Ft "enum mandoc_esc"
 .Fo mandoc_escape  .Fo mandoc_escape
 .Fa "const char **end"  .Fa "const char **end"
 .Fa "const char **start"  .Fa "const char **start"
 .Fa "int *sz"  .Fa "int *sz"
 .Fc  .Fc
 .Ft "const struct man_meta *"  .Ft "void *"
 .Fo man_meta  .Fn mandoc_malloc "size_t size"
 .Fa "const struct man *man"  
 .Fc  
 .Ft "const struct mparse *"  
 .Fo man_mparse  
 .Fa "const struct man *man"  
 .Fc  
 .Ft "const struct man_node *"  
 .Fo man_node  
 .Fa "const struct man *man"  
 .Fc  
 .Ft "struct mchars *"  .Ft "struct mchars *"
 .Fn mchars_alloc  .Fo mandoc_realloc
   .Fa "void *ptr"
   .Fa "size_t size"
   .Fc
   .Ft "char *"
   .Fn mandoc_strdup
   .Fn mchars_alloc "void"
 .Ft void  .Ft void
 .Fn mchars_free "struct mchars *p"  .Fn mchars_free "struct mchars *p"
 .Ft char  .Ft char
Line 86 
Line 93 
 .Fa "const struct mchars *p"  .Fa "const struct mchars *p"
 .Fa "const char *cp"  .Fa "const char *cp"
 .Fa "size_t sz"  .Fa "size_t sz"
 .Ft "const char *"  
 .Fc  .Fc
 .Ft "const struct mdoc_meta *"  
 .Fo mdoc_meta  
 .Fa "const struct mdoc *mdoc"  
 .Fc  
 .Ft "const struct mdoc_node *"  
 .Fo mdoc_node  
 .Fa "const struct mdoc *mdoc"  
 .Fc  
 .Ft void  .Ft void
 .Fo mparse_alloc  .Fo mparse_alloc
 .Fa "enum mparset type"  .Fa "enum mparset inttype"
 .Fa "enum mandoclevel wlevel"  .Fa "enum mandoclevel wlevel"
 .Fa "mandocmsg msg"  .Fa "mandocmsg mmsg"
 .Fa "void *msgarg"  .Fa "char *defos"
   .Fa "int quick"
 .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
 .Ft void  .Ft const char *
 .Fo mparse_getkeep  .Fo mparse_getkeep
 .Fa "const struct mparse *parse"  .Fa "const struct mparse *parse"
 .Fc  .Fc
Line 139 
Line 147 
 .Fo mparse_strlevel  .Fo mparse_strlevel
 .Fa "enum mandoclevel"  .Fa "enum mandoclevel"
 .Fc  .Fc
 .Vt extern const char * const * man_macronames;  .In mandoc.h
   .In mdoc.h
   .Ft "const struct mdoc_meta *"
   .Fo mdoc_meta
   .Fa "const struct mdoc *mdoc"
   .Fc
   .Ft "const struct mdoc_node *"
   .Fo mdoc_node
   .Fa "const struct mdoc *mdoc"
   .Fc
 .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;
 .Fd "#define ASCII_NBRSP"  .In mandoc.h
 .Fd "#define ASCII_HYPH"  .In man.h
   .Ft "const struct man_meta *"
   .Fo man_meta
   .Fa "const struct man *man"
   .Fc
   .Ft "const struct mparse *"
   .Fo man_mparse
   .Fa "const struct man *man"
   .Fc
   .Ft "const struct man_node *"
   .Fo man_node
   .Fa "const struct man *man"
   .Fc
   .Vt extern const char * const * man_macronames;
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm mandoc  .Nm mandoc
Line 204  An escape sequence classification.
Line 234  An escape sequence classification.
 A fatal error, error, or warning message during parsing.  A fatal error, error, or warning message during parsing.
 .It Vt "enum mandoclevel"  .It Vt "enum mandoclevel"
 A classification of an  A classification of an
 .Vt "enum mandoclevel"  .Vt "enum mandocerr"
 as regards system operation.  as regards system operation.
 .It Vt "struct mchars"  .It Vt "struct mchars"
 An opaque pointer to an object allowing for translation between  An opaque pointer to an object allowing for translation between
Line 353  implemented in
Line 383  implemented in
 .Pa mdoc.c .  .Pa mdoc.c .
 .It Fn mparse_alloc  .It Fn mparse_alloc
 Allocate a parser.  Allocate a parser.
   The arguments have the following effect:
   .Bl -tag -offset 5n -width inttype
   .It Ar inttype
   When set to
   .Dv MPARSE_MDOC
   or
   .Dv MPARSE_MAN ,
   only that parser will be used.
   With
   .Dv MPARSE_AUTO ,
   the document type will be automatically detected.
   .It Ar wlevel
   Can be set to
   .Dv MANDOCLEVEL_FATAL ,
   .Dv MANDOCLEVEL_ERROR ,
   or
   .Dv MANDOCLEVEL_WARNING .
   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.
   .It Ar defos
   A default string for the
   .Xr mdoc 7
   .Sq \&Os
   macro, overriding the
   .Dv OSNAME
   preprocessor definition and the results of
   .Xr uname 3 .
   .It Ar quick
   When set, parsing is aborted after the NAME section.
   This is for example useful to quickly build minimal databases.
   .El
   .Pp
 The same parser may be used for multiple files so long as  The same parser may be used for multiple files so long as
 .Fn mparse_reset  .Fn mparse_reset
 is called between parses.  is called between parses.

Legend:
Removed from v.1.19  
changed lines
  Added in v.1.24

CVSweb