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

Diff for /mandoc/mandoc.3 between version 1.24 and 1.36

version 1.24, 2014/03/23 11:25:26 version 1.36, 2016/01/08 17:48:09
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-2016 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 mandoc_calloc ,  .Nm man_deroff ,
 .Nm mandoc_escape ,  
 .Nm mandoc_malloc ,  
 .Nm mandoc_realloc ,  
 .Nm mandoc_strdup ,  
 .Nm mandoc_strndup ,  
 .Nm man_meta ,  .Nm man_meta ,
 .Nm man_mparse ,  .Nm man_mparse ,
 .Nm man_node ,  .Nm man_node ,
 .Nm mchars_alloc ,  .Nm mdoc_deroff ,
 .Nm mchars_free ,  
 .Nm mchars_num2char ,  
 .Nm mchars_num2uc ,  
 .Nm mchars_spec2cp ,  
 .Nm mchars_spec2str ,  
 .Nm mdoc_meta ,  .Nm mdoc_meta ,
 .Nm mdoc_node ,  .Nm mdoc_node ,
 .Nm mparse_alloc ,  .Nm mparse_alloc ,
 .Nm mparse_free ,  .Nm mparse_free ,
 .Nm mparse_getkeep ,  .Nm mparse_getkeep ,
 .Nm mparse_keep ,  .Nm mparse_keep ,
   .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_strerror ,
 .Nm mparse_strlevel  .Nm mparse_strlevel
 .Nd mandoc macro compiler library  .Nd mandoc macro compiler library
 .Sh LIBRARY  
 .Lb libmandoc  
 .Sh SYNOPSIS  .Sh SYNOPSIS
   .In sys/types.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 "void *"  .Ft struct mparse *
 .Fo mandoc_calloc  
 .Fa "size_t nmemb"  
 .Fa "size_t size"  
 .Fc  
 .Ft "enum mandoc_esc"  
 .Fo mandoc_escape  
 .Fa "const char **end"  
 .Fa "const char **start"  
 .Fa "int *sz"  
 .Fc  
 .Ft "void *"  
 .Fn mandoc_malloc "size_t size"  
 .Ft "struct mchars *"  
 .Fo mandoc_realloc  
 .Fa "void *ptr"  
 .Fa "size_t size"  
 .Fc  
 .Ft "char *"  
 .Fn mandoc_strdup  
 .Fn mchars_alloc "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 "const struct mchars *p"  
 .Fa "const char *cp"  
 .Fa "size_t sz"  
 .Fa "size_t *rsz"  
 .Fc  
 .Ft int  
 .Fo mchars_spec2cp  
 .Fa "const struct mchars *p"  
 .Fa "const char *cp"  
 .Fa "size_t sz"  
 .Fc  
 .Ft void  
 .Fo mparse_alloc  .Fo mparse_alloc
 .Fa "enum mparset inttype"  .Fa "int options"
 .Fa "enum mandoclevel wlevel"  .Fa "enum mandoclevel wlevel"
 .Fa "mandocmsg mmsg"  .Fa "mandocmsg mmsg"
 .Fa "char *defos"  .Fa "char *defos"
 .Fa "int quick"  
 .Fc  .Fc
 .Ft void  .Ft void
 .Fo (*mandocmsg)  .Fo (*mandocmsg)
Line 123 
Line 73 
 .Fo mparse_keep  .Fo mparse_keep
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fc  .Fc
   .Ft int
   .Fo mparse_open
   .Fa "struct mparse *parse"
   .Fa "const char *fname"
   .Fc
 .Ft "enum mandoclevel"  .Ft "enum mandoclevel"
 .Fo mparse_readfd  .Fo mparse_readfd
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
Line 138 
Line 93 
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fa "struct mdoc **mdoc"  .Fa "struct mdoc **mdoc"
 .Fa "struct man **man"  .Fa "struct man **man"
   .Fa "char **sodest"
 .Fc  .Fc
 .Ft "const char *"  .Ft "const char *"
 .Fo mparse_strerror  .Fo mparse_strerror
Line 147 
Line 103 
 .Fo mparse_strlevel  .Fo mparse_strlevel
 .Fa "enum mandoclevel"  .Fa "enum mandoclevel"
 .Fc  .Fc
   .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 *"  .Ft "const struct mdoc_meta *"
 .Fo mdoc_meta  .Fo mdoc_meta
 .Fa "const struct mdoc *mdoc"  .Fa "const struct mdoc *mdoc"
Line 159 
Line 121 
 .Fc  .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 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 *"  .Ft "const struct man_meta *"
 .Fo man_meta  .Fo man_meta
 .Fa "const struct man *man"  .Fa "const struct man *man"
Line 196  The following describes a general parse sequence:
Line 164  The following describes a general parse sequence:
 .Bl -enum  .Bl -enum
 .It  .It
 initiate a parsing sequence with  initiate a parsing sequence with
   .Xr mchars_alloc 3
   and
 .Fn mparse_alloc ;  .Fn mparse_alloc ;
 .It  .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 ;  .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  iterate over parse nodes with
