README

   1 URLWATCH README
   2 ===============
   3
   4 ABOUT
   5 -----
   6
   7 This is a simple URL watcher, designed to send you diffs of webpages as they
   8 change. Ideal for watching web pages of university courses, so you always
   9 know when lecture dates have changed or new tasks are online :)
  10
  11
  12 QUICK START
  13 -----------
  14
  15 1. Start "urlwatch"
  16 2. Edit and rename the examples in ~/.urlwatch/
  17 3. Add "urlwatch" to your crontab (crontab -e)
  18 4. Receive change notifications via e-mail
  19 5. Customize your hooks in ~/.urlwatch/lib/
  20
  21
  22 FREQUENTLY ASKED QUESTIONS
  23 --------------------------
  24
  25 Q: How do I add/remove URLs?
  26 A: Edit ~/.urlwatch/urls.txt
  27
  28 Q: A page changes some content on every reload. How do I prevent urlwatch
  29    from always displaying these changes?
  30 A: Edit ~/.urlwatch/lib/hooks.py and implement your filters there. Examples
  31    are included in the urlwatch source distribution.
  32
  33 Q: How do I configure urlwatch as a cron job?
  34 A: Use "crontab -e" to add the command "urlwatch" to your crontab. Make sure
  35    stdout of your cronjobs is mailed to you, so you also get the notifications.
  36
  37 Q: Is there an easy way to show changes of .ics files?
  38 A: Indeed there is. See the example hooks.py file.
  39
  40 Q: What about badly-formed HTML (long lines, etc..)?
  41 A: Use python-utidylib. See the example hooks.py file.
  42
  43 Q: Is there a way to make the output more human-readable?
  44 Q: Is there a way to turn it into a diff of parsed HTML perhaps?
  45 A: Of course. See the example hooks.py file -> use html2txt.html2text(data)
  46
  47 Q: Why do I get an error with URLs with spaces in them?
  48 A: Please make sure to URL-encode the URLs properly. Use %20 for spaces.
  49
  50 Q: The website I want to watch requires a POST request. How do I send one?
  51 A: Add the POST data in the same line, separated by a single space. The format
  52    in urls.txt is: http://example.org/script.cgi value=5&q=search&button=Go
  53
  54
  55 CONTACT
  56 -------
  57
  58 Website: http://thp.io/2008/urlwatch/
  59 E-Mail: m@thp.io
  60 Jabber/XMPP: thp@jabber.org
  61