mandoc/mandoc_escape.3 - diff

Return to mandoc_escape.3 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/mandoc_escape.3 between version 1.1 and 1.4

version 1.1, 2014/08/05 05:48:56

version 1.4, 2017/07/04 23:40:01

Line 20

.Sh NAME

.Nm mandoc_escape

.Nd parse roff escape sequences

.Sh LIBRARY

.Lb libmandoc

.Sh SYNOPSIS

.In sys/types.h

.In mandoc.h

Line 119 in turn contain other escape sequences,

Line 117 in turn contain other escape sequences,

for error detection internally by the

.Xr roff 7

parser part of the

.Lb libmandoc ,

.Xr mandoc 3

see the file

library, see the file

.Pa roff.c ,

.It

above all externally by the

.Xr mandoc

.Xr mandoc 1

formatting modules, in particular

.Fl Tascii

and

Line 197 form, directly follows the initial backslash:

Line 195 form, directly follows the initial backslash:

Note that the one-character argument short form can only be used for

argument characters that do not clash with escape sequence identifiers.

.Pp

If the argument consists of more than one character

If the argument matches one of the forms described below under

and starts with the character

.Dv ESCAPE_UNICODE ,

.Sq u ,

that value is returned instead.

.Dv ESCAPE_UNICODE

is returned as described below.

If the argument is just the single character

.Sq u ,

.Dv ESCAPE_ERROR

is returned.

.Pp

The

.Dv ESCAPE_SPECIAL

Line 219 manual.

Line 211 manual.

.It Dv ESCAPE_UNICODE

Escape sequences of the same format as described above under

.Dv ESCAPE_SPECIAL ,

but with an argument starting with the character

but with an argument of the forms

.Sq u :

.Ic u Ns Ar XXXX ,

.Ic u Ns Ar YXXXX ,

.Ic u10 Ns Ar XXXX

where

.Ar X

and

.Ar Y

are hexadecimal digits and

.Ar Y

is not zero:

.Ic \eC'u , \e[u .

As a special exception,

.Fa start

is set to the character after the

.Sq u ,

.Ic u ,

and the

.Fa sz

return value does not include the

.Sq u

.Ic u

either.

.Pp

Such Unicode character escape sequences can be rendered using the function

Line 252 Such ASCII character escape sequences can be rendered

Line 254 Such ASCII character escape sequences can be rendered

described in the

.Xr mchars_alloc 3

manual.

.It Dv ESCAPE_OVERSTRIKE

The escape sequence

.Ic \eo

followed by an argument delimited by an arbitrary character.

.It Dv ESCAPE_IGNORE

.Bl -bullet -width 2n

.It

Line 284 The escape sequences

Line 290 The escape sequences

.Ic \eA ,

.Ic \eb ,

.Ic \eD ,

.Ic \eo ,

.Ic \eR ,

.Ic \eX ,

and

CVSweb