mandoc/mandoc.3 - diff

Return to mandoc.3 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.3 between version 1.2 and 1.4

-version 1.2, 2011/03/28 21:49:42
+version 1.4, 2011/04/19 16:30:00
 Line 20
 Line 20
 Line 20
  .Os
  .Sh NAME
  .Nm mandoc ,
+ .Nm mandoc_escape ,
  .Nm man_meta ,
  .Nm man_node ,
  .Nm mdoc_meta ,
-Line 36
+Line 37
 Line 36
 Line 37
  .In man.h
  .In mdoc.h
  .In mandoc.h
+ .Ft "enum mandoc_esc"
+ .Fo mandoc_escape
+ .Fa "const char **in"
+ .Fa "const char **seq"
+ .Fa "int *len"
+ .Fc
  .Ft "const struct man_meta *"
  .Fo man_meta
  .Fa "const struct man *man"
-Line 90
+Line 97
 Line 90
 Line 97
  .Vt extern const char * const * man_macronames;
  .Vt extern const char * const * mdoc_argnames;
  .Vt extern const char * const * mdoc_macronames;
+ .Fd "#define ASCII_NBRSP"
+ .Fd "#define ASCII_HYPH"
  .Sh DESCRIPTION
  The
  .Nm mandoc
-Line 130  free all allocated memory with
+Line 139  free all allocated memory with
 Line 130  free all allocated memory with
 Line 139  free all allocated memory with
  or invoke
  .Fn mparse_reset
  and parse new files.
+ .El
+ .Sh REFERENCE
+ This section documents the functions, types, and variables available
+ via
+ .In mandoc.h .
+ .Ss Types
+ .Bl -ohang
+ .It Vt "enum mandoc_esc"
+ .It Vt "enum mandocerr"
+ .It Vt "enum mandoclevel"
+ .It Vt "enum mparset"
+ .It Vt "struct mparse"
+ .It Vt "mandocmsg"
+ .El
+ .Ss Functions
+ .Bl -ohang
+ .It Fn mandoc_escape
+ Scan an escape sequence, i.e., a character string beginning with
+ .Sq \e .
+ Pass a pointer to this string as
+ .Va end ;
+ it will be set to the supremum of the parsed escape sequence unless
+ returning ESCAPE_ERROR, in which case the string is bogus and should be
+ thrown away.
+ If not ESCAPE_ERROR or ESCAPE_IGNORE,
+ .Va start
+ is set to the first relevant character of the substring (font, glyph,
+ whatever) of length
+ .Va sz .
+ Both
+ .Va start
+ and
+ .Va sz
+ may be NULL.
+ .It Fn man_meta
+ Obtain the meta-data of a successful parse.
+ This may only be used on a pointer returned by
+ .Fn mparse_result .
+ .It Fn man_node
+ Obtain the root node of a successful parse.
+ This may only be used on a pointer returned by
+ .Fn mparse_result .
+ .It Fn mdoc_meta
+ Obtain the meta-data of a successful parse.
+ This may only be used on a pointer returned by
+ .Fn mparse_result .
+ .It Fn mdoc_node
+ Obtain the root node of a successful parse.
+ This may only be used on a pointer returned by
+ .Fn mparse_result .
+ .It Fn mparse_alloc
+ Allocate a parser.
+ The same parser may be used for multiple files so long as
+ .Fn mparse_reset
+ is called between parses.
+ .Fn mparse_free
+ must be called to free the memory allocated by this function.
+ .It Fn mparse_free
+ Free all memory allocated by
+ .Fn mparse_alloc .
+ .It Fn mparse_readfd
+ Parse a file or file descriptor.
+ If
+ .Va fd
+ is -1,
+ .Va fname
+ is opened for reading.
+ Otherwise,
+ .Va fname
+ is assumed to be the name associated with
+ .Va fd .
+ This may be called multiple times with different parameters; however,
+ .Fn mparse_reset
+ should be invoked between parses.
+ .It Fn mparse_reset
+ Reset a parser so that
+ .Fn mparse_readfd
+ may be used again.
+ .It Fn mparse_result
+ Obtain the result of a parse.
+ Only successful parses
+ .Po
+ i.e., those where
+ .Fn mparse_readfd
+ returned less than MANDOCLEVEL_FATAL
+ .Pc
+ should invoke this function, in which case one of the two pointers will
+ be filled in.
+ .It Fn mparse_strerror
+ Return a statically-allocated string representation of an error code.
+ .It Fn mparse_strlevel
+ Return a statically-allocated string representation of a level code.
+ .El
+ .Ss Variables
+ .Bl -ohang
+ .It Va man_macronames
+ The string representation of a man macro as indexed by
+ .Vt "enum mant" .
+ .It Va mdoc_argnames
+ The string representation of a mdoc macro argument as indexed by
+ .Vt "enum mdocargt" .
+ .It Va mdoc_macronames
+ The string representation of a mdoc macro as indexed by
+ .Vt "enum mdoct" .
  .El
  .Sh IMPLEMENTATION NOTES
  This section consists of structural documentation for

CVSweb