.\" -*-nroff-*-
.TH fwatch 3 "3 February 2001" "Straylight/Edgeware" "mLib utilities library"
.SH NAME
fwatch \- watch a file for changes
.\" @fwatch_init
.\" @fwatch_initfd
.\" @fwatch_update
.\" @fwatch_updatefd
.SH SYNOPSIS
.nf
.B "#include <mLib/fwatch.h>"

.BI "void fwatch_init(fwatch *" f ", const char *" name );
.BI "void fwatch_initfd(fwatch *" f ", int " fd );
.BI "int fwatch_update(fwatch *" f ", const char *" name );
.BI "int fwatch_updatefd(fwatch *" f ", int " fd );
.fi
.SH DESCRIPTION
These functions watch a file for changes.  Use
.B fwatch_init
or
.B fwatch_initfd
to initialize a
.B fwatch
block with information about a file; then later, the functions
.B fwatch_update
and
.B fwatch_updatefd
will update the information in the structure and inform you whether the
file changed.
.PP
The
.B fwatch
functions can't return errors: they remember errors as part of the file
state instead.  The
.B update
functions return zero if the file has not changed or nonzero if it has.
.SH SEE ALSO
.BR mLib (3).
.SH AUTHOR
Mark Wooding, <mdw@distorted.org.uk>