mandoc/mandoc.3 - diff

Return to mandoc.3 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.3 between version 1.38 and 1.42

version 1.38, 2017/01/09 01:37:03

version 1.42, 2018/08/23 19:33:27

Line 22

.Nm mandoc ,

.Nm deroff ,

.Nm mandocmsg ,

.Nm man_mparse ,

.Nm man_validate ,

.Nm mdoc_validate ,

.Nm mparse_alloc ,

.Nm mparse_copy ,

.Nm mparse_free ,

.Nm mparse_getkeep ,

.Nm mparse_keep ,

.Nm mparse_open ,

.Nm mparse_readfd ,

.Nm mparse_reset ,

.Nm mparse_result ,

.Nm mparse_strerror ,

.Nm mparse_strlevel ,

.Nm mparse_updaterc

.Nd mandoc macro compiler library

.Sh SYNOPSIS

.In sys/types.h

Line 47

Line 45

.Ft struct mparse *

.Fo mparse_alloc

.Fa "int options"

.Fa "enum mandoclevel wlevel"

.Fa "enum mandocerr mmin"

.Fa "mandocmsg mmsg"

.Fa "char *defos"

.Fa "enum mandoc_os oe_e"

.Fa "char *os_s"

.Fc

.Ft void

.Fo (*mandocmsg)

Line 64

Line 63

.Fo mparse_free

.Fa "struct mparse *parse"

.Fc

.Ft const char *

.Ft void

.Fo mparse_getkeep

.Fo mparse_copy

.Fa "const struct mparse *parse"

.Fc

.Ft void

.Fo mparse_keep

.Fa "struct mparse *parse"

.Fc

.Ft int

.Fo mparse_open

.Fa "struct mparse *parse"

Line 125

Line 120

.In mandoc.h

.In man.h

.Vt extern const char * const * man_macronames;

.Ft "const struct mparse *"

.Fo man_mparse

.Fa "const struct roff_man *man"

.Fc

.Ft void

.Fo man_validate

.Fa "struct roff_man *man"

Line 249 When it is no longer needed, the pointer returned from

Line 240 When it is no longer needed, the pointer returned from

.Fn deroff

can be passed to

.Xr free 3 .

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

Validate the

.Dv MACROSET_MAN

Line 304 This is for example useful in

Line 289 This is for example useful in

.Xr makewhatis 8

.Fl Q

to quickly build minimal databases.

.It Ar wlevel

.It Ar mmin

Can be set to

.Dv MANDOCLEVEL_BADARG ,

.Dv MANDOCERR_BASE ,

.Dv MANDOCLEVEL_ERROR ,

.Dv MANDOCERR_STYLE ,

.Dv MANDOCERR_WARNING ,

.Dv MANDOCERR_ERROR ,

.Dv MANDOCERR_UNSUPP ,

.Dv MANDOCLEVEL_WARNING .

.Dv MANDOCERR_MAX .

Messages below the selected level will be suppressed.

.It Ar mmsg

A callback function to handle errors and warnings.

Line 319 for an example.

Line 307 for an example.

If printing of error messages is not desired,

.Dv NULL

may be passed.

.It Ar defos

.It Ar os_e

Operating system to check base system conventions for.

.Dv MANDOC_OS_OTHER ,

the system is automatically detected from

.Ic \&Os ,

.Fl Ios ,

.Xr uname 3 .

.It Ar os_s

A default string for the

.Xr mdoc 7

.Sq \&Os

.Ic \&Os

macro, overriding the

.Dv OSNAME

preprocessor definition and the results of

Line 348 Declared in

Line 345 Declared in

.In mandoc.h ,

implemented in

.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

.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

Line 650 TEXT end

Line 637 TEXT end

.Ed

.Pp

Here, the formatting of the

.Sq \&Ao

.Ic \&Ao

block extends from TEXT ao to TEXT ac,

while the formatting of the

.Sq \&Bo

.Ic \&Bo

block extends from TEXT bo to TEXT bc.

It renders as follows in

.Fl T Ns Cm ascii

Line 669 Using badly-nested blocks is

Line 656 Using badly-nested blocks is

.Em strongly discouraged ;

for example, the

.Fl T Ns Cm html

and

front-end to

.Fl T Ns Cm xhtml

front-ends to

.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

consistent across troff implementations, especially when using multiple

levels of badly-nested blocks.

CVSweb