Minor correction: we render HTML character references hexadecimal,

[mandoc.git] / mandoc.3

diff --git a/mandoc.3 b/mandoc.3
index 300f2981bb475072a89cb1569e92df621214da5c..6914a76808f7d773ae223963159204d91c0e7fda 100644 (file)
--- a/mandoc.3
+++ b/mandoc.3
@@ -1,7 +1,7 @@
-.\"    $Id: mandoc.3,v 1.10 2011/05/24 21:41:11 kristaps Exp $
+.\"    $Id: mandoc.3,v 1.41 2017/07/04 23:40:01 schwarze Exp $

 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
 .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>

-.\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
+.\" Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org>

 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above
 .\"
 .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above


@@ -15,90 +15,68 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: May 24 2011 $
+.Dd $Mdocdate: July 4 2017 $

 .Dt MANDOC 3
 .Os
 .Sh NAME
 .Nm mandoc ,
 .Dt MANDOC 3
 .Os
 .Sh NAME
 .Nm mandoc ,

-.Nm mandoc_escape ,
-.Nm man_meta ,
-.Nm man_node ,
-.Nm mchars_alloc ,
-.Nm mchars_free ,
-.Nm mchars_num2char ,
-.Nm mchars_num2uc ,
-.Nm mchars_spec2cp ,
-.Nm mchars_spec2str ,
-.Nm mdoc_meta ,
-.Nm mdoc_node ,
+.Nm deroff ,
+.Nm mandocmsg ,
+.Nm man_mparse ,
+.Nm man_validate ,
+.Nm mdoc_validate ,

 .Nm mparse_alloc ,
 .Nm mparse_free ,
 .Nm mparse_alloc ,
 .Nm mparse_free ,

+.Nm mparse_getkeep ,
+.Nm mparse_keep ,
+.Nm mparse_open ,

 .Nm mparse_readfd ,
 .Nm mparse_reset ,
 .Nm mparse_result ,
 .Nm mparse_strerror ,
 .Nm mparse_readfd ,
 .Nm mparse_reset ,
 .Nm mparse_result ,
 .Nm mparse_strerror ,

-.Nm mparse_strlevel
+.Nm mparse_strlevel ,
+.Nm mparse_updaterc

 .Nd mandoc macro compiler library
 .Nd mandoc macro compiler library

-.Sh LIBRARY
-.Lb mandoc

 .Sh SYNOPSIS
 .Sh SYNOPSIS

-.In man.h
-.In mdoc.h
+.In sys/types.h

 .In mandoc.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"
-.Fc
-.Ft "const struct man_node *"
-.Fo man_node
-.Fa "const struct man *man"
+.Pp
+.Fd "#define ASCII_NBRSP"
+.Fd "#define ASCII_HYPH"
+.Fd "#define ASCII_BREAK"
+.Ft struct mparse *
+.Fo mparse_alloc
+.Fa "int options"
+.Fa "enum mandocerr mmin"
+.Fa "mandocmsg mmsg"
+.Fa "enum mandoc_os oe_e"
+.Fa "char *os_s"

 .Fc
 .Fc

-.Ft "struct mchars *"
-.Fn mchars_alloc

 .Ft void
 .Ft void

-.Fn mchars_free "struct mchars *p"
-.Ft char
-.Fn mchars_num2char "const char *cp" "size_t sz"
-.Ft int
-.Fn mchars_num2uc "const char *cp" "size_t sz"
-.Ft "const char *"
-.Fo mchars_spec2str
-.Fa "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 char *cp"
-.Fa "size_t sz"
-.Ft "const char *"
+.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
 .Fc

-.Ft "const struct mdoc_meta *"
-.Fo mdoc_meta
-.Fa "const struct mdoc *mdoc"
+.Ft void
+.Fo mparse_free
+.Fa "struct mparse *parse"

 .Fc
 .Fc

