diff options
author | Andy Wingo <wingo@pobox.com> | 2015-01-22 13:32:59 +0100 |
---|---|---|
committer | Andy Wingo <wingo@pobox.com> | 2015-01-22 13:32:59 +0100 |
commit | 7c6ce75e2cc218e193b765149e619d1c9c69cbd6 (patch) | |
tree | e57fbbba1efe88d6b24aecf38b38790ca27fe089 /doc/ref/api-io.texi | |
parent | 12dfe6568c82ba0e55286d1b604044f948dd16f2 (diff) | |
parent | 7c433cbbce83bc9f2f9967afba00bbb68e312657 (diff) | |
download | guile-7c6ce75e2cc218e193b765149e619d1c9c69cbd6.tar.gz |
Merge commit '7c433cbbce83bc9f2f9967afba00bbb68e312657'
Conflicts:
meta/Makefile.am
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 8b44224dc..e1501e2b4 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) |