Remove the pod2man table entries. They can now be properly read and

[mandoc.git] / man.3

diff --git a/man.3 b/man.3
index 552be651fa0e600bf379f6cc41b52a6807677a8a..3bc67ad9543024b0d0d7e25809bba28664052e9f 100644 (file)
--- a/man.3
+++ b/man.3
@@ -1,4 +1,4 @@
-.\"    $Id: man.3,v 1.13 2010/03/27 10:04:56 kristaps Exp $
+.\"    $Id: man.3,v 1.24 2010/08/20 01:02:07 schwarze Exp $

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


@@ -14,51 +14,51 @@
 .\" 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: March 27 2010 $
+.Dd $Mdocdate: August 20 2010 $

 .Dt MAN 3
 .Os
 .Dt MAN 3
 .Os

-.
-.

 .Sh NAME
 .Nm man ,
 .Nm man_alloc ,
 .Sh NAME
 .Nm man ,
 .Nm man_alloc ,

-.Nm man_parseln ,

 .Nm man_endparse ,
 .Nm man_endparse ,

-.Nm man_node ,
-.Nm man_meta ,

 .Nm man_free ,
 .Nm man_free ,

+.Nm man_meta ,
+.Nm man_node ,
+.Nm man_parseln ,

 .Nm man_reset
 .Nd man macro compiler library
 .Nm man_reset
 .Nd man macro compiler library

-.
-.

 .Sh SYNOPSIS
 .Sh SYNOPSIS

+.In mandoc.h

 .In man.h
 .Vt extern const char * const * man_macronames;
 .Ft "struct man *"
 .In man.h
 .Vt extern const char * const * man_macronames;
 .Ft "struct man *"

-.Fn man_alloc "void *data" "int pflags" "const struct man_cb *cb"
-.Ft void
-.Fn man_reset "struct man *man"
+.Fo man_alloc
+.Fa "struct regset *regs"
+.Fa "void *data"
+.Fa "mandocmsg msgs"
+.Fc
+.Ft int
+.Fn man_endparse "struct man *man"

 .Ft void
 .Fn man_free "struct man *man"
 .Ft void
 .Fn man_free "struct man *man"

-.Ft int
-.Fn man_parseln "struct man *man" "int line" "char *buf"
-.Ft "const struct man_node *"
-.Fn man_node "const struct man *man"

 .Ft "const struct man_meta *"
 .Fn man_meta "const struct man *man"
 .Ft "const struct man_meta *"
 .Fn man_meta "const struct man *man"

+.Ft "const struct man_node *"
+.Fn man_node "const struct man *man"

 .Ft int
 .Ft int

-.Fn man_endparse "struct man *man"
-.
-.
+.Fo man_parseln
+.Fa "struct man *man"
+.Fa "int line"
+.Fa "char *buf"
+.Fc
+.Ft void
+.Fn man_reset "struct man *man"

 .Sh DESCRIPTION
 The
 .Nm
 library parses lines of
 .Xr man 7
 .Sh DESCRIPTION
 The
 .Nm
 library parses lines of
 .Xr man 7

-input (and
-.Em only
-man) into an abstract syntax tree (AST).
-.
+input into an abstract syntax tree (AST).

 .Pp
 In general, applications initiate a parsing sequence with
 .Fn man_alloc ,
 .Pp
 In general, applications initiate a parsing sequence with
 .Fn man_alloc ,


@@ -75,50 +75,30 @@ then free all allocated memory with
 The
 .Fn man_reset
 function may be used in order to reset the parser for another input
 The
 .Fn man_reset
 function may be used in order to reset the parser for another input

-sequence.  See the
+sequence.
+See the

 .Sx EXAMPLES
 section for a full example.
 .Sx EXAMPLES
 section for a full example.

-.

 .Pp
 Beyond the full set of macros defined in
 .Xr man 7 ,
 the
 .Nm
 library also accepts the following macros:
 .Pp
 Beyond the full set of macros defined in
 .Xr man 7 ,
 the
 .Nm
 library also accepts the following macros:

-.

 .Pp
 .Bl -tag -width Ds -compact
 .Pp
 .Bl -tag -width Ds -compact

-.It am
-.It ami
-.It de
-.It dei
-.It ig
-Instructional macros in the original roff language.  Blocks begun by
-these macros end with
-.Sq ..
-and may begin anywhere, although they may not break the next-line
-scoping rules specified in
-.Xr man 7 .
-These blocks are discarded.
-.

 .It PD
 Has no effect.  Handled as a current-scope line macro.
 .It PD
 Has no effect.  Handled as a current-scope line macro.

-.

 .It Sp
 A synonym for
 .Sq sp 0.5v
 .Pq part of the standard preamble for Perl documentation .
 Handled as a line macro.
 .It Sp
 A synonym for
 .Sq sp 0.5v
 .Pq part of the standard preamble for Perl documentation .
 Handled as a line macro.

