Mercurial > projects > relmon

annotate README @ 8:a886a736c766

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve README file Add build instructions. Add information on bug reporting. Add contact information.
author Guido Berhoerster <guido+relmon@berhoerster.name>
date Fri, 23 Jan 2015 11:05:36 +0100
parents f28486666a4f
children
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
8
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
20 Build Instructions
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
21 ------------------
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
22
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
23 relmon requires Tcl 8.5 or later, tcllib, tls, and tdom and has been tested to
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
24 work on Linux distributions and FreeBSD. The following tools are required to
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
25 build relmon:
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
26
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
27 - GNU make >= 3.81
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
28 - GNU or BSD install
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
29
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
30 Rebuilding the man pages additionally requires the xsltproc tool from libxml2.
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
31
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
32 Before building relmon check the commented macros in the Makefile for any
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
33 macros you may need to override depending on the used tools and operating
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
34 system.
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
35
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
36 By default, all files will be installed under the "/usr/local" directory, a
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
37 different installation path prefix can be set via the `prefix` macro. In
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
38 addition, a second path prefix can be specified via the `DESTDIR` macro which
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
39 will be prepended to any path, incuding the `prefix` macro path prefix. In
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
40 contrast to `prefix`, the path specified via the `DESTDIR` macro will only be
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
41 prepended to paths during installation and not be used for constructing
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
42 internal paths.
2
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
43
8
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
44 The following instructions assume that `make` is GNU make, on some platforms
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
45 it may be installed under a different name or a non-default path. In order to
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
46 start the build process run `make all`. After a successful build, run `make
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
47 install` to install the program, any associated data files and the
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
48 documentation.
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
49
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
50 Previously generated data files and documentation can be removed by running
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
51 `make clean`, any additional, generated files which are not removed by the
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
52 `clean` target can be removed by running `make clobber`.
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
53
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
54 Contact
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
55 -------
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
56
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
57 Please send any feedback, translations or bug reports via email to
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
58 <guido+relmon@berhoerster.name>.
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
59
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
60 Bug Reports
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
61 -----------
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
62
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
63 When sending bug reports, please always mention the exact version of relmon
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
64 with which the issue occurs as well as the version of Tcl and the operating
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
65 system you are using and make sure that you provide sufficient information to
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
66 reproduce the issue and include any input, output, any error messages.
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
67
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
68 In case of build issues, please also specify the implementations and versions
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
69 of the used tools.
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
70
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
71 In case of crashes, please include the stack trace that was generated by the
a886a736c766 Improve README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents: 4
diff changeset
72 Tcl interpreter in the bug report.
2
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
73
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
74 License
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
75 -------
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
76
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
77 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
78 distributed under the following license terms:
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
79
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
80 Copyright (C) 2014 Guido Berhoerster <guido+relmon@berhoerster.name>
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
81
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
82 Permission is hereby granted, free of charge, to any person obtaining
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
83 a copy of this software and associated documentation files (the
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
84 "Software"), to deal in the Software without restriction, including
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
85 without limitation the rights to use, copy, modify, merge, publish,
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
86 distribute, sublicense, and/or sell copies of the Software, and to
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
87 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
88 the following conditions:
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
89
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
90 The above copyright notice and this permission notice shall be included
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
91 in all copies or substantial portions of the Software.
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
92
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
93 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
94 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
95 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
96 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
97 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
0203fffb4d74 Add README file
Guido Berhoerster <guido+relmon@berhoerster.name>
parents:
diff changeset
98 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
99 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.