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

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

version 1.9, 2011/05/24 21:31:23 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_escape ,  .Nm man_deroff ,
 .Nm man_meta ,  .Nm man_meta ,
   .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_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 mandoc  
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .In man.h  .In sys/types.h
 .In mdoc.h  
 .In mandoc.h  .In mandoc.h
 .Ft "enum mandoc_esc"  .Pp
 .Fo mandoc_escape  .Fd "#define ASCII_NBRSP"
 .Fa "const char **in"  .Fd "#define ASCII_HYPH"
 .Fa "const char **seq"  .Fd "#define ASCII_BREAK"
 .Fa "int *len"  .Ft struct mparse *
   .Fo mparse_alloc
   .Fa "int options"
   .Fa "enum mandoclevel wlevel"
   .Fa "mandocmsg mmsg"
   .Fa "char *defos"
 .Fc  .Fc
 .Ft "const struct man_meta *"  .Ft void
 .Fo man_meta  .Fo (*mandocmsg)
 .Fa "const struct man *man"  .Fa "enum mandocerr errtype"
   .Fa "enum mandoclevel level"
   .Fa "const char *file"
   .Fa "int line"
   .Fa "int col"
   .Fa "const char *msg"
 .Fc  .Fc
 .Ft "const struct man_node *"  
 .Fo man_node  
 .Fa "const struct man *man"  
 .Fc  
 .Ft "struct mchars *"  
 .Fn mchars_alloc  
 .Ft void  .Ft void
 .Fn mchars_free "struct mchars *p"  .Fo mparse_free
 .Ft char  .Fa "struct mparse *parse"
 .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 "struct mchars *p"  
 .Fa "const char *cp"  
 .Fa "size_t sz"  
 .Fa "size_t *rsz"  
 .Fc  .Fc
 .Ft int  .Ft const char *
 .Fo mchars_spec2cp  .Fo mparse_getkeep
 .Fa "struct mchars *p"  .Fa "const struct mparse *parse"
 .Fa "const char *cp"  
 .Fa "size_t sz"  
 .Ft "const char *"  
 .Fc  .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  
 .Ft void  .Ft void
 .Fo mparse_alloc  .Fo mparse_keep
 .Fa "enum mparset type"  .Fa "struct mparse *parse"
 .Fa "enum mandoclevel wlevel"  
 .Fa "mandocmsg msg"  
 .Fa "void *msgarg"  
 .Fc  .Fc
 .Ft void  .Ft int
 .Fo mparse_free  .Fo mparse_open
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
   .Fa "const char *fname"
 .Fc  .Fc
 .Ft "enum mandoclevel"  .Ft "enum mandoclevel"
 .Fo mparse_readfd  .Fo mparse_readfd
