summaryrefslogtreecommitdiffstats
path: root/doc/rename.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/rename.n')
-rw-r--r--doc/rename.n16
1 files changed, 15 insertions, 1 deletions
diff --git a/doc/rename.n b/doc/rename.n
index 2630ad4..96e0507 100644
--- a/doc/rename.n
+++ b/doc/rename.n
@@ -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: rename.n,v 1.3 2000/09/07 14:27:51 poenitz Exp $
+'\" RCS: @(#) $Id: rename.n,v 1.4 2004/04/30 20:25:26 dkf Exp $
'\"
.so man.macros
.TH rename n "" Tcl "Tcl Built-In Commands"
@@ -27,6 +27,20 @@ If \fInewName\fR is an empty string then \fIoldName\fR is deleted.
If a command is renamed into a different namespace,
future invocations of it will execute in the new namespace.
The \fBrename\fR command returns an empty string as result.
+.SH EXAMPLE
+The \fBrename\fR command can be used to wrap the standard Tcl commands
+with your own monitoring machinery. For example, you might wish to
+count how often the \fBsource\fR command is called:
+
+.CS
+rename ::source ::theRealSource
+set sourceCount 0
+proc ::source args {
+ global sourceCount
+ puts "called source for the [incr sourceCount]'th time"
+ uplevel 1 ::theRealSource $args
+}
+.CE
.SH "SEE ALSO"
namespace(n), proc(n)