code.guido-berhoerster.org Contact

relmon_watchlist(4) Manual Page

Back to relmon

Name

relmon_watchlist — watchlist for software projects monitored by relmon(1)

Synopsis

relmon_watchlist

Description

A relmon_watchlist consists of entries for each monitored software projects which control how relmon crawls websites and detects new releases.

Each line is either an entry or a comment, lines containing only whitespace are ignored. A comment starts with a leading #.

An entry consists of three or more fields which are seperated by whitespace. The first field contains the name of the project which must be unique within the watchlist. The second field contains the base URL which is used as the starting point for crawling and must be a valid URL. Any fields between the second and the last but one field contain advanced regular expressions as described in re_syntax(n) for matching the URLs of links to follow. All patterns are implicitly anchored to the end of the complete URL. The last field is the version-matching regular expression which matches URLs of links to distribution files and must contain exactly one reporting subexpression for extracting the version number.

When updating the version information for a project relmon starts with retrieving the document or feed associated with the base URL. In case there are one or more fields before the last version-matching field, relmon will retrieve all linked documents or feeds whose URLs are matched by the regular expression specified in the first field after the base URL. This process is then repeated, that is documents or feeds linked from the documents or feeds retrieved in the previous step are retrieved if the associated URLs match the regular expression in the subsequent field and so on, until the last version-matching field is reached. Finally, the version-matching regular expression specified in the last field is used to match any URLs of distribution files linked from the documents or feeds retrieved in the previous step and the version numbers are extracted.

Examples

Example 1. An entry for a project which publishes distribution files on its homepage

The following example is an entry for a project named foo which has a homepage at http://example.org/foo/ with direct links to the distribution files, e.g. at http://example.org/foo/foo-1.0.tar.gz:

foo http://example.org/foo/ /foo/foo-([\d.]+)\.tar\.gz

Example 2. An entry for a project which publishes distribution files of new releases through an Atom feed

The following example is an entry for a project named bar which publishes an Atom feed at https://example.com/news.xml which contains links to the distribution files on another host, e.g. at http://archive.example.com/bar-1.0.tar.gz:

bar https://example.com/news.xml /bar-([\d.]+)\.tar\.gz

Example 3. An entry for a project which publishes distribution files on a file hosting website on multiple subpages

The following example is an entry for a project named baz which links to the actual the distribution files, e.g. at http://example.net/projects/baz/1.0/baz-1.0.tar.gz, from several versioned subpages, e.g. at http://example.net/projects/baz/1.0/ and http://example.net/projects/baz/1.1/, which are linked from a common page under the URL http://example.net/projects/baz/:

baz http://example.net/projects/baz/ /baz/[\d.]+/ /baz-([\d.]+)\.tar\.gz

See Also

relmon(1), regex(5), re_syntax(n)