mandoc/mandoc.3 - diff

Return to mandoc.3 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc.3 between version 1.37 and 1.40

version 1.37, 2016/07/07 19:19:01

version 1.40, 2017/06/24 14:38:32

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 34

.Nm mparse_reset ,

.Nm mparse_result ,

.Nm mparse_strerror ,

.Nm mparse_strlevel

.Nm mparse_strlevel ,

.Nm mparse_updaterc

.Nd mandoc macro compiler library

.Sh SYNOPSIS

.In sys/types.h

Line 46

Line 47

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

Line 102

.Fo mparse_strlevel

.Fa "enum mandoclevel"

.Fc

.Ft void

.Fo mparse_updaterc

.Fa "struct mparse *parse"

.Fa "enum mandoclevel *rc"

.Fc

.In roff.h

.Ft void

.Fo deroff

Line 181 or

Line 188 or

.Fn man_validate ,

respectively;

.It

if information about the validity of the input is needed, fetch it with

.Fn mparse_updaterc ;

.It

iterate over parse nodes with starting from the

.Fa first

member of the returned

Line 295 This is for example useful in

Line 305 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 310 for an example.

Line 323 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 416 Declared in

Line 438 Declared in

.In mandoc.h ,

implemented in

.Pa read.c .

.It Fn mparse_updaterc

If the highest warning or error level that occurred during the current

.Fa parse

is higher than

.Pf * Fa rc ,

update

.Pf * Fa rc

accordingly.

This is useful after calling

.Fn mdoc_validate

.Fn man_validate .

Declared in

.In mandoc.h ,

implemented in

.Pa read.c .

.El

.Ss Variables

.Bl -ohang

Line 625 TEXT end

Line 663 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 644 Using badly-nested blocks is

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