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

Diff for /mandoc/Attic/man.3 between version 1.14 and 1.27

version 1.14, 2010/03/30 19:20:33 version 1.27, 2010/12/17 11:41:45
Line 17 
Line 17 
 .Dd $Mdocdate$  .Dd $Mdocdate$
 .Dt MAN 3  .Dt MAN 3
 .Os  .Os
 .  
 .  
 .Sh NAME  .Sh NAME
 .Nm man ,  .Nm man ,
 .Nm man_alloc ,  .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  .Nm man_reset
 .Nd man macro compiler library  .Nd man macro compiler library
 .  
 .  
 .Sh SYNOPSIS  .Sh SYNOPSIS
   .In mandoc.h
 .In man.h  .In man.h
 .Vt extern const char * const * man_macronames;  .Vt extern const char * const * man_macronames;
 .Ft "struct man *"  .Ft "struct man *"
 .Fn man_alloc "void *data" "int pflags" "const struct man_cb *cb"  .Fo man_alloc
   .Fa "struct regset *regs"
   .Fa "void *data"
   .Fa "mandocmsg msgs"
   .Fc
   .Ft int
   .Fn man_endparse "struct man *man"
 .Ft void  .Ft void
 .Fn man_reset "struct man *man"  
 .Ft void  
 .Fn man_free "struct man *man"  .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 *"  .Ft "const struct man_meta *"
 .Fn man_meta "const struct man *man"  .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  .Sh DESCRIPTION
 The  The
 .Nm  .Nm
 library parses lines of  library parses lines of
 .Xr man 7  .Xr man 7
 input (and  input into an abstract syntax tree (AST).
 .Em only  
 man) into an abstract syntax tree (AST).  
 .  
 .Pp  .Pp
 In general, applications initiate a parsing sequence with  In general, applications initiate a parsing sequence with
 .Fn man_alloc ,  .Fn man_alloc ,
Line 75  then free all allocated memory with
Line 75  then free all allocated memory with
 The  The
 .Fn man_reset  .Fn man_reset
 function may be used in order to reset the parser for another input  function may be used in order to reset the parser for another input
 sequence.  See the  sequence.
 .Sx EXAMPLES  
 section for a full example.  
 .  
 .Pp  .Pp
 Beyond the full set of macros defined in  Beyond the full set of macros defined in
 .Xr man 7 ,  .Xr man 7 ,
 the  the
 .Nm  .Nm
 library also accepts the following macros:  library also accepts the following macro:
 .  
 .Pp  .Pp
 .Bl -tag -width Ds -compact  .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  .It PD
 Has no effect.  Handled as a current-scope line macro.  Has no effect.
 .  
 .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.  Handled as a current-scope line macro.
 .  
 .It Ve  
 A synonym for  
 .Sq fi ,  
 closing  
 .Sq Vb  
 .Pq part of the standard preamble for Perl documentation .  
 Handled as a current-scope line macro.  
 .El  .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+ (C++),  
 \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  
 available to programmers.  Following that, the  
 .Sx Abstract Syntax Tree  
 section documents the output tree.  
 .  
 .  
 .Ss Types  .Ss Types
 Both functions (see  
 .Sx Functions )  
 and variables (see  
 .Sx Variables )  
 may use the following types:  
 .Bl -ohang  .Bl -ohang
 .  
 .It Vt struct man  .It Vt struct man
 An opaque type defined in  An opaque type.
 .Pa man.c .  
 Its values are only used privately within the library.  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 struct man_node  .It Vt struct man_node
 A parsed node.  Defined in  A parsed node.
 .Pa man.h .  
 See  See
 .Sx Abstract Syntax Tree  .Sx Abstract Syntax Tree
 for details.  for details.
 .El  .El
 .  
 .  
 .Ss Functions  .Ss Functions
 Function descriptions follow:  
 .Bl -ohang  .Bl -ohang
 .  
 .It Fn man_alloc  .It Fn man_alloc
 Allocates a parsing structure.  The  Allocates a parsing structure.
 .Fa data  
 pointer is passed to callbacks in  
 .Fa cb ,  
 which are documented further in the header file.  
 The  The
 .Fa pflags  .Fa data
 arguments are defined in  pointer is passed to
 .Pa man.h .  .Fa msgs .
 Returns NULL on failure.  If non-NULL, the pointer must be freed with  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  .Fn man_parseln
 behaves as if invoked for the first time.  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  Free all resources of a parser.
 invocation.  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  Parse a nil-terminated line of input.
 trailing newline.  Returns 0 on failure, 1 on success.  The input buffer  This line should not contain the trailing newline.
   Returns 0 on failure, 1 on success.
   The input buffer
 .Fa buf  .Fa buf
 is modified by this function.  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  .Fn man_endparse
 is called subsequent to  is called subsequent to
 .Fn man_node ,  .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  .Fn man_parseln
 or  or
 .Fn man_endparse  .Fn man_endparse
 return 0, the tree will be incomplete.  return 0, the tree will be incomplete.
 .It Fn man_meta  .It Fn man_meta
 Returns the document's parsed meta-data.  If this information has not  Returns the document's parsed meta-data.
 yet been supplied or  If this information has not yet been supplied or
 .Fn man_parseln  .Fn man_parseln
 or  or
 .Fn man_endparse  .Fn man_endparse
 return 0, the data will be incomplete.  return 0, the data will be incomplete.
 .El  .El
 .  
 .  
 .Ss Variables  .Ss Variables
 The following variables are also defined:  The following variables are also defined:
 .Bl -ohang  .Bl -ohang
 .  
 .It Va man_macronames  .It Va man_macronames
 An array of string-ified token names.  An array of string-ified token names.
 .El  .El
 .  
 .  
 .Ss Abstract Syntax Tree  .Ss Abstract Syntax Tree
 The  The
 .Nm  .Nm
 functions produce an abstract syntax tree (AST) describing input in a  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 ;  .Fn man_nodes ;
 however, if called before  however, if called before
 .Fn man_endparse ,  .Fn man_endparse ,