-.Ft "const struct mdoc_node *"
-.Fo mdoc_node
-.Fa "const struct mdoc *mdoc"
+.Ft const char *
+.Fo mparse_getkeep
+.Fa "const struct mparse *parse"

 .Fc
 .Ft void
 .Fc
 .Ft void

-.Fo mparse_alloc
-.Fa "enum mparset type"
-.Fa "enum mandoclevel wlevel"
-.Fa "mandocmsg msg"
-.Fa "void *msgarg"
+.Fo mparse_keep
+.Fa "struct mparse *parse"

 .Fc
 .Fc

-.Ft void
-.Fo mparse_free
+.Ft int
+.Fo mparse_open

 .Fa "struct mparse *parse"
 .Fa "struct mparse *parse"

+.Fa "const char *fname"

 .Fc
 .Ft "enum mandoclevel"
 .Fo mparse_readfd
 .Fc
 .Ft "enum mandoclevel"
 .Fo mparse_readfd


@@ -113,8 +91,8 @@
 .Ft void
 .Fo mparse_result
 .Fa "struct mparse *parse"
 .Ft void
 .Fo mparse_result
 .Fa "struct mparse *parse"

-.Fa "struct mdoc **mdoc"
-.Fa "struct man **man"
+.Fa "struct roff_man **man"
+.Fa "char **sodest"

 .Fc
 .Ft "const char *"
 .Fo mparse_strerror
 .Fc
 .Ft "const char *"
 .Fo mparse_strerror


@@ -124,11 +102,38 @@
 .Fo mparse_strlevel
 .Fa "enum mandoclevel"
 .Fc
 .Fo mparse_strlevel
 .Fa "enum mandoclevel"
 .Fc

-.Vt extern const char * const * man_macronames;
+.Ft void
+.Fo mparse_updaterc
+.Fa "struct mparse *parse"
+.Fa "enum mandoclevel *rc"
+.Fc
+.In roff.h
+.Ft void
+.Fo deroff
+.Fa "char **dest"
+.Fa "const struct roff_node *node"
+.Fc
+.In sys/types.h
+.In mandoc.h
+.In mdoc.h

 .Vt extern const char * const * mdoc_argnames;
 .Vt extern const char * const * mdoc_macronames;
 .Vt extern const char * const * mdoc_argnames;
 .Vt extern const char * const * mdoc_macronames;

-.Fd "#define ASCII_NBRSP"
-.Fd "#define ASCII_HYPH"
+.Ft void
+.Fo mdoc_validate
+.Fa "struct roff_man *mdoc"
+.Fc
+.In sys/types.h
+.In mandoc.h
+.In man.h
+.Vt extern const char * const * man_macronames;
+.Ft "const struct mparse *"
+.Fo man_mparse
+.Fa "const struct roff_man *man"
+.Fc
+.Ft void
+.Fo man_validate
+.Fa "struct roff_man *man"
+.Fc

 .Sh DESCRIPTION
 The
 .Nm mandoc
 .Sh DESCRIPTION
 The
 .Nm mandoc


@@ -151,168 +156,321 @@ The following describes a general parse sequence:
 .Bl -enum
 .It
 initiate a parsing sequence with
 .Bl -enum
 .It
 initiate a parsing sequence with

+.Xr mchars_alloc 3
+and

 .Fn mparse_alloc ;
 .It
 .Fn mparse_alloc ;
 .It

-parse files or file descriptors with
+open a file with
+.Xr open 2
+or
+.Fn mparse_open ;
+.It
+parse it with

 .Fn mparse_readfd ;
 .It
 .Fn mparse_readfd ;
 .It

-retrieve a parsed syntax tree, if the parse was successful, with
+close it with
+.Xr close 2 ;
+.It
+retrieve the syntax tree with

 .Fn mparse_result ;
 .It
 .Fn mparse_result ;
 .It

-iterate over parse nodes with
-.Fn mdoc_node
+depending on whether the
+.Fa macroset
+member of the returned
+.Vt struct roff_man
+is
+.Dv MACROSET_MDOC
+or
+.Dv MACROSET_MAN ,
+validate it with
+.Fn mdoc_validate

 or
 or

