mandoc/mandoc.3 - diff

Return to mandoc.3 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.3 between version 1.11 and 1.17

version 1.11, 2011/06/22 22:10:02

version 1.17, 2012/01/13 15:27:14

Line 22

.Nm mandoc ,

.Nm mandoc_escape ,

.Nm man_meta ,

.Nm man_mparse ,

.Nm man_node ,

.Nm mchars_alloc ,

.Nm mchars_free ,

Line 33

Line 34

.Nm mdoc_node ,

.Nm mparse_alloc ,

.Nm mparse_free ,

.Nm mparse_getkeep ,

.Nm mparse_keep ,

.Nm mparse_readfd ,

.Nm mparse_reset ,

.Nm mparse_result ,

Line 47

Line 50

.In mandoc.h

.Ft "enum mandoc_esc"

.Fo mandoc_escape

.Fa "const char **in"

.Fa "const char **end"

.Fa "const char **seq"

.Fa "const char **start"

.Fa "int *len"

.Fa "int *sz"

.Fc

.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"

Line 69

Line 76

.Fn mchars_num2uc "const char *cp" "size_t sz"

.Ft "const char *"

.Fo mchars_spec2str

.Fa "struct mchars *p"

.Fa "const struct mchars *p"

.Fa "const char *cp"

.Fa "size_t sz"

.Fa "size_t *rsz"

.Fc

.Ft int

.Fo mchars_spec2cp

.Fa "struct mchars *p"

.Fa "const struct mchars *p"

.Fa "const char *cp"

.Fa "size_t sz"

.Ft "const char *"

Line 100

Line 107

.Fo mparse_free

.Fa "struct mparse *parse"

.Fc

.Ft void

.Fo mparse_getkeep

.Fa "const struct mparse *parse"

.Fc

.Ft void

.Fo mparse_keep

.Fa "struct mparse *parse"

.Fc

.Ft "enum mandoclevel"

.Fo mparse_readfd

.Fa "struct mparse *parse"

Line 199 See

Line 214 See

.It Vt "enum mparset"

The type of parser when reading input.

This should usually be

.Va MPARSE_AUTO

.Dv MPARSE_AUTO

for auto-detection.

.It Vt "struct mparse"

An opaque pointer to a running parse sequence.

Line 219 messages emitted by the parser.

Line 234 messages emitted by the parser.

.It Fn mandoc_escape

Scan an escape sequence, i.e., a character string beginning with

.Sq \e .

Pass a pointer to this string as

Pass a pointer to the character after the

.Sq \e

.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

returning

.Dv ESCAPE_ERROR ,

in which case the string is bogus and should be

thrown away.

If not ESCAPE_ERROR or ESCAPE_IGNORE,

If not

.Dv ESCAPE_ERROR

.Dv ESCAPE_IGNORE ,

.Va start

is set to the first relevant character of the substring (font, glyph,

whatever) of length

Line 233 Both

Line 255 Both

.Va start

and

.Va sz

may be NULL.

may be

.Dv 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_mparse

Get the parser used for the current output.

.It Fn man_node

Obtain the root node of a successful parse.

This may only be used on a pointer returned by

Line 267 Convert a special character into a valid Unicode codep

Line 292 Convert a special character into a valid Unicode codep

Returns \-1 on failure or a non-zero Unicode codepoint on success.

.It Fn mchars_spec2str

Convert a special character into an ASCII string.

Returns NULL on failure.

Returns

.Dv NULL

on failure.

.It Fn mdoc_meta

Obtain the meta-data of a successful parse.

This may only be used on a pointer returned by

Line 286 must be called to free the memory allocated by this fu

Line 313 must be called to free the memory allocated by this fu

.It Fn mparse_free

Free all memory allocated by

.Fn mparse_alloc .

.It Fn mparse_getkeep

Acquire the keep buffer.

Must follow a call of

.Fn mparse_keep .

.It Fn mparse_keep

Instruct the parser to retain a copy of its parsed input.

This can be acquired with subsequent

.Fn mparse_getkeep

calls.

.It Fn mparse_readfd

Parse a file or file descriptor.

Line 560 levels of badly-nested blocks.

Line 596 levels of badly-nested blocks.

The

.Nm

library was written by

.An Kristaps Dzonsons Aq kristaps@bsd.lv .

.An Kristaps Dzonsons ,

.Mt kristaps@bsd.lv .

CVSweb