mandoc/mandoc.3 - diff

Return to mandoc.3 CVS log

Up to [cvsweb.bsd.lv] / mandoc

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

version 1.31, 2015/01/15 04:26:40

version 1.36, 2016/01/08 17:48:09

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 37

.Nm mparse_result ,

.Nm mparse_strerror ,

.Nm mparse_strlevel

.Nm mparse_wait ,

.Nd mandoc macro compiler library

.Sh SYNOPSIS

.In sys/types.h

Line 51

Line 50

.Fa "int options"

.Fa "enum mandoclevel wlevel"

.Fa "mandocmsg mmsg"

.Fa "const struct mchars *mchars"

.Fa "char *defos"

.Fc

.Ft void

Line 75

Line 73

.Fo mparse_keep

.Fa "struct mparse *parse"

.Fc

.Ft "enum mandoclevel"

.Ft int

.Fo mparse_open

.Fa "struct mparse *parse"

.Fa "int *fd"

.Fa "const char *fname"

.Fc

.Ft "enum mandoclevel"

Line 106

Line 103

.Fo mparse_strlevel

.Fa "enum mandoclevel"

.Fc

.Ft "enum mandoclevel"

.Fo mparse_wait

.Fa "struct mparse *parse"

.Fc

.In sys/types.h

.In mandoc.h

.In mdoc.h

Line 183 or

Line 176 or

parse it with

.Fn mparse_readfd ;

.It

close it with

.Xr close 2 ;

.It

retrieve the syntax tree with

.Fn mparse_result ;

.It

Line 215 An error or warning message during parsing.

Line 211 An error or warning message during parsing.

A classification of an

.Vt "enum mandocerr"

as regards system operation.

.It Vt "struct mchars"

An opaque pointer to a a character table.

Created with

.Xr mchars_alloc 3

and freed with

.Xr mchars_free 3 .

.It Vt "struct mparse"

An opaque pointer to a running parse sequence.

Created with

Line 345 A callback function to handle errors and warnings.

Line 335 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

.Xr mdoc 7

Line 392 Declared in

Line 379 Declared in

implemented in

.Pa read.c .

.It Fn mparse_open

If the

Open the file for reading.

If that fails and

.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.

.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

.Fn mparse_readfd

or used directly.

Line 423 or

Line 402 or

.Fn mparse_open .

Pass the associated filename in

.Va fname .

Calls

.Fn mparse_wait

before returning.

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

Line 460 Declared in

Line 438 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

.Ss Variables

.Bl -ohang

Line 601 and

Line 557 and

fields), its position in the tree (the

.Va parent ,

.Va child ,

.Va nchild ,

.Va last ,

.Va next

and

.Va prev

CVSweb