Mercurial > projects > relmon

annotate README @ 4:f28486666a4f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add manpages for relmon and relmon_watchlist
author Guido Berhoerster <guido+relmon@berhoerster.name>
date Fri, 24 Oct 2014 22:44:39 +0200
parents 6d87242c537e
children a886a736c766
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
1 relmon
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
2 ======
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
3
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
4 Description
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
5 -----------
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
6
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
7 relmon is a utility for monitoring websites of software projects for new
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
8 releases. It crawls websites efficiently via HTTP or HTTPS using a configurable
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
9 number of simultaneous connections and can parse HTML and XHTML documents as
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
10 well as RSS 2.0 and Atom feeds. Software releases are detected by extracting
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
11 the version numbers of links to distribution files from the parsed documents or
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
12 feeds. In addition to the version numbers, the history of releases consisting
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
13 of the times new release were initially discovered, any encountered errors and
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
14 the time this information was last updated are recorded.
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
15
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
16 The recorded information on each software project can be output in several
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
17 different formats, including formatted text, machine-parseable text, and HTML,
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
18 optionally with the history of releases in Atom feed fromat.
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
19
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
20 Requirements
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
21 ------------
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
22
4
f28486666a4f Add manpages for relmon and relmon_watchlist
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 3
diff changeset
23 relmon requires GNU make, GNU or BSD install, the xsltproc tool from libxml2,
f28486666a4f Add manpages for relmon and relmon_watchlist
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 3
diff changeset
24 Tcl 8.5 or later, tcllib, tls, and tdom. It has been tested on Linux
f28486666a4f Add manpages for relmon and relmon_watchlist
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 3
diff changeset
25 distributions and FreeBSD.
2
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
26
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
27 License
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
28 -------
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
29
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
30 Except otherwise noted, all files are Copyright (C) 2014 Guido Berhoerster and
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
31 distributed under the following license terms:
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
32
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
33 Copyright (C) 2014 Guido Berhoerster <guido+relmon@berhoerster.name>
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
34
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
35 Permission is hereby granted, free of charge, to any person obtaining
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
36 a copy of this software and associated documentation files (the
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
37 "Software"), to deal in the Software without restriction, including
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
38 without limitation the rights to use, copy, modify, merge, publish,
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
39 distribute, sublicense, and/or sell copies of the Software, and to
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
40 permit persons to whom the Software is furnished to do so, subject to
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
41 the following conditions:
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
42
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
43 The above copyright notice and this permission notice shall be included
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
44 in all copies or substantial portions of the Software.
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
45
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
46 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
47 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
48 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
49 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
50 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
51 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
52 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.