diff options
author | dgp <dgp@noemail.net> | 2007-10-29 17:17:52 (GMT) |
---|---|---|
committer | dgp <dgp@noemail.net> | 2007-10-29 17:17:52 (GMT) |
commit | bc58aee1f03f49f89abe553b07bf42ce55c0c000 (patch) | |
tree | ab3726bb47391ce353034c12918de3bc70c58058 /doc/RecordEval.3 | |
parent | c3f8e3b436921a25f4a37d1541a38349180ad8c5 (diff) | |
download | tcl-bc58aee1f03f49f89abe553b07bf42ce55c0c000.zip tcl-bc58aee1f03f49f89abe553b07bf42ce55c0c000.tar.gz tcl-bc58aee1f03f49f89abe553b07bf42ce55c0c000.tar.bz2 |
line endings
FossilOrigin-Name: 00992a0194213b50c082ba7f2626c7b4f8466a8f
Diffstat (limited to 'doc/RecordEval.3')
-rw-r--r-- | doc/RecordEval.3 | 114 |
1 files changed, 57 insertions, 57 deletions
diff --git a/doc/RecordEval.3 b/doc/RecordEval.3 index afea09d..1eae01e 100644 --- a/doc/RecordEval.3 +++ b/doc/RecordEval.3 @@ -1,57 +1,57 @@ -'\"
-'\" Copyright (c) 1989-1993 The Regents of the University of California.
-'\" Copyright (c) 1994-1997 Sun Microsystems, Inc.
-'\"
-'\" 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.8 2007/10/28 14:17:39 dkf Exp $
-'\"
-.so man.macros
-.TH Tcl_RecordAndEval 3 7.4 Tcl "Tcl Library Procedures"
-.BS
-.SH NAME
-Tcl_RecordAndEval \- save command on history list before evaluating
-.SH SYNOPSIS
-.nf
-\fB#include <tcl.h>\fR
-.sp
-int
-\fBTcl_RecordAndEval\fR(\fIinterp, cmd, flags\fR)
-.SH ARGUMENTS
-.AS Tcl_Interp *interp
-.AP Tcl_Interp *interp in
-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. \fBTCL_NO_EVAL\fR means record the
-command but do not evaluate it. \fBTCL_EVAL_GLOBAL\fR means evaluate
-the command at global level instead of the current stack level.
-.BE
-
-.SH DESCRIPTION
-.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 \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 do not 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 \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
-object-based procedure \fBTcl_RecordAndEvalObj\fR.
-That object-based procedure records and optionally executes
-a command held in a Tcl object instead of a string.
-
-.SH "SEE ALSO"
-Tcl_RecordAndEvalObj
-
-.SH KEYWORDS
-command, event, execute, history, interpreter, record
+'\" +'\" Copyright (c) 1989-1993 The Regents of the University of California. +'\" Copyright (c) 1994-1997 Sun Microsystems, Inc. +'\" +'\" 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.9 2007/10/29 17:17:54 dgp Exp $ +'\" +.so man.macros +.TH Tcl_RecordAndEval 3 7.4 Tcl "Tcl Library Procedures" +.BS +.SH NAME +Tcl_RecordAndEval \- save command on history list before evaluating +.SH SYNOPSIS +.nf +\fB#include <tcl.h>\fR +.sp +int +\fBTcl_RecordAndEval\fR(\fIinterp, cmd, flags\fR) +.SH ARGUMENTS +.AS Tcl_Interp *interp +.AP Tcl_Interp *interp in +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. \fBTCL_NO_EVAL\fR means record the +command but do not evaluate it. \fBTCL_EVAL_GLOBAL\fR means evaluate +the command at global level instead of the current stack level. +.BE + +.SH DESCRIPTION +.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 \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 do not 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 \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 +object-based procedure \fBTcl_RecordAndEvalObj\fR. +That object-based procedure records and optionally executes +a command held in a Tcl object instead of a string. + +.SH "SEE ALSO" +Tcl_RecordAndEvalObj + +.SH KEYWORDS +command, event, execute, history, interpreter, record |