tcl/doc/tell.n

   1 '\"
   2 '\" Copyright (c) 1993 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 '\" RCS: @(#) $Id$
   9 '\"
  10 .so man.macros
  11 .TH tell n 8.1 Tcl "Tcl Built-In Commands"
  12 .BS
  13 '\" Note:  do not modify the .SH NAME line immediately below!
  14 .SH NAME
  15 tell \- Return current access position for an open channel
  16 .SH SYNOPSIS
  17 \fBtell \fIchannelId\fR
  18 .BE
  19
  20 .SH DESCRIPTION
  21 .PP
  22 .VS 8.1
  23 Returns an integer string giving the current access position in
  24 \fIchannelId\fR.  This value returned is a byte offset that can be passed to
  25 \fBseek\fR in order to set the channel to a particular position.  Note
  26 that this value is in terms of bytes, not characters like \fBread\fR.
  27 .VE 8.1
  28 The value returned is -1 for channels that do not support
  29 seeking.
  30
  31 .SH KEYWORDS
  32 access position, channel, seeking