support more than one tag entry for the same search term;

[mandoc.git] / mandoc_escape.3

diff --git a/mandoc_escape.3 b/mandoc_escape.3
index 84243fdeb6ebf2bb90b70247a6ecc82b2e9d1cd7..fec298b87a04e299ad0aaad88ef053d6190e6477 100644 (file)
--- a/mandoc_escape.3
+++ b/mandoc_escape.3
@@ -1,4 +1,4 @@
-.\"    $Id: mandoc_escape.3,v 1.1 2014/08/05 05:48:56 schwarze Exp $
+.\"    $Id: mandoc_escape.3,v 1.3 2015/01/21 20:33:25 schwarze Exp $

 .\"
 .\" Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
 .\"
 .\"
 .\" Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
 .\"


@@ -14,14 +14,12 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: August 5 2014 $
+.Dd $Mdocdate: January 21 2015 $

 .Dt MANDOC_ESCAPE 3
 .Os
 .Sh NAME
 .Nm mandoc_escape
 .Nd parse roff escape sequences
 .Dt MANDOC_ESCAPE 3
 .Os
 .Sh NAME
 .Nm mandoc_escape
 .Nd parse roff escape sequences

-.Sh LIBRARY
-.Lb libmandoc

 .Sh SYNOPSIS
 .In sys/types.h
 .In mandoc.h
 .Sh SYNOPSIS
 .In sys/types.h
 .In mandoc.h


@@ -119,8 +117,8 @@ in turn contain other escape sequences,
 for error detection internally by the
 .Xr roff 7
 parser part of the
 for error detection internally by the
 .Xr roff 7
 parser part of the

-.Lb libmandoc ,
-see the file
+.Xr mandoc 3
+library, see the file

 .Pa roff.c ,
 .It
 above all externally by the
 .Pa roff.c ,
 .It
 above all externally by the


@@ -197,15 +195,9 @@ 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
 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
-and starts with the character
-.Sq u ,
-.Dv ESCAPE_UNICODE
-is returned as described below.
-If the argument is just the single character
-.Sq u ,
-.Dv ESCAPE_ERROR
-is returned.
+If the argument matches one of the forms described below under
+.Dv ESCAPE_UNICODE ,
+that value is returned instead.

 .Pp
 The
 .Dv ESCAPE_SPECIAL
 .Pp
 The
 .Dv ESCAPE_SPECIAL


@@ -219,17 +211,27 @@ manual.
 .It Dv ESCAPE_UNICODE
 Escape sequences of the same format as described above under
 .Dv ESCAPE_SPECIAL ,
 .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
-.Sq u :
+but with an argument of the forms
+.Ic u Ns Ar XXXX ,
+.Ic u Ns Ar YXXXX ,
+or
+.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
 .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
 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
 either.
 .Pp
 Such Unicode character escape sequences can be rendered using the function


@@ -252,6 +254,10 @@ Such ASCII character escape sequences can be rendered using the function
 described in the
 .Xr mchars_alloc 3
 manual.
 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
 .It Dv ESCAPE_IGNORE
 .Bl -bullet -width 2n
 .It


@@ -284,7 +290,6 @@ The escape sequences
 .Ic \eA ,
 .Ic \eb ,
 .Ic \eD ,
 .Ic \eA ,
 .Ic \eb ,
 .Ic \eD ,

-.Ic \eo ,

 .Ic \eR ,
 .Ic \eX ,
 and
 .Ic \eR ,
 .Ic \eX ,
 and