relmon
======

Description
-----------

relmon is a utility for monitoring websites of software projects for new
releases. It crawls websites efficiently via HTTP or HTTPS using a configurable
number of simultaneous connections and can parse HTML and XHTML documents as
well as RSS 2.0 and Atom feeds. Software releases are detected by extracting
the version numbers of links to distribution files from the parsed documents or
feeds. In addition to the version numbers, the history of releases consisting
of the times new release were initially discovered, any encountered errors and
the time this information was last updated are recorded.

The recorded information on each software project can be output in several
different formats, including formatted text, machine-parseable text, and HTML,
optionally with the history of releases in Atom feed fromat.

Build Instructions
------------------

relmon requires Tcl 8.5 or later, tcllib, tls, and tdom and has been tested to
work on Linux distributions and FreeBSD.  The following tools are required to
build relmon:

- GNU make >= 3.81
- GNU or BSD install

Rebuilding the man pages additionally requires the xsltproc tool from libxml2.

Before building relmon check the commented macros in the Makefile for any
macros you may need to override depending on the used tools and operating
system.

By default, all files will be installed under the "/usr/local" directory, a
different installation path prefix can be set via the `prefix` macro.  In
addition, a second path prefix can be specified via the `DESTDIR` macro which
will be prepended to any path, incuding the `prefix` macro path prefix.  In
contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
prepended to paths during installation and not be used for constructing
internal paths.

The following instructions assume that `make` is GNU make, on some platforms
it may be installed under a different name or a non-default path.  In order to
start the build process run `make all`.  After a successful build, run `make
install` to install the program, any associated data files and the
documentation.

Previously generated data files and documentation can be removed by running
`make clean`, any additional, generated files which are not removed by the
`clean` target can be removed by running `make clobber`.

Contact
-------

Please send any feedback, translations or bug reports via email to
<guido+relmon@berhoerster.name>.

Bug Reports
-----------

When sending bug reports, please always mention the exact version of relmon
with which the issue occurs as well as the version of Tcl and the operating
system you are using and make sure that you provide sufficient information to
reproduce the issue and include any input, output, any error messages.

In case of build issues, please also specify the implementations and versions
of the used tools.

In case of crashes, please include the stack trace that was generated by the
Tcl interpreter in the bug report.

License
-------

Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
distributed under the following license terms:

Copyright (C) 2014 Guido Berhoerster <guido+relmon@berhoerster.name>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.