Line 210  or
Line 188  or
 .Fn man_node ;  .Fn man_node ;
 .It  .It
 free all allocated memory with  free all allocated memory with
 .Fn mparse_free ,  .Fn mparse_free
   and
   .Xr mchars_free 3 ,
 or invoke  or invoke
 .Fn mparse_reset  .Fn mparse_reset
 and parse new files.  and 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 .  
 .Sh REFERENCE  .Sh REFERENCE
 This section documents the functions, types, and variables available  This section documents the functions, types, and variables available
 via  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  .Ss Types
 .Bl -ohang  .Bl -ohang
 .It Vt "enum mandoc_esc"  
 An escape sequence classification.  
 .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"  
 An opaque pointer to an object allowing for translation between  
 character strings and glyphs.  
 See  
 .Fn mchars_alloc .  
 .It Vt "enum mparset"  
 The type of parser when reading input.  
 This should usually be  
 .Dv MPARSE_AUTO  
 for auto-detection.  
 .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 256  This may be used across parsed input if
Line 221  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"  .It Vt "mandocmsg"
 A prototype for a function to handle fatal error, error, and warning  A prototype for a function to handle error and warning
 messages emitted by the parser.  messages emitted by the parser.
 .El  .El
 .Ss Functions  .Ss Functions
 .Bl -ohang  .Bl -ohang
 .It Fn mandoc_escape  .It Fn man_deroff
 Scan an escape sequence, i.e., a character string beginning with  Obtain a text-only representation of a
 .Sq \e .  .Vt struct man_node ,
 Pass a pointer to the character after the  including text contained in its child nodes.
 .Sq \e  To be used on children of the pointer returned from
 as  .Fn man_node .
 .Va end ;  When it is no longer needed, the pointer returned from
 it will be set to the supremum of the parsed escape sequence unless  .Fn man_deroff
 returning  can be passed to
 .Dv ESCAPE_ERROR ,  .Xr free 3 .
 in which case the string is bogus and should be  
 thrown away.  
 If not  
 .Dv ESCAPE_ERROR  
 or  
 .Dv 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  
 .Dv NULL .  
 Declared in  
 .In mandoc.h ,  
 implemented in  
 .Pa mandoc.c .  
 .It Fn man_meta  .It Fn man_meta
 Obtain the meta-data of a successful parse.  Obtain the meta-data of a successful
   .Xr man 7
   parse.
 This may only be used on a pointer returned by  This may only be used on a pointer returned by
 .Fn mparse_result .  .Fn mparse_result .
 Declared in  Declared in
Line 306  Declared in
Line 253  Declared in
 implemented in  implemented in
 .Pa man.c .  .Pa man.c .
 .It Fn man_node  .It Fn man_node
 Obtain the root node of a successful parse.  Obtain the root node of a successful
   .Xr man 7
   parse.
 This may only be used on a pointer returned by  This may only be used on a pointer returned by
 .Fn mparse_result .  .Fn mparse_result .
 Declared in  Declared in
 .In man.h ,  .In man.h ,
 implemented in  implemented in
 .Pa man.c .  .Pa man.c .
 .It Fn mchars_alloc  .It Fn mdoc_deroff
 Allocate an  Obtain a text-only representation of a
 .Vt "struct mchars *"  .Vt struct mdoc_node ,
 object for translating special characters into glyphs.  including text contained in its child nodes.
 See  To be used on children of the pointer returned from
 .Xr mandoc_char 7  .Fn mdoc_node .
 for an overview of special characters.  When it is no longer needed, the pointer returned from
 The object must be freed with  .Fn mdoc_deroff
 .Fn mchars_free .  can be passed to
 Declared in  .Xr free 3 .
 .In mandoc.h ,  
 implemented in  
 .Pa chars.c .  
 .It Fn mchars_free  
 Free an object created with  
 .Fn mchars_alloc .  
 Declared in  
 .In mandoc.h ,  
 implemented in  
 .Pa chars.c .  
 .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.  
 Declared in  
 .In mandoc.h ,  
 implemented in  
 .Pa chars.c .  
 .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.  
 Declared in  
 .In mandoc.h ,  
 implemented in  
 .Pa chars.c .  
 .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.  
 Declared in  
 .In mandoc.h ,  
 implemented in  
 .Pa chars.c .  
 .It Fn mchars_spec2str  
 Convert a special character into an ASCII string.  
 Returns  
 .Dv NULL  
 on failure.  
 Declared in  
 .In mandoc.h ,  
 implemented in  
 .Pa chars.c .  
 .It Fn mdoc_meta  .It Fn mdoc_meta
 Obtain the meta-data of a successful parse.  Obtain the meta-data of a successful
   .Xr mdoc
   parse.
 This may only be used on a pointer returned by  This may only be used on a pointer returned by
 .Fn mparse_result .  .Fn mparse_result .
 Declared in  Declared in
