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

Diff for /mandoc/mandoc.3 between version 1.30 and 1.44

version 1.30, 2015/01/15 02:29:26 version 1.44, 2018/12/30 00:49:55
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" 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  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above  .\" purpose with or without fee is hereby granted, provided that the above
Line 20 
Line 20 
 .Os  .Os
 .Sh NAME  .Sh NAME
 .Nm mandoc ,  .Nm mandoc ,
 .Nm man_deroff ,  .Nm deroff ,
 .Nm man_meta ,  
 .Nm man_mparse ,  
 .Nm man_node ,  
 .Nm mdoc_deroff ,  
 .Nm mdoc_meta ,  
 .Nm mdoc_node ,  
 .Nm mparse_alloc ,  .Nm mparse_alloc ,
   .Nm mparse_copy ,
 .Nm mparse_free ,  .Nm mparse_free ,
 .Nm mparse_getkeep ,  
 .Nm mparse_keep ,  
 .Nm mparse_open ,  .Nm mparse_open ,
 .Nm mparse_readfd ,  .Nm mparse_readfd ,
 .Nm mparse_reset ,  .Nm mparse_reset ,
 .Nm mparse_result ,  .Nm mparse_result
 .Nm mparse_strerror ,  
 .Nm mparse_strlevel  
 .Nm mparse_wait ,  
 .Nd mandoc macro compiler library  .Nd mandoc macro compiler library
 .Sh LIBRARY  
 .Lb libmandoc  
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .In sys/types.h  .In sys/types.h
   .In stdio.h
 .In mandoc.h  .In mandoc.h
   .Pp
 .Fd "#define ASCII_NBRSP"  .Fd "#define ASCII_NBRSP"
 .Fd "#define ASCII_HYPH"  .Fd "#define ASCII_HYPH"
 .Fd "#define ASCII_BREAK"  .Fd "#define ASCII_BREAK"
 .Ft struct mparse *  .Ft struct mparse *
 .Fo mparse_alloc  .Fo mparse_alloc
 .Fa "int options"  .Fa "int options"
 .Fa "enum mandoclevel wlevel"  .Fa "enum mandoc_os oe_e"
 .Fa "mandocmsg mmsg"  .Fa "char *os_s"
 .Fa "const struct mchars *mchars"  
 .Fa "char *defos"  
 .Fc  .Fc
 .Ft void  .Ft void
 .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  
 .Ft void  
 .Fo mparse_free  .Fo mparse_free
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fc  .Fc
 .Ft const char *  .Ft void
 .Fo mparse_getkeep  .Fo mparse_copy
 .Fa "const struct mparse *parse"  .Fa "const struct mparse *parse"
 .Fc  .Fc
 .Ft void  .Ft int
 .Fo mparse_keep  
 .Fa "struct mparse *parse"  
 .Fc  
 .Ft "enum mandoclevel"  
 .Fo mparse_open  .Fo mparse_open
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fa "int *fd"  
 .Fa "const char *fname"  .Fa "const char *fname"
 .Fc  .Fc
 .Ft "enum mandoclevel"  .Ft void
 .Fo mparse_readfd  .Fo mparse_readfd
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fa "int fd"  .Fa "int fd"
Line 92 
Line 66 
 .Fo mparse_reset  .Fo mparse_reset
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fc  .Fc
 .Ft void  .Ft struct roff_meta *
 .Fo mparse_result  .Fo mparse_result
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fa "struct mdoc **mdoc"  
 .Fa "struct man **man"  
 .Fa "char **sodest"  
 .Fc  .Fc
 .Ft "const char *"  .In roff.h
 .Fo mparse_strerror  .Ft void
 .Fa "enum mandocerr"  .Fo deroff
   .Fa "char **dest"
   .Fa "const struct roff_node *node"
 .Fc  .Fc
 .Ft "const char *"  
 .Fo mparse_strlevel  
 .Fa "enum mandoclevel"  
 .Fc  
 .Ft "enum mandoclevel"  
 .Fo mparse_wait  
 .Fa "struct mparse *parse"  
 .Fc  
 .In sys/types.h  .In sys/types.h
 .In mandoc.h  .In mandoc.h
 .In mdoc.h  .In mdoc.h
 .Ft void  
 .Fo mdoc_deroff  
 .Fa "char **dest"  
 .Fa "const struct mdoc_node *node"  
 .Fc  
 .Ft "const struct mdoc_meta *"  
 .Fo mdoc_meta  
 .Fa "const struct mdoc *mdoc"  
 .Fc  
 .Ft "const struct mdoc_node *"  
 .Fo mdoc_node  
 .Fa "const struct mdoc *mdoc"  
 .Fc  
 .Vt extern const char * const * mdoc_argnames;  .Vt extern const char * const * mdoc_argnames;
 .Vt extern const char * const * mdoc_macronames;  .Vt extern const char * const * mdoc_macronames;
 .In sys/types.h  .In sys/types.h
 .In mandoc.h  .In mandoc.h
 .In man.h  .In man.h
 .Ft void  
 .Fo man_deroff  
 .Fa "char **dest"  
 .Fa "const struct man_node *node"  
 .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"  
 .Fc  
 .Vt extern const char * const * man_macronames;  .Vt extern const char * const * man_macronames;
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
Line 176  initiate a parsing sequence with
Line 111  initiate a parsing sequence with
 and  and
 .Fn mparse_alloc ;  .Fn mparse_alloc ;
 .It  .It
 parse files with  open a file with
 .Fn mparse_open  .Xr open 2
 and  or
   .Fn mparse_open ;
   .It
   parse it with
 .Fn mparse_readfd ;  .Fn mparse_readfd ;
 .It  .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 ;  .Fn mparse_result ;
 .It  .It
 iterate over parse nodes with  if information about the validity of the input is needed, fetch it with
 .Fn mdoc_node  .Fn mparse_updaterc ;
 or  
 .Fn man_node ;  
 .It  .It
   iterate over parse nodes with starting from the
   .Fa first
   member of the returned
   .Vt struct roff_meta ;
   .It
 free all allocated memory with  free all allocated memory with
 .Fn mparse_free  .Fn mparse_free
 and  and
 .Xr mchars_free 3 ,  .Xr mchars_free 3 ,
 or invoke  or invoke
 .Fn mparse_reset  .Fn mparse_reset
 and parse new files.  and go back to step 2 to parse new files.
 .El  .El
 .Sh REFERENCE  .Sh REFERENCE
 This section documents the functions, types, and variables available  This section documents the functions, types, and variables available
Line 208  and
Line 152  and
 .Ss Types  .Ss Types
 .Bl -ohang  .Bl -ohang
 .It Vt "enum mandocerr"  .It Vt "enum mandocerr"
 A fatal error, error, or warning message during parsing.  An error or warning message during parsing.
 .It Vt "enum mandoclevel"  .It Vt "enum mandoclevel"
 A classification of an  A classification of an
 .Vt "enum mandocerr"  .Vt "enum mandocerr"
 as regards system operation.  as regards system operation.
 .It Vt "struct mchars"  See the DIAGNOSTICS section in
 An opaque pointer to a a character table.  .Xr mandoc 1
 Created with  regarding the meanings of the levels.
 .Xr mchars_alloc 3  
 and freed with  
 .Xr mchars_free 3 .  
 .It Vt "struct mparse"  .It Vt "struct mparse"
 An opaque pointer to a running parse sequence.  An opaque pointer to a running parse sequence.
 Created with  Created with
Line 228  and freed with
Line 169  and freed with
 This may be used across parsed input if  This may be used across parsed input if
 .Fn mparse_reset  .Fn mparse_reset
 is called between parses.  is called between parses.
 .It Vt "mandocmsg"  
 A prototype for a function to handle fatal error, error, and warning  
 messages emitted by the parser.  
 .El  .El
 .Ss Functions  .Ss Functions
 .Bl -ohang  .Bl -ohang
 .It Fn man_deroff  .It Fn deroff
 Obtain a text-only representation of a  Obtain a text-only representation of a
 .Vt struct man_node ,  .Vt struct roff_node ,
 including text contained in its child nodes.  including text contained in its child nodes.
 To be used on children of the pointer returned from  To be used on children of the
 .Fn man_node .  .Fa first
   member of
   .Vt struct roff_meta .
 When it is no longer needed, the pointer returned from  When it is no longer needed, the pointer returned from
 .Fn man_deroff  .Fn deroff
 can be passed to  can be passed to
 .Xr free 3 .  .Xr free 3 .
 .It Fn man_meta  
 Obtain the meta-data of a successful  
 .Xr man 7  
 parse.  
 This may only be used on a pointer returned by  
 .Fn mparse_result .  
 Declared in  
 .In man.h ,  
 implemented in  
 .Pa man.c .  
 .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_node  
 Obtain the root node of a successful  
 .Xr man 7  
 parse.  
 This may only be used on a pointer returned by  
 .Fn mparse_result .  
 Declared in  
 .In man.h ,  
 implemented in  
 .Pa man.c .  
 .It Fn mdoc_deroff  
 Obtain a text-only representation of a  
 .Vt struct mdoc_node ,  
 including text contained in its child nodes.  
 To be used on children of the pointer returned from  
 .Fn mdoc_node .  
 When it is no longer needed, the pointer returned from  
 .Fn mdoc_deroff  
 can be passed to  
 .Xr free 3 .  
 .It Fn mdoc_meta  
 Obtain the meta-data of a successful  
 .Xr mdoc  
 parse.  
 This may only be used on a pointer returned by  
 .Fn mparse_result .  
 Declared in  
 .In mdoc.h ,  
 implemented in  
 .Pa mdoc.c .  
 .It Fn mdoc_node  
 Obtain the root node of a successful  
 .Xr mdoc  
 parse.  
 This may only be used on a pointer returned by  
 .Fn mparse_result .  
 Declared in  
 .In mdoc.h ,  
 implemented in  
 .Pa mdoc.c .  
 .It Fn mparse_alloc  .It Fn mparse_alloc
 Allocate a parser.  Allocate a parser.
 The arguments have the following effect:  The arguments have the following effect:
Line 321  file inclusion requests are always honoured.
Line 205  file inclusion requests are always honoured.
 Otherwise, if the request is the only content in an input file,  Otherwise, if the request is the only content in an input file,
 only the file name is remembered, to be returned in the  only the file name is remembered, to be returned in the
 .Fa sodest  .Fa sodest
 argument of  field of
 .Fn mparse_result .  .Vt struct roff_meta .
 .Pp  .Pp
 When the  When the
 .Dv MPARSE_QUICK  .Dv MPARSE_QUICK
Line 331  This is for example useful in
Line 215  This is for example useful in
 .Xr makewhatis 8  .Xr makewhatis 8
 .Fl Q  .Fl Q
 to quickly build minimal databases.  to quickly build minimal databases.
 .It Ar wlevel  .Pp
 Can be set to  When the
 .Dv MANDOCLEVEL_FATAL ,  .Dv MARSE_VALIDATE
 .Dv MANDOCLEVEL_ERROR ,  bit is set,
   .Fn mparse_result
   runs the validation functions before returning the syntax tree.
   This is almost always required, except in certain debugging scenarios,
   for example to dump unvalidated syntax trees.
   .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  or
 .Dv MANDOCLEVEL_WARNING .  .Xr uname 3 .
 Messages below the selected level will be suppressed.  .It Ar os_s
 .It Ar mmsg  
 A callback function to handle errors and warnings.  
 See  
 .Pa main.c  
 for an example.  
 .It Ar mchars  
 An opaque pointer to a a character table obtained from  
 .Xr mchars_alloc 3 .  
 .It Ar defos  
 A default string for the  A default string for the
 .Xr mdoc 7  .Xr mdoc 7
 .Sq \&Os  .Ic \&Os
 macro, overriding the  macro, overriding the
 .Dv OSNAME  .Dv OSNAME
 preprocessor definition and the results of  preprocessor definition and the results of
 .Xr uname 3 .  .Xr uname 3 .
   Passing
   .Dv NULL
   sets no default.
 .El  .El
 .Pp  .Pp
 The same parser may be used for multiple files so long as  The same parser may be used for multiple files so long as
Line 372  Declared in
Line 261  Declared in
 .In mandoc.h ,  .In mandoc.h ,
 implemented in  implemented in
 .Pa read.c .  .Pa read.c .
 .It Fn mparse_getkeep  .It Fn mparse_copy
 Acquire the keep buffer.  Dump a copy of the input to the standard output; used for
 Must follow a call of  .Fl man T Ns Cm man .
 .Fn mparse_keep .  
 Declared in  Declared in
 .In mandoc.h ,  .In mandoc.h ,
 implemented in  implemented in
 .Pa read.c .  .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  .It Fn mparse_open
 If the  Open the file for reading.
   If that fails and
 .Fa fname  .Fa fname
 ends in  does not already end in
 .Pa .gz ,  .Ql .gz ,
 open with  try again after appending
 .Xr gunzip 1 ;  .Ql .gz .
 otherwise, with  Save the information whether the file is zipped or not.
 .Xr open 2 .  Return a file descriptor open for reading or -1 on failure.
 If  
 .Xr open 2  
 fails, append  
 .Pa .gz  
 and try with  
 .Xr gunzip 1 .  
 Return a file descriptor open for reading in  
 .Fa fd ,  
 or -1 on failure.  
 It can be passed to  It can be passed to
 .Fn mparse_readfd  .Fn mparse_readfd
 or used directly.  or used directly.
Line 421  or
Line 292  or
 .Fn mparse_open .  .Fn mparse_open .
 Pass the associated filename in  Pass the associated filename in
 .Va fname .  .Va fname .
 Calls  
 .Fn mparse_wait  
 before returning.  
 This function may be called multiple times with different parameters; however,  This function may be called multiple times with different parameters; however,
   .Xr close 2
   and
 .Fn mparse_reset  .Fn mparse_reset
 should be invoked between parses.  should be invoked between parses.
 Declared in  Declared in
Line 441  implemented in
Line 311  implemented in
 .Pa read.c .  .Pa read.c .
 .It Fn mparse_result  .It Fn mparse_result
 Obtain the result of a parse.  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 three pointers will  
 be filled in.  
 Declared in  Declared in
 .In mandoc.h ,  .In mandoc.h ,
 implemented in  implemented in
 .Pa read.c .  .Pa read.c .
 .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.  
 Declared in  
 .In mandoc.h ,  
 implemented in  
 .Pa read.c .  
 .It Fn mparse_wait  
 Bury a  
 .Xr gunzip 1  
 child process that was spawned with  
 .Fn mparse_open .  
 To be called after the parse sequence is complete.  
 Not needed after  
 .Fn mparse_readfd ,  
 but does no harm in that case, either.  
 Returns  
 .Dv MANDOCLEVEL_OK  
 on success and  
 .Dv MANDOCLEVEL_SYSERR  
 on failure, that is, when  
 .Xr wait 2  
 fails, or when  
 .Xr gunzip 1  
 died from a signal or exited with non-zero status.  
 Declared in  
 .In mandoc.h ,  
 implemented in  
 .Pa read.c .  
 .El  .El
 .Ss Variables  .Ss Variables
 .Bl -ohang  .Bl -ohang
 .It Va man_macronames  .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" .  .Vt "enum mant" .
 .It Va mdoc_argnames  .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" .  .Vt "enum mdocargt" .
 .It Va mdoc_macronames  .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" .  .Vt "enum mdoct" .
 .El  .El
 .Sh IMPLEMENTATION NOTES  .Sh IMPLEMENTATION NOTES
Line 541  This AST is governed by the ontological rules dictated
Line 375  This AST is governed by the ontological rules dictated
 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 roff_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.  field.
 Each node also provides its parse point (the  Each node also provides its parse point (the
 .Va line ,  .Va line ,
 .Va sec ,  .Va pos ,
 and  and
 .Va pos  .Va sec
 fields), its position in the tree (the  fields), its position in the tree (the
 .Va parent ,  .Va parent ,
 .Va child ,  .Va child ,
Line 593  are described simply as
Line 427  are described simply as
 .Qq elements .  .Qq elements .
 .Pp  .Pp
 The AST is composed of  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  nodes with block, head, body, element, root and text types as declared
 by the  by the
 .Va type  .Va type
 field.  field.
 Each node also provides its parse point (the  Each node also provides its parse point (the
 .Va line ,  .Va line ,
 .Va sec ,  .Va pos ,
 and  and
 .Va pos  .Va sec
 fields), its position in the tree (the  fields), its position in the tree (the
 .Va parent ,  .Va parent ,
 .Va child ,  .Va child ,
 .Va nchild ,  .Va last ,
 .Va next  .Va next
 and  and
 .Va prev  .Va prev
Line 690  TEXT end
Line 524  TEXT end
 .Ed  .Ed
 .Pp  .Pp
 Here, the formatting of the  Here, the formatting of the
 .Sq \&Ao  .Ic \&Ao
 block extends from TEXT ao to TEXT ac,  block extends from TEXT ao to TEXT ac,
 while the formatting of the  while the formatting of the
 .Sq \&Bo  .Ic \&Bo
 block extends from TEXT bo to TEXT bc.  block extends from TEXT bo to TEXT bc.
 It renders as follows in  It renders as follows in
 .Fl T Ns Cm ascii  .Fl T Ns Cm ascii
Line 709  Using badly-nested blocks is
Line 543  Using badly-nested blocks is
 .Em strongly discouraged ;  .Em strongly discouraged ;
 for example, the  for example, the
 .Fl T Ns Cm html  .Fl T Ns Cm html
 and  front-end to
 .Fl T Ns Cm xhtml  
 front-ends 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.  levels of badly-nested blocks.
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
   .Xr man.cgi 3 ,
 .Xr mandoc_escape 3 ,  .Xr mandoc_escape 3 ,
   .Xr mandoc_headers 3 ,
 .Xr mandoc_malloc 3 ,  .Xr mandoc_malloc 3 ,
   .Xr mansearch 3 ,
 .Xr mchars_alloc 3 ,  .Xr mchars_alloc 3 ,
   .Xr tbl 3 ,
 .Xr eqn 7 ,  .Xr eqn 7 ,
 .Xr man 7 ,  .Xr man 7 ,
 .Xr mandoc_char 7 ,  .Xr mandoc_char 7 ,
Line 729  levels of badly-nested blocks.
Line 565  levels of badly-nested blocks.
 .Xr roff 7 ,  .Xr roff 7 ,
 .Xr tbl 7  .Xr tbl 7
 .Sh AUTHORS  .Sh AUTHORS
   .An -nosplit
 The  The
 .Nm  .Nm
 library was written by  library was written by
 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
   and is maintained by
   .An Ingo Schwarze Aq Mt schwarze@openbsd.org .

Legend:
Removed from v.1.30  
changed lines
  Added in v.1.44

CVSweb