Line 115 
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 124 
Line 103 
 .Fo mparse_strlevel  .Fo mparse_strlevel
 .Fa "enum mandoclevel"  .Fa "enum mandoclevel"
 .Fc  .Fc
 .Vt extern const char * const * man_macronames;  .In sys/types.h
   .In mandoc.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;
 .Fd "#define ASCII_NBRSP"  .In sys/types.h
 .Fd "#define ASCII_HYPH"  .In mandoc.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;
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm mandoc  .Nm mandoc
Line 151  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 165  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 .  
 .Pp  
 This library is  
 .Ud  
 .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"  
 .It Vt "enum mandocerr"  .It Vt "enum mandocerr"
   An error or warning message during parsing.
 .It Vt "enum mandoclevel"  .It Vt "enum mandoclevel"
 .It Vt "struct mchars"  A classification of an
 An opaque pointer to an object allowing for translation between  .Vt "enum mandocerr"
 character strings and glyphs.  as regards system operation.
 See  
 .Fn mchars_alloc .  
 .It Vt "enum mparset"  
 .It Vt "struct mparse"  .It Vt "struct mparse"
   An opaque pointer to a running parse sequence.
   Created with
   .Fn mparse_alloc
   and freed with
   .Fn mparse_free .
   This may be used across parsed input if
   .Fn mparse_reset
   is called between parses.
 .It Vt "mandocmsg"  .It Vt "mandocmsg"
   A prototype for a function to handle error and warning
   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 this string as  including text contained in its child nodes.
 .Va end ;  To be used on children of the pointer returned from
 it will be set to the supremum of the parsed escape sequence unless  .Fn man_node .
 returning ESCAPE_ERROR, in which case the string is bogus and should be  When it is no longer needed, the pointer returned from
 thrown away.  .Fn man_deroff
 If not ESCAPE_ERROR or ESCAPE_IGNORE,  can be passed to
 .Va start  .Xr free 3 .
 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 NULL.  
 .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
   .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  .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 .
 .It Fn mchars_alloc  Declared in
 Allocate an  .In man.h ,
 .Vt "struct mchars *"  implemented in
 object for translating special characters into glyphs.  .Pa man.c .
 See  .It Fn mdoc_deroff
 .Xr mandoc_char 7  Obtain a text-only representation of a
 for an overview of special characters.  .Vt struct mdoc_node ,
 The object must be freed with  including text contained in its child nodes.
 .Fn mchars_free .  To be used on children of the pointer returned from
 .It Fn mchars_free  .Fn mdoc_node .
 Free an object created with  When it is no longer needed, the pointer returned from
 .Fn mchars_alloc .  .Fn mdoc_deroff
 .It Fn mchars_num2char  can be passed to
 Convert a character index (e.g., the \eN\(aq\(aq escape) into a  .Xr free 3 .
 printable ASCII character.  
 Returns \e0 (the nil character) if the input sequence is malformed.  
 .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.  
 .It Fn mchars_spec2cp  
 Convert a special character into a valid Unicode codepoint.  
 Returns \-1 on failure and 0 if no code-point exists (if this occurs,  
 the caller should fall back to  
 .Fn mchars_spec2str ) .  
 .It Fn mchars_spec2str  
 Convert a special character into an ASCII string.  
 Returns NULL on failure.  
 .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
   .In mdoc.h ,
   implemented in
   .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
   .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:
   .Bl -tag -offset 5n -width inttype
   .It Ar options
   When the
   .Dv MPARSE_MDOC
   or
   .Dv MPARSE_MAN
   bit is set, only that parser is used.
   Otherwise, the document type is automatically detected.
   .Pp
   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
   Can be set to
   .Dv MANDOCLEVEL_BADARG ,
   .Dv MANDOCLEVEL_ERROR ,
   or
   .Dv MANDOCLEVEL_WARNING .
   Messages below the selected level will be suppressed.
   .It Ar mmsg
   A callback function to handle errors and warnings.
   See
   .Pa main.c
   for an example.
   .It Ar defos
   A default string for the
   .Xr mdoc 7
   .Sq \&Os
   macro, overriding the
   .Dv OSNAME
   preprocessor definition and the results of
   .Xr uname 3 .
   .El
   .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
 .Fn mparse_reset  .Fn mparse_reset
 is called between parses.  is called between parses.
 .Fn mparse_free  .Fn mparse_free
 must be called to free the memory allocated by this function.  must be called to free the memory allocated by this function.
   Declared in
   .In mandoc.h ,
   implemented in
   .Pa read.c .
 .It Fn mparse_free  .It Fn mparse_free
 Free all memory allocated by  Free all memory allocated by
 .Fn mparse_alloc .  .Fn mparse_alloc .
   Declared in
   .In mandoc.h ,
   implemented in
   .Pa read.c .
   .It Fn mparse_getkeep
   Acquire the keep buffer.
   Must follow a call of
   .Fn mparse_keep .
   Declared in
   .In mandoc.h ,
   implemented in
   .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
   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
   .In mandoc.h ,
   implemented in
   .Pa read.c .
 .It Fn mparse_reset  .It Fn mparse_reset
 Reset a parser so that  Reset a parser so that
 .Fn mparse_readfd  .Fn mparse_readfd
 may be used again.  may be used again.
   Declared in
   .In mandoc.h ,
   implemented in
   .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  Declared in
 i.e., those where  .In mandoc.h ,
 .Fn mparse_readfd  implemented in
 returned less than MANDOCLEVEL_FATAL  .Pa read.c .
 .Pc  
 should invoke this function, in which case one of the two pointers will  
 be filled in.  
 .It Fn mparse_strerror  .It Fn mparse_strerror
 Return a statically-allocated string representation of an error code.  Return a statically-allocated string representation of an error code.
   Declared in
   .In mandoc.h ,
   implemented in
   .Pa read.c .
 .It Fn mparse_strlevel  .It Fn mparse_strlevel
 Return a statically-allocated string representation of a level code.  Return a statically-allocated string representation of a level code.
   Declared in
   .In mandoc.h ,
   implemented in
   .Pa read.c .
 .El  .El
 .Ss Variables  .Ss Variables
 .Bl -ohang  .Bl -ohang
Line 322  This section consists of structural documentation for
Line 456  This section consists of structural documentation for
 .Xr mdoc 7  .Xr mdoc 7
 and  and
 .Xr man 7  .Xr man 7
 syntax trees.  syntax trees and strings.
   .Ss Man and Mdoc Strings
   Strings may be extracted from mdoc and man meta-data, or from text
   nodes (MDOC_TEXT and MAN_TEXT, respectively).
   These strings have special non-printing formatting cues embedded in the
   text itself, as well as
   .Xr roff 7
   escapes preserved from input.
   Implementing systems will need to handle both situations to produce
   human-readable text.
   In general, strings may be assumed to consist of 7-bit ASCII characters.
   .Pp
   The following non-printing characters may be embedded in text strings:
   .Bl -tag -width Ds
   .It Dv ASCII_NBRSP
   A non-breaking space character.
   .It Dv ASCII_HYPH
   A soft hyphen.
   .It Dv ASCII_BREAK
   A breakable zero-width space.
   .El
   .Pp
   Escape characters are also passed verbatim into text strings.
   An escape character is a sequence of characters beginning with the
   backslash
   .Pq Sq \e .
   To construct human-readable text, these should be intercepted with
   .Xr mandoc_escape 3
   and converted with one the functions described in
   .Xr mchars_alloc 3 .
 .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 363  where capitalised non-terminals represent nodes.
Line 526  where capitalised non-terminals represent nodes.
 .It ELEMENT  .It ELEMENT
 \(<- ELEMENT | TEXT*  \(<- ELEMENT | TEXT*
 .It TEXT  .It TEXT
 \(<- [[:alpha:]]*  \(<- [[:ascii:]]*
 .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 394  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 422  where capitalised non-terminals represent nodes.
Line 585  where capitalised non-terminals represent nodes.
 .It TAIL  .It TAIL
 \(<- mnode*  \(<- mnode*
 .It TEXT  .It TEXT
 \(<- [[:printable:],0x1e]*  \(<- [[:ascii:]]*
 .El  .El
 .Pp  .Pp
 Of note are the TEXT nodes following the HEAD, BODY and TAIL nodes of  Of note are the TEXT nodes following the HEAD, BODY and TAIL nodes of
Line 503  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 ,
Line 517  levels of badly-nested blocks.
Line 683  levels of badly-nested blocks.
 The  The
 .Nm  .Nm
 library was written by  library was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .  .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .

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

CVSweb