.\" -*-nroff-*-
.\"
.\" Manual for watching for file changes
.\"
.\" (c) 2001, 2005, 2009, 2023, 2024 Straylight/Edgeware
.\"
.
.\"----- Licensing notice ---------------------------------------------------
.\"
.\" This file is part of the mLib utilities library.
.\"
.\" mLib is free software: you can redistribute it and/or modify it under
.\" the terms of the GNU Library General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or (at
.\" your option) any later version.
.\"
.\" mLib is distributed in the hope that it will be useful, but WITHOUT
.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
.\" FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
.\" License for more details.
.\"
.\" You should have received a copy of the GNU Library General Public
.\" License along with mLib.  If not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
.\" USA.
.
.\"--------------------------------------------------------------------------
.so ../defs.man \" @@@PRE@@@
.
.\"--------------------------------------------------------------------------
.TH fwatch 3mLib "3 February 2001" "Straylight/Edgeware" "mLib utilities library"
.\" @fwatch_init
.\" @fwatch_initfd
.\" @fwatch_update
.\" @fwatch_updatefd
.
.\"--------------------------------------------------------------------------
.SH NAME
fwatch \- watch a file for changes
.
.\"--------------------------------------------------------------------------
.SH SYNOPSIS
.
.nf
.B "#include <mLib/fwatch.h>"
.PP
.B "typedef struct { ...\& } fwatch;"
.PP
.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>
.
.\"----- That's all, folks --------------------------------------------------