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

Diff for /mandoc/Attic/man.3 between version 1.24 and 1.25

version 1.24, 2010/08/20 01:02:07 version 1.25, 2010/10/10 09:47:05
Line 76  The
Line 76  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.  sequence.
 See the  
 .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 ,
Line 107  closing
Line 104  closing
 .Pq part of the standard preamble for Perl documentation .  .Pq part of the standard preamble for Perl documentation .
 Handled as a current-scope line macro.  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` (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 mandocmsg  
 A function callback type defined in  
 .Pa mandoc.h .  
 .It Vt struct man_node  .It Vt struct man_node
 A parsed node.  A parsed node.
 Defined in  
 .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.  Allocates a parsing structure.
Line 316  parsed(man, node);
Line 268  parsed(man, node);
 man_free(man);  man_free(man);
 .Ed  .Ed
 .Pp  .Pp
 Please see  To compile this, execute
   .Pp
   .D1 % cc main.c libman.a libmandoc.a
   .Pp
   where
 .Pa main.c  .Pa main.c
 in the source archive for a rigorous reference.  is the example file.
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr man 7  .Xr man 7
Legend:
Removed from v.1.24  
changed lines
  Added in v.1.25
CVSweb