diff options
Diffstat (limited to 'doc/Backslash.3')
| -rw-r--r-- | doc/Backslash.3 | 30 |
1 files changed, 16 insertions, 14 deletions
diff --git a/doc/Backslash.3 b/doc/Backslash.3 index e7ac1f7..f121c7c 100644 --- a/doc/Backslash.3 +++ b/doc/Backslash.3 @@ -5,10 +5,8 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" SCCS: @(#) Backslash.3 1.16 96/03/25 19:57:09 -'\" +.TH Tcl_Backslash 3 "8.1" Tcl "Tcl Library Procedures" .so man.macros -.TH Tcl_Backslash 3 "" Tcl "Tcl Library Procedures" .BS .SH NAME Tcl_Backslash \- parse a backslash sequence @@ -19,27 +17,31 @@ Tcl_Backslash \- parse a backslash sequence char \fBTcl_Backslash\fR(\fIsrc, countPtr\fR) .SH ARGUMENTS -.AS char *countPtr +.AS char *countPtr out .AP char *src in Pointer to a string starting with a backslash. .AP int *countPtr out -If \fIcountPtr\fR isn't NULL, \fI*countPtr\fR gets filled +If \fIcountPtr\fR is not NULL, \fI*countPtr\fR gets filled in with number of characters in the backslash sequence, including the backslash character. .BE .SH DESCRIPTION .PP -This is a utility procedure used by several of the Tcl -commands. It parses a backslash sequence and returns -the single character corresponding to the sequence. -\fBTcl_Backslash\fR modifies \fI*countPtr\fR to contain the number -of characters in the backslash sequence. +The use of \fBTcl_Backslash\fR is deprecated in favor of +\fBTcl_UtfBackslash\fR. +.PP +This is a utility procedure provided for backwards compatibility with +non-internationalized Tcl extensions. It parses a backslash sequence and +returns the low byte of the Unicode character corresponding to the sequence. +\fBTcl_Backslash\fR modifies \fI*countPtr\fR to contain the number of +characters in the backslash sequence. .PP -See the Tcl manual entry for information on the valid -backslash sequences. -All of the sequences described in the Tcl -manual entry are supported by \fBTcl_Backslash\fR. +See the Tcl manual entry for information on the valid backslash sequences. +All of the sequences described in the Tcl manual entry are supported by +\fBTcl_Backslash\fR. +.SH "SEE ALSO" +Tcl(n), Tcl_UtfBackslash(3) .SH KEYWORDS backslash, parse |