plan9port/man/man3/seek.3
Russ Cox 977b25a76a tmac: introduce real manual reference macro instead of overloading IR
The overloading of IR emits magic \X'...' sequences that turn into HTML manual links.
But not all such IR invocations should be manual links;
those had to be written to avoid the IR macro before.
Worse, the \X'...' ending the IR causes troff to emit only a single space after a period.

Defining a new IM macro for manual references fixes both problems.

Fixes #441.
2020-08-13 23:43:43 -04:00

53 lines
806 B
Groff

.TH SEEK 3
.SH NAME
seek \- change file offset
.SH SYNOPSIS
.B #include <u.h>
.br
.B #include <libc.h>
.PP
.B
vlong seek(int fd, vlong n, int type)
.SH DESCRIPTION
.I Seek
sets the offset for the file
associated with
.I fd
as follows:
.IP
If
.I type
is 0, the offset is set to
.I n
bytes.
.IP
If
.I type
is 1, the pointer is set to its current location plus
.IR n .
.IP
If
.I type
is 2, the pointer is set to the size of the
file plus
.IR n .
.PP
The new file offset value is returned.
.PP
Seeking in a directory is not allowed.
Seeking in a pipe is a no-op.
.SH SOURCE
.B \*9/src/lib9/seek.c
.SH SEE ALSO
.IM intro (3) ,
.IM open (3)
.SH DIAGNOSTICS
Sets
.IR errstr .
.SH BUGS
To avoid name conflicts with the underlying system,
.I seek
is a preprocessor macro defined as
.IR p9seek ;
see
.IM intro (3) .