diff options
| author | rjohnson <rjohnson> | 1998-03-26 14:45:59 (GMT) |
|---|---|---|
| committer | rjohnson <rjohnson> | 1998-03-26 14:45:59 (GMT) |
| commit | 2b5738da524e944cda39e24c0a87b745a43bd8c3 (patch) | |
| tree | 6e8c9473978f6dab66c601e911721a7bd9d70b1b /doc/Backslash.3 | |
| parent | c6a259aeeca4814a97cf6694814c63e74e4e18fa (diff) | |
| download | tcl-2b5738da524e944cda39e24c0a87b745a43bd8c3.zip tcl-2b5738da524e944cda39e24c0a87b745a43bd8c3.tar.gz tcl-2b5738da524e944cda39e24c0a87b745a43bd8c3.tar.bz2 | |
Initial revision
Diffstat (limited to 'doc/Backslash.3')
| -rw-r--r-- | doc/Backslash.3 | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/Backslash.3 b/doc/Backslash.3 new file mode 100644 index 0000000..e7ac1f7 --- /dev/null +++ b/doc/Backslash.3 @@ -0,0 +1,45 @@ +'\" +'\" Copyright (c) 1989-1993 The Regents of the University of California. +'\" Copyright (c) 1994-1996 Sun Microsystems, Inc. +'\" +'\" 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 +'\" +.so man.macros +.TH Tcl_Backslash 3 "" Tcl "Tcl Library Procedures" +.BS +.SH NAME +Tcl_Backslash \- parse a backslash sequence +.SH SYNOPSIS +.nf +\fB#include <tcl.h>\fR +.sp +char +\fBTcl_Backslash\fR(\fIsrc, countPtr\fR) +.SH ARGUMENTS +.AS char *countPtr +.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 +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. +.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. + +.SH KEYWORDS +backslash, parse |