summaryrefslogtreecommitdiffstats
path: root/doc/tell.n
diff options
context:
space:
mode:
authorstanton <stanton>1999-05-05 01:19:42 (GMT)
committerstanton <stanton>1999-05-05 01:19:42 (GMT)
commit1c648c91432e154da4099cf32a8e87f0a24d50d9 (patch)
tree35cd0c32f8026eb26a294aaedb67557a438f47b8 /doc/tell.n
parentf080563e1ce42aff0aa7cdcfc64a5d6da7286abc (diff)
downloadtcl-1c648c91432e154da4099cf32a8e87f0a24d50d9.zip
tcl-1c648c91432e154da4099cf32a8e87f0a24d50d9.tar.gz
tcl-1c648c91432e154da4099cf32a8e87f0a24d50d9.tar.bz2
lint and better documentation of the character vs. byte oriented commands
Diffstat (limited to 'doc/tell.n')
-rw-r--r--doc/tell.n12
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/tell.n b/doc/tell.n
index fbbef62..15079c3 100644
--- a/doc/tell.n
+++ b/doc/tell.n
@@ -5,10 +5,10 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: tell.n,v 1.2 1998/09/14 18:39:55 stanton Exp $
+'\" RCS: @(#) $Id: tell.n,v 1.3 1999/05/05 01:19:43 stanton Exp $
'\"
.so man.macros
-.TH tell n 7.5 Tcl "Tcl Built-In Commands"
+.TH tell n 8.1 Tcl "Tcl Built-In Commands"
.BS
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
@@ -19,8 +19,12 @@ tell \- Return current access position for an open channel
.SH DESCRIPTION
.PP
-Returns a decimal string giving the current access position in
-\fIchannelId\fR.
+.VS 8.1
+Returns an integer string giving the current access position in
+\fIchannelId\fR. This value returned is a byte offset that can be passed to
+\fBseek\fR in order to set the channel to a particular position. Note
+that this value is in terms of bytes, not characters like \fBread\fR.
+.VE 8.1
The value returned is -1 for channels that do not support
seeking.