Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Updated readme, renamed example config
  • Loading branch information
splitbrain committed Jan 2, 2011
1 parent 0fa2d61 commit 87864f4
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 41 deletions.
41 changes: 0 additions & 41 deletions README

This file was deleted.

52 changes: 52 additions & 0 deletions README.md
@@ -0,0 +1,52 @@
# About Watcher

Watcher is a daemon that watches specified files/folders for changes and
fires commands in response to those changes. It is similar to
[incron](http://incron.aiken.cz), however, configuration uses a simpler
to read ini file instead of a plain text file. Unlike incron it can also
recursively monitor directories.

It's written in Python, making it easier to hack.

## Requirements

You need Python 2.7 and the [pyinotify](http://github.com/seb-m/pyinotify)
library.

In Ubuntu (and Debian) you can install these with:

sudo apt-get install python python-pyinotify

## Configuration

See the provided `watcher.ini` file for an example job configuration. The
config file should reside in `/etc/watcher.ini` or `~/.watcher.ini`. You
can also specify the path to the config file as a command line parameter
using the `--config` option.

If you edit the ini file you must restart the daemon for it to reload the
configuration.

## Starting the Daemon

Make sure watcher.py is marked as executable:

chmod +x watcher.py


Start the daemon with:

./watcher.py start

Stop it with:

./watcher.py stop

Restart it with:

./watcher.py restart

If you don't want the daemon to fork to the background, start it with

./watcher.py debug

File renamed without changes.

0 comments on commit 87864f4

Please sign in to comment.