Line 267  or after
Line 168  or after
 or  or
 .Fn man_parseln  .Fn man_parseln
 fail, it may be incomplete.  fail, it may be incomplete.
 .  
 .Pp  .Pp
 This AST is governed by the ontological  This AST is governed by the ontological rules dictated in
 rules dictated in  
 .Xr man 7  .Xr man 7
 and derives its terminology accordingly.  and derives its terminology accordingly.
 .  
 .Pp  .Pp
 The AST is composed of  The AST is composed of
 .Vt struct man_node  .Vt struct man_node
 nodes with element, root and text types as declared  nodes with element, root and text types as declared by the
 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 line ,
 .Va sec ,  .Va sec ,
 and  and
Line 292  fields), its position in the tree (the
Line 190  fields), its position in the tree (the
 and  and
 .Va prev  .Va prev
 fields) and some type-specific data.  fields) and some type-specific data.
 .  
 .Pp  .Pp
 The tree itself is arranged according to the following normal form,  The tree itself is arranged according to the following normal form,
 where capitalised non-terminals represent nodes.  where capitalised non-terminals represent nodes.
Line 313  where capitalised non-terminals represent nodes.
Line 210  where capitalised non-terminals represent nodes.
 .It TEXT  .It TEXT
 \(<- [[:alpha:]]*  \(<- [[:alpha:]]*
 .El  .El
 .  
 .Pp  .Pp
 The only elements capable of nesting other elements are those with  The only elements capable of nesting other elements are those with
 next-lint scope as documented in  next-lint scope as documented in
 .Xr man 7 .  .Xr man 7 .
 .  
 .  
 .Sh EXAMPLES  .Sh EXAMPLES
 The following example reads lines from stdin and parses them, operating  The following example reads lines from stdin and parses them, operating
 on the finished parse tree with  on the finished parse tree with
 .Fn parsed .  .Fn parsed .
 This example does not error-check nor free memory upon failure.  This example does not error-check nor free memory upon failure.
 .Bd -literal -offset indent  .Bd -literal -offset indent
   struct regset regs;
 struct man *man;  struct man *man;
 struct man_node *node;  struct man_node *node;
 char *buf;  char *buf;
 size_t len;  size_t len;
 int line;  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;  buf = NULL;
 alloc_len = 0;  alloc_len = 0;
   
Line 355  if (NULL == (node = man_node(man)))
Line 251  if (NULL == (node = man_node(man)))
 parsed(man, node);  parsed(man, node);
 man_free(man);  man_free(man);
 .Ed  .Ed
 .  .Pp
 .  To compile this, execute
   .Pp
   .Dl % cc main.c libman.a libmandoc.a
   .Pp
   where
   .Pa main.c
   is the example file.
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr man 7  .Xr man 7
 .  
 .  
 .Sh AUTHORS  .Sh AUTHORS
 The  The
 .Nm  .Nm
 utility was written by  library was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .  .An Kristaps Dzonsons Aq kristaps@bsd.lv .
Legend:
Removed from v.1.14  
changed lines
  Added in v.1.27
CVSweb