-.Fn man_node ;
+.Fn man_validate ,
+respectively;
+.It
+if information about the validity of the input is needed, fetch it with
+.Fn mparse_updaterc ;
+.It
+iterate over parse nodes with starting from the
+.Fa first
+member of the returned
+.Vt struct roff_man ;

 .It
 free all allocated memory with
 .It
 free all allocated memory with

-.Fn mparse_free ,
+.Fn mparse_free
+and
+.Xr mchars_free 3 ,

 or invoke
 .Fn mparse_reset
 or invoke
 .Fn mparse_reset

-and parse new files.
+and go back to step 2 to parse new files.

 .El
 .El

-.Pp
-The
-.Nm
-library also contains routines for translating character strings into glyphs
-.Pq see Fn mchars_alloc
-and parsing escape sequences from strings
-.Pq see Fn mandoc_escape .
-.Pp
-This library is
-.Ud

 .Sh REFERENCE
 This section documents the functions, types, and variables available
 via
 .Sh REFERENCE
 This section documents the functions, types, and variables available
 via

-.In mandoc.h .
+.In mandoc.h ,
+with the exception of those documented in
+.Xr mandoc_escape 3
+and
+.Xr mchars_alloc 3 .

 .Ss Types
 .Bl -ohang
 .Ss Types
 .Bl -ohang

-.It Vt "enum mandoc_esc"

 .It Vt "enum mandocerr"
 .It Vt "enum mandocerr"

+An error or warning message during parsing.

 .It Vt "enum mandoclevel"
 .It Vt "enum mandoclevel"

-.It Vt "struct mchars"
-An opaque pointer to an object allowing for translation between
-character strings and glyphs.
-See
-.Fn mchars_alloc .
-.It Vt "enum mparset"
+A classification of an
+.Vt "enum mandocerr"
+as regards system operation.
+See the DIAGNOSTICS section in
+.Xr mandoc 1
+regarding the meanings of the levels.

 .It Vt "struct mparse"
 .It Vt "struct mparse"

+An opaque pointer to a running parse sequence.
+Created with
+.Fn mparse_alloc
+and freed with
+.Fn mparse_free .
+This may be used across parsed input if
+.Fn mparse_reset
+is called between parses.

 .It Vt "mandocmsg"
 .It Vt "mandocmsg"

+A prototype for a function to handle error and warning
+messages emitted by the parser.

 .El
 .Ss Functions
 .Bl -ohang
 .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
+.It Fn deroff
+Obtain a text-only representation of a
+.Vt struct roff_node ,
+including text contained in its child nodes.
+To be used on children of the
+.Fa first
+member of
+.Vt struct roff_man .
+When it is no longer needed, the pointer returned from
+.Fn deroff
+can be passed to
+.Xr free 3 .
+.It Fn man_mparse
+Get the parser used for the current output.
+Declared in
+.In man.h ,
+implemented in
+.Pa man.c .
+.It Fn man_validate
+Validate the
+.Dv MACROSET_MAN
+parse tree obtained with

 .Fn mparse_result .
 .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 mchars_alloc
