summaryrefslogtreecommitdiffstats
path: root/doc/RecordEval.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2004-09-18 17:01:02 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2004-09-18 17:01:02 (GMT)
commit5e5bcd132f05719b0bd2dbd8449cc26b325ef811 (patch)
treed0721a6b5b5206782155cb04dd3b28fd41bd8564 /doc/RecordEval.3
parent5c5d25ff6d6cf79ce06105cd339492f10e32aa82 (diff)
downloadtcl-5e5bcd132f05719b0bd2dbd8449cc26b325ef811.zip
tcl-5e5bcd132f05719b0bd2dbd8449cc26b325ef811.tar.gz
tcl-5e5bcd132f05719b0bd2dbd8449cc26b325ef811.tar.bz2
More fixes from Mikhail Kolesnitchenko, and also standardize highlighting
of symbols like TCL_OK, TCL_ERROR, etc.
Diffstat (limited to 'doc/RecordEval.3')
-rw-r--r--doc/RecordEval.312
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/RecordEval.3 b/doc/RecordEval.3
index ebc726c..6301a82 100644
--- a/doc/RecordEval.3
+++ b/doc/RecordEval.3
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: RecordEval.3,v 1.4 2002/01/16 06:02:33 dgp Exp $
+'\" RCS: @(#) $Id: RecordEval.3,v 1.5 2004/09/18 17:01:06 dkf Exp $
'\"
.so man.macros
.TH Tcl_RecordAndEval 3 7.4 Tcl "Tcl Library Procedures"
@@ -25,8 +25,8 @@ Tcl interpreter in which to evaluate command.
.AP "CONST char" *cmd in
Command (or sequence of commands) to execute.
.AP int flags in
-An OR'ed combination of flag bits. TCL_NO_EVAL means record the
-command but don't evaluate it. TCL_EVAL_GLOBAL means evaluate
+An OR'ed combination of flag bits. \fBTCL_NO_EVAL\fR means record the
+command but don't evaluate it. \fBTCL_EVAL_GLOBAL\fR means evaluate
the command at global level instead of the current stack level.
.BE
@@ -34,15 +34,15 @@ the command at global level instead of the current stack level.
.PP
\fBTcl_RecordAndEval\fR is invoked to record a command as an event
on the history list and then execute it using \fBTcl_Eval\fR
-(or \fBTcl_GlobalEval\fR if the TCL_EVAL_GLOBAL bit is set in \fIflags\fR).
-It returns a completion code such as TCL_OK just like \fBTcl_Eval\fR
+(or \fBTcl_GlobalEval\fR if the \fBTCL_EVAL_GLOBAL\fR bit is set in \fIflags\fR).
+It returns a completion code such as \fBTCL_OK\fR just like \fBTcl_Eval\fR
and it leaves information in the interpreter's result.
If you don't want the command recorded on the history list then
you should invoke \fBTcl_Eval\fR instead of \fBTcl_RecordAndEval\fR.
Normally \fBTcl_RecordAndEval\fR is only called with top-level
commands typed by the user, since the purpose of history is to
allow the user to re-issue recently-invoked commands.
-If the \fIflags\fR argument contains the TCL_NO_EVAL bit then
+If the \fIflags\fR argument contains the \fBTCL_NO_EVAL\fR bit then
the command is recorded without being evaluated.
.PP
Note that \fBTcl_RecordAndEval\fR has been largely replaced by the