urlwatch 1.5 (ical2txt, utidylib, documentation)
[urlwatch.git] / README
blob294326fd1acd3afa85bd15dc4f20f41633cf57fd
3        -===============================-
4         urlwatch - A Simple URL Watcher
5        -===============================-
8 ~~ aBOUT ~~
10 This is a simple URL watcher, designed to send
11 you diffs of webpages as they change. Ideal for
12 watching web pages of university courses, so 
13 you always know when something has changed :)
16 ~~ fAQ ~~
18 Q: Where do I configure URLs?
19 A: Edit the file urls.txt.
21 Q: A page changes some content on every reload. 
22    How do I prevent urlwatch from always 
23    displaying these changes?
24 A: Edit the file hooks.py and add a handler for
25    the specific URL and strip the changing
26    parts. See hooks.py for more information.
28 Q: How do I use it as a cron job?
29 A: Simply add watch.py to your crontab. Make
30    sure the stdout of your cronjobs is mailed
31    to you, so you get the notifications.
33 Q: Is there an easy way to show changes of .ics files?
34 A: Indeed there is. See hooks.py and ical2txt.py
36 Q: What about badly-formed HTML (long lines, etc..)?
37 A: Use python-utidylib. See hooks.py for an example
39 ~~ cONTACT ~~
41 Website: http://thpinfo.com/2008/urlwatch
42 Contact: thp [thpinfo.com/about]
43 Jabber: thp [at jabber.org]