Line 374  Declared in
Line 283  Declared in
 implemented in  implemented in
 .Pa mdoc.c .  .Pa mdoc.c .
 .It Fn mdoc_node  .It Fn mdoc_node
 Obtain the root node of a successful parse.  Obtain the root node of a successful
   .Xr mdoc
   parse.
 This may only be used on a pointer returned by  This may only be used on a pointer returned by
 .Fn mparse_result .  .Fn mparse_result .
 Declared in  Declared in
Line 385  implemented in
Line 296  implemented in
 Allocate a parser.  Allocate a parser.
 The arguments have the following effect:  The arguments have the following effect:
 .Bl -tag -offset 5n -width inttype  .Bl -tag -offset 5n -width inttype
 .It Ar inttype  .It Ar options
 When set to  When the
 .Dv MPARSE_MDOC  .Dv MPARSE_MDOC
 or  or
 .Dv MPARSE_MAN ,  .Dv MPARSE_MAN
 only that parser will be used.  bit is set, only that parser is used.
 With  Otherwise, the document type is automatically detected.
 .Dv MPARSE_AUTO ,  .Pp
 the document type will be automatically detected.  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 wlevel  .It Ar wlevel
 Can be set to  Can be set to
 .Dv MANDOCLEVEL_FATAL ,  .Dv MANDOCLEVEL_BADARG ,
 .Dv MANDOCLEVEL_ERROR ,  .Dv MANDOCLEVEL_ERROR ,
 or  or
 .Dv MANDOCLEVEL_WARNING .  .Dv MANDOCLEVEL_WARNING .
Line 414  macro, overriding the
Line 343  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 .
 .It Ar quick  
 When set, parsing is aborted after the NAME section.  
 This is for example useful to quickly build minimal databases.  
 .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 452  Declared in
Line 378  Declared in
 .In mandoc.h ,  .In mandoc.h ,
 implemented in  implemented in
 .Pa read.c .  .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.  Parse a file descriptor opened with
 If  .Xr open 2
 .Va fd  or
 is -1,  .Fn mparse_open .
 .Va fname  Pass the associated filename in
 is opened for reading.  .Va fname .
 Otherwise,  This function may be called multiple times with different parameters; however,
 .Va fname  .Xr close 2
 is assumed to be the name associated with  and
 .Va fd .  
 This may be called multiple times with different parameters; however,  
 .Fn mparse_reset  .Fn mparse_reset
 should be invoked between parses.  should be invoked between parses.
 Declared in  Declared in
Line 480  implemented in
Line 421  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  One of the three pointers will be filled in.
 .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.  
 Declared in  Declared in
 .In mandoc.h ,  .In mandoc.h ,
 implemented in  implemented in
Line 540  The following non-printing characters may be embedded 
Line 474  The following non-printing characters may be embedded 
 A non-breaking space character.  A non-breaking space character.
 .It Dv ASCII_HYPH  .It Dv ASCII_HYPH
 A soft hyphen.  A soft hyphen.
   .It Dv ASCII_BREAK
   A breakable zero-width space.
 .El  .El
 .Pp  .Pp
 Escape characters are also passed verbatim into text strings.  Escape characters are also passed verbatim into text strings.
Line 547  An escape character is a sequence of characters beginn
Line 483  An escape character is a sequence of characters beginn
 backslash  backslash
 .Pq Sq \e .  .Pq Sq \e .
 To construct human-readable text, these should be intercepted with  To construct human-readable text, these should be intercepted with
 .Fn mandoc_escape  .Xr mandoc_escape 3
 and converted with one of  and converted with one the functions described in
 .Fn mchars_num2char ,  .Xr mchars_alloc 3 .
 .Fn mchars_spec2str ,  
 and so on.  
 .Ss Man Abstract Syntax Tree  .Ss Man Abstract Syntax Tree
 This AST is governed by the ontological rules dictated in  This AST is governed by the ontological rules dictated in
 .Xr man 7  .Xr man 7
Line 596  where capitalised non-terminals represent nodes.
Line 530  where capitalised non-terminals represent nodes.
 .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-line scope as documented in
 .Xr man 7 .  .Xr man 7 .
 .Ss Mdoc Abstract Syntax Tree  .Ss Mdoc Abstract Syntax Tree
 This AST is governed by the ontological  This AST is governed by the ontological
Line 623  and
Line 557  and
 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 732  front-ends to
Line 666  front-ends to
 .Xr mandoc 1  .Xr mandoc 1
 are unable to render them in any meaningful way.  are 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 mandoc_escape 3 ,
   .Xr mandoc_malloc 3 ,
   .Xr mchars_alloc 3 ,
 .Xr eqn 7 ,  .Xr eqn 7 ,
 .Xr man 7 ,  .Xr man 7 ,
 .Xr mandoc_char 7 ,  .Xr mandoc_char 7 ,

Legend:
Removed from v.1.24  
changed lines
  Added in v.1.36

CVSweb