Read Me

--------------------------------------------------------
webnotify v1.0
by Jean F. Mouzinho
--------------------------------------------------------

INTRO
-----
webnotify is meant to check web site updates, when
some happens and webnotify catchs it, webnotify
then executes the command selected for that specific
web site. It supports secured web sites (HTTPS) and
now you can filter out some text before the integrity
check is done, this way you might remove dynamic text
that is generated on each page access.

OBS: prepost feature is not available yet...!

REQUIREMENTS
------------
Requires OpenSSL (tested with OpenSSL 0.9.7f).

COMPILATION
-----------
No configuration scripts are used, simply run 'make' to
compile webnotify. Remember that openssl library is
required (ssl-lib).

INSTALL
-------
After a successful compilation you can run the webnotify
binary directly, it is not copied to anywere nor any
other files are created outside the compilation folder.

Remember that webnotify uses a config file (webnotify.conf)

Simply use the webnotify binary as you wish, remember
that it saves websites in webnotify.conf (config file),
since version 1.0.1beta it looks for config file in the
following order: --config command, /etc/webnotify.conf
and at last, the current folder.

USAGE
-----
First you add the sites, watch out where you run the binary,
for the first site added it will create the config file (if
its not there already). After the sites are added (they are
toggled on by default), you can make webnotify check them
by using checkup command. If any change is detected, webnotify
will execute the string set on the updated web site entry.

THINGS YOU MIGHT WANT TO KNOW
-----------------------------

Does it support https?
 - yes, e.g. https://secured_site.com

Does it support username:pass?
 - not yet, maybe on later version.

How it checks for update?
 - You have two options: integrity check (trough CRC32)
 and trough Last-Modified header from an HEAD request.
 This will be asked when you add the website entry.

Whats that --toggle command?
 - It toggles the specific website active or inactive
 depending on its current state. webnotify uses this
 state when --checkup (-c) command is applied without
 any website specified, that means, when you make
 webnotify check all sites in its list, it just checks
 those that are in active state.

How the filter works?
 - The filter string will be applied trought all the
 web page after its been downloaded and before the
 change check is done. The filter is a regular expression
 which matches are replaced with 'X' character.

Others:
 - webnotify has its own website list manager
 to add\rem\edit\toggle some site you should
 use webnotify commands from command line.

 - the first time a website is checked webnotify will
 not trigger, because no past state is known.

 - you can clear a last-change date of a website entry
 by using the commands: --edit <site name> --reset

 - using --edit action you might specify the new
 url, exec or filter by using --url, --execute and
 --filter command line arguments respectively.

 - if --interactive is used, webnotify will ask for
 the mandatory values when those are not passed trough
 the command line (eg. --url, --execute,...).

CONTACTS
--------

W-URL: http://webnotify.sourceforge.net
EMAIL: jean-francois.mouzinho@ist.utl.pt

COPYRIGHT/LICENSE
-----------------

Copyright (C) 2006 Jean Francois Mouzinho

This file is part of webnotify.

webnotify is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

webnotify 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with webnotify; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA