urlwatch 1.5 (+add manpage to MANIFEST.in)
[urlwatch.git] / urlwatch.1
blob79187a25ea43eeb62cf8530c61bac7240ff245aa
1 .TH URLWATCH "1" "November 2008" "urlwatch 1.5" "User Commands"
2 .SH NAME
3 urlwatch \- Watch web pages and arbitrary URLs for changes
4 .SH SYNOPSIS
5 .B urlwatch
6 [\fIoptions\fR]
7 .SH DESCRIPTION
8 urlwatch watches a list of URLs for changes and prints out unified
9 diffs of the changes. You can filter always-changing parts of websites
10 by providing a "hooks.py" script.
11 .SH OPTIONS
12 .TP
13 \fB\-\-version\fR
14 show program's version number and exit
15 .TP
16 \fB\-h\fR, \fB\-\-help\fR
17 show the help message and exit
18 .TP
19 \fB\-v\fR, \fB\-\-verbose\fR
20 Show debug/log output
21 .TP
22 \fB\-\-urls\fR=\fIFILE\fR
23 Read URLs from the specified file
24 .TP
25 \fB\-\-hooks\fR=\fIFILE\fR
26 Use specified file as hooks.py module
27 .TP
28 \fB\-e\fR, \fB\-\-display\-errors\fR
29 Include HTTP errors (404, etc..) in the output
30 .SH "FILES"
31 .TP
32 .B ~/.urlwatch/urls.txt
33 A list of HTTP/FTP URLs to watch (one URL per line)
34 .TP
35 .B ~/.urlwatch/lib/hooks.py
36 A Python module that can be used to filter contents
37 .TP
38 .B ~/.urlwatch/cache/
39 The state of web pages is saved in this folder
40 .SH AUTHOR
41 Thomas Perl <thp@thpinfo.com>
42 .SH WEBSITE
43 http://thpinfo.com/2008/urlwatch/