diff options
author | Ludovic Courtès <ludo@gnu.org> | 2014-12-03 19:07:28 +0100 |
---|---|---|
committer | Ludovic Courtès <ludo@gnu.org> | 2014-12-03 19:07:28 +0100 |
commit | 680135b6a363fddfe331e749f2bb3fdb44c76524 (patch) | |
tree | 0bea58556e560bb9577ca5b7231488bfafee76ea /doc/ref/api-io.texi | |
parent | 5fac1a7ada362d78f13143acbc0ceca7f2f101de (diff) | |
download | guile-680135b6a363fddfe331e749f2bb3fdb44c76524.tar.gz |
doc: Clarify the unit of the 'offset' argument of 'seek'.
Reported in <http://bugs.gnu.org/18520>
by David Kastrup <dak@gnu.org>.
* doc/ref/api-io.texi (Random Access): Clarify the unit of the 'offset'
argument to 'seek'.
Diffstat (limited to 'doc/ref/api-io.texi')
-rw-r--r-- | doc/ref/api-io.texi | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/ref/api-io.texi b/doc/ref/api-io.texi index 02d92a2d7..83313782f 100644 --- a/doc/ref/api-io.texi +++ b/doc/ref/api-io.texi @@ -443,8 +443,12 @@ open. @deffn {Scheme Procedure} seek fd_port offset whence @deffnx {C Function} scm_seek (fd_port, offset, whence) Sets the current position of @var{fd_port} to the integer -@var{offset}, which is interpreted according to the value of -@var{whence}. +@var{offset}. For a file port, @var{offset} is expressed +as a number of bytes; for other types of ports, such as string +ports, @var{offset} is an abstract representation of the +position within the port's data, not necessarily expressed +as a number of bytes. @var{offset} is interpreted according to +the value of @var{whence}. One of the following variables should be supplied for @var{whence}: @@ -460,7 +464,7 @@ Seek from the end of the file. If @var{fd_port} is a file descriptor, the underlying system call is @code{lseek}. @var{port} may be a string port. -The value returned is the new position in the file. This means +The value returned is the new position in @var{fd_port}. This means that the current position of a port can be obtained using: @lisp (seek port 0 SEEK_CUR) |