-Allocate an
-.Vt "struct mchars *"
-object for translating special characters into glyphs.
-See
-.Xr mandoc_char 7
-for an overview of special characters.
-The object must be freed with
-.Fn mchars_free .
-.It Fn mchars_free
-Free an object created with
-.Fn mchars_alloc .
-.It Fn mchars_num2char
-Convert a character index (e.g., the \eN\(aq\(aq escape) into a
-printable ASCII character.
-Returns \e0 (the nil character) if the input sequence is malformed.
-.It Fn mchars_num2uc
-Convert a hexadecimal character index (e.g., the \e[uNNNN] escape) into
-a Unicode codepoint.
-Returns \e0 (the nil character) if the input sequence is malformed.
-.It Fn mchars_spec2cp
-Convert a special character into a valid Unicode codepoint.
-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.
-.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
+Declared in
+.In man.h ,
+implemented in
+.Pa man.c .
+.It Fn mdoc_validate
+Validate the
+.Dv MACROSET_MDOC
+parse tree obtained with

 .Fn mparse_result .
 .Fn mparse_result .

+Declared in
+.In mdoc.h ,
+implemented in
+.Pa mdoc.c .

 .It Fn mparse_alloc
 Allocate a parser.
 .It Fn mparse_alloc
 Allocate a parser.

+The arguments have the following effect:
+.Bl -tag -offset 5n -width inttype
+.It Ar options
+When the
+.Dv MPARSE_MDOC
+or
+.Dv MPARSE_MAN
+bit is set, only that parser is used.
+Otherwise, the document type is automatically detected.
+.Pp
+When the
+.Dv MPARSE_SO
+bit is set,
+.Xr roff 7
+.Ic \&so
+file inclusion requests are always honoured.
+Otherwise, if the request is the only content in an input file,
+only the file name is remembered, to be returned in the
+.Fa sodest
+argument of
+.Fn mparse_result .
+.Pp
+When the
+.Dv MPARSE_QUICK
+bit is set, parsing is aborted after the NAME section.
+This is for example useful in
+.Xr makewhatis 8
+.Fl Q
+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
+Operating system to check base system conventions for.
+If
+.Dv MANDOC_OS_OTHER ,
+the system is automatically detected from
+.Ic \&Os ,
+.Fl Ios ,
+or
+.Xr uname 3 .
+.It Ar os_s
+A default string for the
+.Xr mdoc 7
+.Ic \&Os
+macro, overriding the
+.Dv OSNAME
+preprocessor definition and the results of
+.Xr uname 3 .
+Passing
+.Dv NULL
+sets no default.
+.El
+.Pp

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

+Declared in
+.In mandoc.h ,
+implemented in
+.Pa read.c .

 .It Fn mparse_free
 Free all memory allocated by
 .Fn mparse_alloc .
 .It Fn mparse_free
 Free all memory allocated by
 .Fn mparse_alloc .

+Declared in
+.In mandoc.h ,
+implemented in
+.Pa read.c .
+.It Fn mparse_getkeep
+Acquire the keep buffer.
+Must follow a call of
+.Fn mparse_keep .
+Declared in
+.In mandoc.h ,
+implemented in
+.Pa read.c .
+.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.
+Declared in
+.In mandoc.h ,
+implemented in
+.Pa read.c .
+.It Fn mparse_open
+Open the file for reading.
+If that fails and
+.Fa fname
+does not already end in
+.Ql .gz ,
+try again after appending
+.Ql .gz .
+Save the information whether the file is zipped or not.
+Return a file descriptor open for reading or -1 on failure.
+It can be passed to
+.Fn mparse_readfd
+or used directly.
+Declared in
+.In mandoc.h ,
+implemented in
+.Pa read.c .

 .It Fn mparse_readfd
 .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,
+Parse a file descriptor opened with
+.Xr open 2
+or
+.Fn mparse_open .
+Pass the associated filename in
+.Va fname .
+This function may be called multiple times with different parameters; however,
+.Xr close 2
+and

 .Fn mparse_reset
 should be invoked between parses.
 .Fn mparse_reset
 should be invoked between parses.

+Declared in
+.In mandoc.h ,
+implemented in
+.Pa read.c .

 .It Fn mparse_reset
 Reset a parser so that
 .Fn mparse_readfd
 may be used again.
 .It Fn mparse_reset
 Reset a parser so that
 .Fn mparse_readfd
 may be used again.

+Declared in
+.In mandoc.h ,
+implemented in
+.Pa read.c .

 .It Fn mparse_result
 Obtain the result of a parse.
 .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.
+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.
 .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.
 .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
+.In mandoc.h ,
+implemented in
+.Pa read.c .

 .El
 .Ss Variables
 .Bl -ohang
 .It Va man_macronames
 .El
 .Ss Variables
 .Bl -ohang
 .It Va man_macronames

-The string representation of a man macro as indexed by
+The string representation of a
+.Xr man 7
+macro as indexed by

 .Vt "enum mant" .
 .It Va mdoc_argnames
 .Vt "enum mant" .
 .It Va mdoc_argnames

-The string representation of a mdoc macro argument as indexed by
+The string representation of an
+.Xr mdoc 7
+macro argument as indexed by

 .Vt "enum mdocargt" .
 .It Va mdoc_macronames
 .Vt "enum mdocargt" .
 .It Va mdoc_macronames

-The string representation of a mdoc macro as indexed by
+The string representation of an
+.Xr mdoc 7
+macro as indexed by

 .Vt "enum mdoct" .
 .El
 .Sh IMPLEMENTATION NOTES
 .Vt "enum mdoct" .
 .El
 .Sh IMPLEMENTATION NOTES


@@ -320,22 +478,51 @@ This section consists of structural documentation for
 .Xr mdoc 7
 and
 .Xr man 7
 .Xr mdoc 7
 and
 .Xr man 7

-syntax trees.
+syntax trees and strings.
+.Ss Man and Mdoc Strings
+Strings may be extracted from mdoc and man meta-data, or from text
+nodes (MDOC_TEXT and MAN_TEXT, respectively).
+These strings have special non-printing formatting cues embedded in the
+text itself, as well as
+.Xr roff 7
+escapes preserved from input.
+Implementing systems will need to handle both situations to produce
+human-readable text.
+In general, strings may be assumed to consist of 7-bit ASCII characters.
+.Pp
+The following non-printing characters may be embedded in text strings:
+.Bl -tag -width Ds
+.It Dv ASCII_NBRSP
+A non-breaking space character.
+.It Dv ASCII_HYPH
+A soft hyphen.
+.It Dv ASCII_BREAK
+A breakable zero-width space.
+.El
+.Pp
+Escape characters are also passed verbatim into text strings.
+An escape character is a sequence of characters beginning with the
+backslash
+.Pq Sq \e .
+To construct human-readable text, these should be intercepted with
+.Xr mandoc_escape 3
+and converted with one the functions described in
+.Xr mchars_alloc 3 .

 .Ss Man Abstract Syntax Tree
 This AST is governed by the ontological rules dictated in
 .Xr man 7
 and derives its terminology accordingly.
 .Pp
 The AST is composed of
 .Ss Man Abstract Syntax Tree
 This AST is governed by the ontological rules dictated in
 .Xr man 7
 and derives its terminology accordingly.
 .Pp
 The AST is composed of

-.Vt struct man_node
+.Vt struct roff_node

 nodes with element, root and text types as declared by the
 .Va type
 field.
 Each node also provides its parse point (the
 .Va line ,
 nodes with element, root and text types as declared by the
 .Va type
 field.
 Each node also provides its parse point (the
 .Va line ,

-.Va sec ,
+.Va pos ,

 and
 and

-.Va pos
+.Va sec

 fields), its position in the tree (the
 .Va parent ,
 .Va child ,
 fields), its position in the tree (the
 .Va parent ,
 .Va child ,


@@ -361,11 +548,11 @@ where capitalised non-terminals represent nodes.
 .It ELEMENT
 \(<- ELEMENT | TEXT*
 .It TEXT
 .It ELEMENT
 \(<- ELEMENT | TEXT*
 .It TEXT

-\(<- [[:alpha:]]*
+\(<- [[:ascii:]]*

 .El
 .Pp
 The only elements capable of nesting other elements are those with
 .El
 .Pp
 The only elements capable of nesting other elements are those with

-next-lint scope as documented in
+next-line scope as documented in

 .Xr man 7 .
 .Ss Mdoc Abstract Syntax Tree
 This AST is governed by the ontological
 .Xr man 7 .
 .Ss Mdoc Abstract Syntax Tree
 This AST is governed by the ontological


@@ -379,20 +566,20 @@ are described simply as
 .Qq elements .
 .Pp
 The AST is composed of
 .Qq elements .
 .Pp
 The AST is composed of

-.Vt struct mdoc_node
+.Vt struct roff_node

 nodes with block, head, body, element, root and text types as declared
 by the
 .Va type
 field.
 Each node also provides its parse point (the
 .Va line ,
 nodes with block, head, body, element, root and text types as declared
 by the
 .Va type
 field.
 Each node also provides its parse point (the
 .Va line ,

-.Va sec ,
+.Va pos ,

 and
 and

-.Va pos
+.Va sec

 fields), its position in the tree (the
 .Va parent ,
 .Va child ,
 fields), its position in the tree (the
 .Va parent ,
 .Va child ,

-.Va nchild ,
+.Va last ,

 .Va next
 and
 .Va prev
 .Va next
 and
 .Va prev


@@ -420,7 +607,7 @@ where capitalised non-terminals represent nodes.
 .It TAIL
 \(<- mnode*
 .It TEXT
 .It TAIL
 \(<- mnode*
 .It TEXT

-\(<- [[:printable:],0x1e]*
+\(<- [[:ascii:]]*

 .El
 .Pp
 Of note are the TEXT nodes following the HEAD, BODY and TAIL nodes of
 .El
 .Pp
 Of note are the TEXT nodes following the HEAD, BODY and TAIL nodes of


@@ -476,10 +663,10 @@ TEXT end
 .Ed
 .Pp
 Here, the formatting of the
 .Ed
 .Pp
 Here, the formatting of the

-.Sq \&Ao
+.Ic \&Ao

 block extends from TEXT ao to TEXT ac,
 while the formatting of the
 block extends from TEXT ao to TEXT ac,
 while the formatting of the

-.Sq \&Bo
+.Ic \&Bo

 block extends from TEXT bo to TEXT bc.
 It renders as follows in
 .Fl T Ns Cm ascii
 block extends from TEXT bo to TEXT bc.
 It renders as follows in
 .Fl T Ns Cm ascii


@@ -495,16 +682,21 @@ Using badly-nested blocks is
 .Em strongly discouraged ;
 for example, the
 .Fl T Ns Cm html
 .Em strongly discouraged ;
 for example, the
 .Fl T Ns Cm html

-and
-.Fl T Ns Cm xhtml
-front-ends to
+front-end to

 .Xr mandoc 1
 .Xr mandoc 1

-are unable to render them in any meaningful way.
+is unable to render them in any meaningful way.

 Furthermore, behaviour when encountering badly-nested blocks is not
 Furthermore, behaviour when encountering badly-nested blocks is not

-consistent across troff implementations, especially when using  multiple
+consistent across troff implementations, especially when using multiple

 levels of badly-nested blocks.
 .Sh SEE ALSO
 .Xr mandoc 1 ,
 levels of badly-nested blocks.
 .Sh SEE ALSO
 .Xr mandoc 1 ,

+.Xr man.cgi 3 ,
+.Xr mandoc_escape 3 ,
+.Xr mandoc_headers 3 ,
+.Xr mandoc_malloc 3 ,
+.Xr mansearch 3 ,
+.Xr mchars_alloc 3 ,
+.Xr tbl 3 ,

 .Xr eqn 7 ,
 .Xr man 7 ,
 .Xr mandoc_char 7 ,
 .Xr eqn 7 ,
 .Xr man 7 ,
 .Xr mandoc_char 7 ,


@@ -512,7 +704,10 @@ levels of badly-nested blocks.
 .Xr roff 7 ,
 .Xr tbl 7
 .Sh AUTHORS
 .Xr roff 7 ,
 .Xr tbl 7
 .Sh AUTHORS

+.An -nosplit

 The
 .Nm
 library was written by
 The
 .Nm
 library was written by

-.An Kristaps Dzonsons Aq kristaps@bsd.lv .
+.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
+and is maintained by
+.An Ingo Schwarze Aq Mt schwarze@openbsd.org .