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

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

version 1.1, 2011/03/22 10:02:50 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_meta ,  .Nm deroff ,
 .Nm man_node ,  
 .Nm mdoc_meta ,  
 .Nm mdoc_node ,  
 .Nm mparse_alloc ,  .Nm mparse_alloc ,
   .Nm mparse_copy ,
 .Nm mparse_free ,  .Nm mparse_free ,
   .Nm mparse_open ,
 .Nm mparse_readfd ,  .Nm mparse_readfd ,
 .Nm mparse_reset ,  .Nm mparse_reset ,
 .Nm mparse_result  .Nm mparse_result
 .Nd mandoc macro compiler library  .Nd mandoc macro compiler library
 .Sh SYNOPSIS  .Sh SYNOPSIS
 .In man.h  .In sys/types.h
 .In mdoc.h  .In stdio.h
 .In mandoc.h  .In mandoc.h
 .Ft "const struct man_meta *"  .Pp
 .Fo man_meta  .Fd "#define ASCII_NBRSP"
 .Fa "const struct man *man"  .Fd "#define ASCII_HYPH"
 .Fc  .Fd "#define ASCII_BREAK"
 .Ft "const struct man_node *"  .Ft struct mparse *
 .Fo man_node  
 .Fa "const struct man *man"  
 .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  
 .Fo mparse_alloc  .Fo mparse_alloc
 .Fa "enum mparset type"  .Fa "int options"
 .Fa "enum mandoclevel wlevel"  .Fa "enum mandoc_os oe_e"
 .Fa "mandocmsg msg"  .Fa "char *os_s"
 .Fa "void *msgarg"  
 .Fc  .Fc
 .Ft void  .Ft void
 .Fo mparse_free  .Fo mparse_free
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fc  .Fc
 .Ft "enum mandoclevel"  .Ft void
   .Fo mparse_copy
   .Fa "const struct mparse *parse"
   .Fc
   .Ft int
   .Fo mparse_open
   .Fa "struct mparse *parse"
   .Fa "const char *fname"
   .Fc
   .Ft void
 .Fo mparse_readfd  .Fo mparse_readfd
 .Fa "struct mparse *parse"  .Fa "struct mparse *parse"
 .Fa "int fd"  .Fa "int fd"
Line 71 
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"  
 .Fc  .Fc
 .Vt extern const char * const * man_macronames;  .In roff.h
   .Ft void
   .Fo deroff
   .Fa "char **dest"
   .Fa "const struct roff_node *node"
   .Fc
   .In sys/types.h
   .In mandoc.h
   .In mdoc.h
 .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 man.h
   .Vt extern const char * const * man_macronames;
 .Sh DESCRIPTION  .Sh DESCRIPTION
 The  The
 .Nm mandoc  .Nm mandoc
Line 102  The following describes a general parse sequence:
Line 107  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  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
   .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
   This section documents the functions, types, and variables available
   via
   .In mandoc.h ,
   with the exception of those documented in
   .Xr mandoc_escape 3
   and
   .Xr mchars_alloc 3 .
   .Ss Types
   .Bl -ohang
   .It Vt "enum mandocerr"
   An error or warning message during parsing.
   .It Vt "enum mandoclevel"
   A classification of an
   .Vt "enum mandocerr"
   as regards system operation.
   See the DIAGNOSTICS section in
   .Xr mandoc 1
   regarding the meanings of the levels.
   .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.
   .El
   .Ss Functions
   .Bl -ohang
   .It Fn deroff
   Obtain a text-only representation of a
   .Vt struct roff_node ,
   including text contained in its child nodes.
   To be used on children of the
   .Fa first
   member of
   .Vt struct roff_meta .
   When it is no longer needed, the pointer returned from
   .Fn deroff
   can be passed to
   .Xr free 3 .
   .It Fn mparse_alloc
   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
   field of
   .Vt struct roff_meta .
   .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.
   .Pp
   When the
   .Dv MARSE_VALIDATE
   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
   .Xr uname 3 .
   .It Ar os_s
   A default string for the
   .Xr mdoc 7
   .Ic \&Os
   macro, overriding the
   .Dv OSNAME
   preprocessor definition and the results of
   .Xr uname 3 .
   Passing
   .Dv NULL
   sets no default.
   .El
   .Pp
   The same parser may be used for multiple files so long as
   .Fn mparse_reset
   is called between parses.
   .Fn mparse_free
   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
   Free all memory allocated by
   .Fn mparse_alloc .
   Declared in
   .In mandoc.h ,
   implemented in
   .Pa read.c .
   .It Fn mparse_copy
   Dump a copy of the input to the standard output; used for
   .Fl man T Ns Cm man .
   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
   Parse a file descriptor opened with
   .Xr open 2
   or
   .Fn mparse_open .
   Pass the associated filename in
   .Va fname .
   This function may be called multiple times with different parameters; however,
   .Xr close 2
   and
   .Fn mparse_reset
   should be invoked between parses.
   Declared in
   .In mandoc.h ,
   implemented in
   .Pa read.c .
   .It Fn mparse_reset
   Reset a parser so that
   .Fn mparse_readfd
   may be used again.
   Declared in
   .In mandoc.h ,
   implemented in
   .Pa read.c .
   .It Fn mparse_result
   Obtain the result of a parse.
   Declared in
   .In mandoc.h ,
   implemented in
   .Pa read.c .
   .El
   .Ss Variables
   .Bl -ohang
   .It Va man_macronames
   The string representation of a
   .Xr man 7
   macro as indexed by
   .Vt "enum mant" .
   .It Va mdoc_argnames
   The string representation of an
   .Xr mdoc 7
   macro argument as indexed by
   .Vt "enum mdocargt" .
   .It Va mdoc_macronames
   The string representation of an
   .Xr mdoc 7
   macro as indexed by
   .Vt "enum mdoct" .
   .El
 .Sh IMPLEMENTATION NOTES  .Sh IMPLEMENTATION NOTES
 This section consists of structural documentation for  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
 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 167  where capitalised non-terminals represent nodes.
Line 409  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 185  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 226  where capitalised non-terminals represent nodes.
Line 468  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 241  where a new body introduces a new phrase.
Line 483  where a new body introduces a new phrase.
 .Pp  .Pp
 The  The
 .Xr mdoc 7  .Xr mdoc 7
 syntax tree accomodates for broken block structures as well.  syntax tree accommodates for broken block structures as well.
 The ENDBODY node is available to end the formatting associated  The ENDBODY node is available to end the formatting associated
 with a given block before the physical end of that block.  with a given block before the physical end of that block.
 It has a non-null  It has a non-null
Line 282  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 301  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_headers 3 ,
   .Xr mandoc_malloc 3 ,
   .Xr mansearch 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 mdoc 7 ,  .Xr mdoc 7 ,
 .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 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.1  
changed lines
  Added in v.1.44

CVSweb