-.
-.It UC
-Has no effect.  Handled as a current-scope line macro.
-.

 .It Vb
 A synonym for
 .Sq nf
 .Pq part of the standard preamble for Perl documentation .
 Handled as a current-scope line macro.
 .It Vb
 A synonym for
 .Sq nf
 .Pq part of the standard preamble for Perl documentation .
 Handled as a current-scope line macro.

-.

 .It Ve
 A synonym for
 .Sq fi ,
 .It Ve
 A synonym for
 .Sq fi ,


@@ -127,19 +107,39 @@ closing
 .Pq part of the standard preamble for Perl documentation .
 Handled as a current-scope line macro.
 .El
 .Pq part of the standard preamble for Perl documentation .
 Handled as a current-scope line macro.
 .El

-.
-.
+.Pp
+Furthermore, the following escapes are accepted to allow
+.Xr pod2man 1
+documents to be correctly formatted:
+\e*(-- (dash),
+\e*(PI (pi),
+\e*(L" (left double-quote),
+\e*(R" (right double-quote),
+\e*(C` (left single-quote),
+\e*(C' (right single-quote),
+\e*(Aq (apostrophe),
+\e*^ (hat),
+\e*, (comma),
+\e*~ (tilde),
+\e*/ (forward slash),
+\e*: (umlaut),
+\e*8 (beta),
+\e*o (degree),
+\e*(D- (Eth),
+\e*(d- (eth),
+\e*(Th (Thorn),
+and
+\e*(th (thorn).

 .Sh REFERENCE
 This section further defines the
 .Sx Types ,
 .Sx Functions
 and
 .Sx Variables
 .Sh REFERENCE
 This section further defines the
 .Sx Types ,
 .Sx Functions
 and
 .Sx Variables

-available to programmers.  Following that, the
+available to programmers.
+Following that, the

 .Sx Abstract Syntax Tree
 section documents the output tree.
 .Sx Abstract Syntax Tree
 section documents the output tree.

-.
-.

 .Ss Types
 Both functions (see
 .Sx Functions )
 .Ss Types
 Both functions (see
 .Sx Functions )


@@ -147,94 +147,83 @@ and variables (see
 .Sx Variables )
 may use the following types:
 .Bl -ohang
 .Sx Variables )
 may use the following types:
 .Bl -ohang

-.

 .It Vt struct man
 An opaque type defined in
 .Pa man.c .
 Its values are only used privately within the library.
 .It Vt struct man
 An opaque type defined in
 .Pa man.c .
 Its values are only used privately within the library.

-.
-.It Vt struct man_cb
-A set of message callbacks defined in
-.Pa man.h .
-.
+.It Vt mandocmsg
+A function callback type defined in
+.Pa mandoc.h .

 .It Vt struct man_node
 .It Vt struct man_node

-A parsed node.  Defined in
+A parsed node.
+Defined in

 .Pa man.h .
 See
 .Sx Abstract Syntax Tree
 for details.
 .El
 .Pa man.h .
 See
 .Sx Abstract Syntax Tree
 for details.
 .El

-.
-.

 .Ss Functions
 Function descriptions follow:
 .Bl -ohang
 .Ss Functions
 Function descriptions follow:
 .Bl -ohang

-.

 .It Fn man_alloc
 .It Fn man_alloc

-Allocates a parsing structure.  The
-.Fa data
-pointer is passed to callbacks in
-.Fa cb ,
-which are documented further in the header file.
+Allocates a parsing structure.

 The
 The

-.Fa pflags
-arguments are defined in
-.Pa man.h .
-Returns NULL on failure.  If non-NULL, the pointer must be freed with
+.Fa data
+pointer is passed to
+.Fa msgs .
+Returns NULL on failure.
+If non-NULL, the pointer must be freed with

 .Fn man_free .
 .Fn man_free .

-.

 .It Fn man_reset
 .It Fn man_reset

-Reset the parser for another parse routine.  After its use,
+Reset the parser for another parse routine.
+After its use,

 .Fn man_parseln
 behaves as if invoked for the first time.
 .Fn man_parseln
 behaves as if invoked for the first time.

-.

 .It Fn man_free
 .It Fn man_free

-Free all resources of a parser.  The pointer is no longer valid after
-invocation.
-.
+Free all resources of a parser.
+The pointer is no longer valid after invocation.

 .It Fn man_parseln
 .It Fn man_parseln

-Parse a nil-terminated line of input.  This line should not contain the
-trailing newline.  Returns 0 on failure, 1 on success.  The input buffer
+Parse a nil-terminated line of input.
+This line should not contain the trailing newline.
+Returns 0 on failure, 1 on success.
+The input buffer

 .Fa buf
 is modified by this function.
 .Fa buf
 is modified by this function.

-.

 .It Fn man_endparse
 .It Fn man_endparse

-Signals that the parse is complete.  Note that if
+Signals that the parse is complete.
+Note that if

 .Fn man_endparse
 is called subsequent to
 .Fn man_node ,
 .Fn man_endparse
 is called subsequent to
 .Fn man_node ,

-the resulting tree is incomplete.  Returns 0 on failure, 1 on success.
-.
+the resulting tree is incomplete.
+Returns 0 on failure, 1 on success.

 .It Fn man_node
 .It Fn man_node

-Returns the first node of the parse.  Note that if
+Returns the first node of the parse.
+Note that if

 .Fn man_parseln
 or
 .Fn man_endparse
 return 0, the tree will be incomplete.
 .It Fn man_meta
 .Fn man_parseln
 or
 .Fn man_endparse
 return 0, the tree will be incomplete.
 .It Fn man_meta

-Returns the document's parsed meta-data.  If this information has not
-yet been supplied or
+Returns the document's parsed meta-data.
+If this information has not yet been supplied or

 .Fn man_parseln
 or
 .Fn man_endparse
 return 0, the data will be incomplete.
 .El
 .Fn man_parseln
 or
 .Fn man_endparse
 return 0, the data will be incomplete.
 .El

-.
-.

 .Ss Variables
 The following variables are also defined:
 .Bl -ohang
 .Ss Variables
 The following variables are also defined:
 .Bl -ohang

-.

 .It Va man_macronames
 An array of string-ified token names.
 .El
 .It Va man_macronames
 An array of string-ified token names.
 .El

-.
-.

 .Ss Abstract Syntax Tree
 The
 .Nm
 functions produce an abstract syntax tree (AST) describing input in a
 .Ss Abstract Syntax Tree
 The
 .Nm
 functions produce an abstract syntax tree (AST) describing input in a

-regular form.  It may be reviewed at any time with
+regular form.
+It may be reviewed at any time with

 .Fn man_nodes ;
 however, if called before
 .Fn man_endparse ,
 .Fn man_nodes ;
 however, if called before
 .Fn man_endparse ,


@@ -243,20 +232,17 @@ or after
 or
 .Fn man_parseln
 fail, it may be incomplete.
 or
 .Fn man_parseln
 fail, it may be incomplete.

-.

 .Pp
 .Pp

-This AST is governed by the ontological
-rules dictated in
+This AST is governed by the ontological rules dictated in

 .Xr man 7
 and derives its terminology accordingly.
 .Xr man 7
 and derives its terminology accordingly.

-.

 .Pp
 The AST is composed of
 .Vt struct man_node
 .Pp
 The AST is composed of
 .Vt struct man_node

-nodes with element, root and text types as declared
-by the
+nodes with element, root and text types as declared by the

 .Va type
 .Va type

-field.  Each node also provides its parse point (the
+field.
+Each node also provides its parse point (the

 .Va line ,
 .Va sec ,
 and
 .Va line ,
 .Va sec ,
 and


@@ -268,7 +254,6 @@ fields), its position in the tree (the
 and
 .Va prev
 fields) and some type-specific data.
 and
 .Va prev
 fields) and some type-specific data.

-.

 .Pp
 The tree itself is arranged according to the following normal form,
 where capitalised non-terminals represent nodes.
 .Pp
 The tree itself is arranged according to the following normal form,
 where capitalised non-terminals represent nodes.


@@ -289,27 +274,26 @@ where capitalised non-terminals represent nodes.
 .It TEXT
 \(<- [[:alpha:]]*
 .El
 .It TEXT
 \(<- [[:alpha:]]*
 .El

-.

 .Pp
 The only elements capable of nesting other elements are those with
 next-lint scope as documented in
 .Xr man 7 .
 .Pp
 The only elements capable of nesting other elements are those with
 next-lint scope as documented in
 .Xr man 7 .

-.
-.

 .Sh EXAMPLES
 The following example reads lines from stdin and parses them, operating
 on the finished parse tree with
 .Fn parsed .
 This example does not error-check nor free memory upon failure.
 .Bd -literal -offset indent
 .Sh EXAMPLES
 The following example reads lines from stdin and parses them, operating
 on the finished parse tree with
 .Fn parsed .
 This example does not error-check nor free memory upon failure.
 .Bd -literal -offset indent

+struct regset regs;

 struct man *man;
 struct man_node *node;
 char *buf;
 size_t len;
 int line;
 
 struct man *man;
 struct man_node *node;
 char *buf;
 size_t len;
 int line;
 

+bzero(&regs, sizeof(struct regset));

 line = 1;
 line = 1;

-man = man_alloc(NULL, 0, NULL);
+man = man_alloc(&regs, NULL, NULL);

 buf = NULL;
 alloc_len = 0;
 
 buf = NULL;
 alloc_len = 0;
 


@@ -331,15 +315,15 @@ if (NULL == (node = man_node(man)))
 parsed(man, node);
 man_free(man);
 .Ed
 parsed(man, node);
 man_free(man);
 .Ed

-.
-.
+.Pp
+Please see
+.Pa main.c
+in the source archive for a rigorous reference.

 .Sh SEE ALSO
 .Xr mandoc 1 ,
 .Xr man 7
 .Sh SEE ALSO
 .Xr mandoc 1 ,
 .Xr man 7

-.
-.

 .Sh AUTHORS
 The
 .Nm
 .Sh AUTHORS
 The
 .Nm

-utility was written by
+library was written by

 .An Kristaps Dzonsons Aq kristaps@bsd.lv .
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .